mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.
As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.
markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:
- all doc lines (except code blocks) must be aligned to a 4-space
boundary, without exception. This ensures that markdown will render
correctly with mkdocs. This unfortunately makes it possible to create
lists that are internally aligned strangely.
- admonitions must all follow the same format of
```
!!! header
body
```
For the strange lists, this is allowed and renders correctly, but it
looks strange:
```md
- first bullet
- second bullet
still second bullet
- third bullet
has a paragraph
of text inside
- last bullet
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
(cherry picked from commit c9d99e01a0)
The network providers doc, including the holder pod migration sections,
were developed with the understanding that CSI could be placed into pod
networking mode if desired by users. In reality, this hasn't been
supported due to bugs.
This allows streamlining the holder pod migration sections to no longer
need to document for users what to do if they use CSI in pod network
mode.
Rook will continue to have the `CSI_ENABLE_HOST_NETWORK` config
available as an undocumented value. This can allow users who desperately
cannot use host networking to still use pod networking, though this will
mean any CSI node plugin updates could stall mounts for running apps.
Thus we do not support it.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
(cherry picked from commit 519c7e8911)
The csi images in the operator helm chart previously were a single
image name including the repository and tag in a single string.
Now the repository and tag values are separated to allow for
greater customization of the repository from the version tags.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
(cherry picked from commit 64f71d9258)
Add new CSI_DISABLE_HOLDER_PODS option for rook-ceph-operator.
This option will disable holder pods when set to "true".
In the long term, Rook plans to deprecate the holder pods entirely.
This new option will allow users to choose to migrate their clusters to
non-holder clusters when they are ready and able, giving them time to
gracefully migrate before the holders are permanently removed.
This option is set to "false" by default so that upgrading users don't
have their CSI pods modified unexpectedly.
Example manifests are modified to set this value to true so that new
clusters will not deploy holder pods.
Migrating users are provided with documentation to instruct them about
the new requirements they need to satisfy to successfully remove holder
pods, a procedure for migrating pods from holder to non-holder mounts,
and a way to delete holder pods once they are no longer in use.
When users set CSI_DISABLE_HOLDER_PODS="true", the CSI controller will
no longer deploy or update the holder pod Daemonsets, but it does not
delete any existing Daemonsets. This allows already-attached PVCs to
continue operating normally with their network connection continuing to
exist in the current holder pod. This is critical to avoid causing
ia cluster-wide storage outage.
More info: https://github.com/rook/rook/issues/13055
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
Today, it's unclear that there is an expected order of operation when it
comes up upgrades. In reality, the `rook-ceph` helm chart includes the
operator, which should have the opportunity to update any custom
resources before the `rook-ceph-cluster` is upgraded.
Signed-off-by: Kyle Fazzari <kyrofa@ubuntu.com>
Update docs for the upcoming v1.13 release.
Ensure that the pending release doc has critical notes.
Ensure upgrade guide versions are updated and tested.
Clarify some minor documentation points regarding features present in pending release doc.
Special care has been taken to update notes and docs for removal of the admission controller, which may be confusing for the estimated-small number of acive users.
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
This commits removes controller-runtime dependencies
from the apis dir and to achieve that we are removing
webhook.
Signed-off-by: subhamkrai <srai@redhat.com>
CephCSI CephFS introduced a breaking change in v3.9.0.
This commit adds a note in upgrade guide regarding the same.
refer: https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/ \
ceph-csi-upgrade.md/#upgrading-cephfs
Signed-off-by: Rakshith R <rar@redhat.com>
Following with the latest efforts to improve Rook docs, convert the Rook
and Ceph upgrade docs to use imperative language and avoid use of "you".
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
For v1.12 update the minimum K8s version supported to v1.22,
and run CI against the most recent six versions.
Signed-off-by: Sheetal Pamecha <spamecha@redhat.com>
Pare down the available volume sources for NFS config files so that the
CRD isn't unnecessarily huge. This allows us to recommend
`kubectl apply` again in the upgrade doc.
Size of the NFS CRD is reduced by approximately 60%.
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
'kubectl apply --server-side' still doesn't always update CRDs
correctly if a CRD is too big to have its last applied annotation. Use
'kubectl replace' instead.
Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
The helm chart is blocked from upgrading to newer versions of Rook
if v1.9.10 is not installed before upgrading to K8s 1.25. The
helm chart is confused by the PSPs that still exist in the installed
chart and fails to upgrade to the new chart.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
With the beta release of v1.10 the release version in the examples
and docs is updated.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
(cherry picked from commit bbbd709af9)
The ceph upgrade guide is factored out into a separate document
to help simplify the flow and make the different types of
upgrades more easily discoverable.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Deploying a custom CSI image is more of a standalone topic
under the CSI configuration docs. There is no need for the
upgrade guide to have the details about CSI images.
Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
Travis Nielsen
Blaine Gardner
Kyle Fazzari
subhamkrai
Rakshith R
Blaine Gardner
Sheetal Pamecha
parth-grandBlaine Gardner
Madhu Rajanna
Alexander Trost
Markus Schmidleitner