Long CRD descriptions were pushing the size of the CRDs manifest
over 1MB, which causes issues when creating the CRDs. To shorten
the manifest, the descriptions are now limited to 100 chars.
This still gives some ability for dev tools to show a brief
description if needed. The generated CRD docs still contain
the full descriptions for reference.
Signed-off-by: travisn <tnielsen@redhat.com>
Update the release doc to include the latest process used to create the
new 1.13 release branch.
Make a few minor changes to the patch update process to keep formatting
the same between new-release-branch and new-patch processes.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
To keep the go dependencies minimal, add the go packages
just for the pkg/apis directory. Projects that only reference
the rook apis can then have a smaller footprint for Go
dependencies.
Signed-off-by: travisn <tnielsen@redhat.com>
mac build ci is failing during csv gen
when trying to move files to some folder.
Skipping csv gen for mac since it is not required.
Signed-off-by: subhamkrai <srai@redhat.com>
migrate to using mkdocs-material's material.extensions.emoji.twemoji
and material.extensions.emoji.to_svg in place of the respective
materialx.emoji.twemoji and materialx.emoji.to_svg. Also, this requires
latest version of mkdocs-material.
Signed-off-by: subhamkrai <srai@redhat.com>
In the past we had few cases where the new crd
was missed adding in metadata-common.yaml file.
So, now we'll check if crds.yaml and metadata-common.yaml
crd name are matching.
Signed-off-by: subhamkrai <srai@redhat.com>
Signed-off-by: Michael Adam <obnox@samba.org>
this change introduces a new 'make target 'docs'that generates part of the documentation
It particular, it runs the `helm-docs` target.
Additionally, `make docs` updates the multus validation job manifest
by inserting the output of `rook multus validation run --help` between
two newly introduced markers.
The result of running `make docs` is intended to be committed to git after running
Fixes: #12706
Signed-off-by: Michael Adam <obnox@samba.org>
Signed-off-by: Blaine Gardner <b.blaine.gardner@gmail.com>
Co-authored-by: Blaine Gardner <b.blaine.gardner@gmail.com>
Co-authored-by: Michael Adam <obnox@samba.org>
Update build/deploy/generate-deploy-examples.sh
Signed-off-by: Michael Adam <obnox@samba.org>
The go package dependencies (go.mod and go.sum) were created
under the pkg/apis directory to simplify the dependencies for
other projects referencing the rook repo. The downside is that
the dependabot can no longer open a working and valid PR since
the bot is not aware of the go.mod and go.sum in the apis directory.
Since the reduction of dependencies for vault in #12455,
the list of extra dependencies is not quite so extensive.
We are putting effort into shrinking the dependency list instead
of using the modules files in the apis subdirectory.
Note that #12419 updated the dependencies for the latest controller
runtime which also increased the size of the modules
list in the pkgs subdirectory, which means the difference
in dependencies in the pkgs subdirectory is no longer
signficant anyway.
Signed-off-by: travisn <tnielsen@redhat.com>
Currently, if there is any change in the API we need to separately
run the make generate-crd-docs but with this change
make crds will also update the generated docs
Also improved the file locations
Closes: https://github.com/rook/rook/issues/12310
Signed-off-by: parth-gr <paarora@redhat.com>
removing the line added by gen-crd-api-reference-docs to avoid commit
specification.md with only the reference to the git commit
Signed-off-by: Javier <sjavierlopez@gmail.com>
This helps forks build custom rook releases more easily by allowing
certain Makefile vars to be overwriten using a `.env` file.
In addition this introduces the `DOCKERCMD` var to the
`build/release/Makefile`.
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
Signed-off-by: Deepika Upadhyay <deepika@koor.tech>
Signed-off-by: Zuhair AlSader <zuhair@koor.tech>
temporarily skipping other platforms to fix the build since we are working on bigger changes to remove csv generation.
Signed-off-by: subhamkrai <srai@redhat.com>
The crds generation for the helm crds is intermittently hitting a build
error due to multiple builds generating the crds at the same time.
We avoid this race condition by first writing the crds to a temp file
then move the file to the helm crd resources file.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
The rbac generation prints a lot of info that is not necessary
unless troubleshooting the rbac build, so we can comment it
out by default.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
With the v1.10.0 release out, the latest-release docs need
to point to the 1.10 release. With each release we will
update to the next release branch when we have shipped.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Due to an oversight, PSP resources were left in generation of
common.yaml from #10797. Resolve that by setting
pspEnable=false when generating common.yaml.
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
build/rbac/rbac.yaml should have been removed when we started generating
common.yaml, but it was missed.
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
Right now te Documentation/README.md file is read and rendered but due
its location reports broken links as we link it into the
Documentation/Getting-Started/intro.md.
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
This adds two new make target for building and previewing the current
state of the documentation locally.
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
travisn
subhamkrai
Blaine Gardner
Alexander Trost
Michael AdamandBlaine Gardner
parth-gr
Javier
s3rj1k
Khris Richardson
Zuhair
Deepika Upadhyay
yati1998