Commit Graph
32 Commits
Author SHA1 Message Date
fhoekstraandSantosh Pillai a32f6f8ba6 docs: add partition label containing "ceph" to ceph-common-issues.md
Co-authored-by: Santosh Pillai  <sapillai@redhat.com>
Signed-off-by: Freek <dev@freekhoekstra.nl>
2026-02-03 11:36:31 +01:00
Bryan J. e56dda36c2 docs: unsupported kubectl exec params
Signed-off-by: Bryan Jones <unix.chkpwd@gmail.com>
2025-03-05 09:08:50 -05:00
Madhu Rajanna 1d1ed5e962 csi: disable fencing in Rook
Disabling the RBD and CephFS fencing
in Rook for now as its having bugs where
Rook is blocklisting wrong IP address
due to timing issues.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-10-10 19:28:15 +02:00
nicofnt 0952e36ba1 docs: add new topic in troubleshooting guide for the LimitNOFILE issue
Create new topic in the troubleshooting guide to explain how to fix a new rook-ceph deployment that could remain in an unhealthy state or fails to config because of the LimitNOFILE value specified in the containerd.service configuration.

Signed-off-by: Nicola Fantacuzzi <nfantacuzzi@gmail.com>
2024-07-26 10:43:57 +02:00
Blaine Gardner c9d99e01a0 ci: use markdownlint to enforce mkdocs compatibility
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>
2024-04-29 17:25:11 -06:00
travisn 806608cdbc pool: allow setting the application on a pool
Rook has been setting the application automatically on all
pools to rbd for CephBlockPools, rook-ceph-rgw for
CephObjectStores, mgr on the built-in .mgr pool,
and nfs on the built-in .nfs pool.

The legacy pool device_health_metrics is long gone
from Pacific which is no longer supported, so we can
remove special handling for that pool in the upgrade
guide and in the code.

The application setting is now available on the pool spec
although it is not expected to commonly need to override
the default applications set by Rook.

The application for CephFilesystem pools is now being
set to cephfs, where it was previously blank.

Signed-off-by: travisn <tnielsen@redhat.com>
2024-02-14 16:53:25 -07:00
subhamkrai 28cc1ebc55 core: remove webhook & controller-runtime from apis
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>
2023-12-01 14:15:40 +05:30
Mateus Valgueiro 85401f87ea docs: add namespace on delete webhook command
The only command on the page that did not have a namespace directly set was this one.

Signed-off-by: Mateus Valgueiro <mateusvalgueiro@gmail.com>
2023-10-30 17:31:44 -03:00
jxlwqq 67759f0fea docs: fix install command
Signed-off-by: jxlwqq <jxlwqq@gmail.com>
2023-10-20 16:25:50 +08:00
subhamkrai 47c0038136 docs: krew is wrong word use kubectl instead
krew is itself a plugin and it is wrong wording
to use krew plugin intead it should be kubectl
pluging.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-09-27 20:26:14 +05:30
subhamkrai 39b5c057ce core: faster recovery from rbd rwo node loss
in the existing node watcher, we'll check for node update
event and see if there are `out-of-service` taints are applied
and `ROOK_WATCH_FOR_NODE_FAILURE` is enabled in rook-ceph-operator-configmap,
if then we'll create the networkFence cr and delete the cr if nodes come back.
And, added the unit test too.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-07-07 21:16:25 +05:30
Ben Gao 19cb58bf5e docs: an update to disaster recovery with new scenario
add recovering steps when rook crs and ceph daemons are all deleted.

Signed-off-by: Ben Gao <bengao168@msn.com>
2023-04-07 22:05:00 +08:00
Travis Nielsen 6b6252e474 docs: clarify csi already exists error in docs
The already exists error message is perhaps the most common
issue with the csi driver. The csi troubleshooting guide
is now clarified to make that error message easier
to find.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-11-15 12:13:45 -07:00
Travis Nielsen 64300f1ba5 Merge pull request #11256 from subhamkrai/update-disator-recov-doc
docs: update disaster recovery guide for webhook
2022-11-03 08:05:45 -06:00
gauravsitlani 3ead8218d9 docs: added steps to collect coredump and perf troubleshooting info
Signed-off-by: gauravsitlani <gauravsitlani@riseup.net>
2022-11-02 21:13:55 +05:30
subhamkrai 0dbfc66498 docs: update disaster recovery guide for webhook
Since we moved to cert-manager for the webhook long time back, we
just need to disable webhook instead of backing the whole webhook.
And, after crs are restored we need to enable the webhook and all the
resources will be created itself by the operator.

Signed-off-by: subhamkrai <srai@redhat.com>
2022-11-02 20:55:40 +05:30
Travis Nielsen aa916915d2 Merge pull request #11154 from alexander-bauer/docs-restoring-crds-after-deletion
Docs: Improve troubleshooting docs on restoring CRDs after deletion
2022-10-21 08:13:33 -06:00
Travis Nielsen 3e60b95fd6 docs: use krew restore-quorum command for disaster scenario
The new krew plugin command restore-quorum will automate the process
to restore quorum from a single healthy mon. No longer do we need
the absolutely tedious, messy, manual steps from the rook docs.
The krew plugin will take care of all the complexity automatically
as of the v0.4.0 release

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-10-20 08:36:24 -06:00
Alexander Bauer 825e956849 docs: add scripts, details, and new steps to CRD restoration guide
Signed-off-by: Alexander Bauer <sasha@linux.com>
2022-10-19 23:56:42 +00:00
Alexander Bauer dc13595670 docs: add warning about CR naming in CRD restoration page
Signed-off-by: Alexander Bauer <sasha@linux.com>
2022-10-19 23:56:42 +00:00
Alexander Bauer d7731bdf7c docs: repair list numbering in Restoring CRDs after Deletion
This commit adjusts spacing in the Docs -> Troubleshooting -> Disaster
Recovery -> Restoring CRDs after Deletion sources to repair
list-numbering-mangling. The section is altered to use spacing
suggestions from:
  https://squidfunk.github.io/mkdocs-material/reference/lists/

Signed-off-by: Alexander Bauer <sasha@linux.com>
2022-10-16 02:57:03 +00:00
parth-gr f59374b7a8 docs: add debug mode steps to troubleshooting docs
Debug mode spport is added in the krew plugin
So adding it in the docs so user can use it

Closes: https://github.com/rook/rook/issues/5709
Signed-off-by: parth-gr <paarora@redhat.com>
2022-08-25 00:07:15 +05:30
parth-gr 13f916df7d docs: add krew plugin to the troubleshooting docs
It's been a while we have the krew plugin capability for
troubleshooting that makes it easier but not added to rook
docs.
So adding it to rook docs and bug template

Closes: https://github.com/rook/rook/issues/10765
Signed-off-by: parth-gr <paarora@redhat.com>
2022-08-23 21:31:50 +05:30
Alexander Trost 59bee3e841 Merge pull request #10456 from koor-tech/docs_tweaks 2022-08-11 18:52:54 +02:00
Alexander Trost fe2000e6d8 docs: rename Rook-Ceph to Rook Ceph
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-08-11 14:58:57 +02:00
Mudit Agarwal 40081cbcd2 Revert "csi: remove attacher sidecar from CephFS rook deployment"
This reverts commit 4bfd88dc4d.

Signed-off-by: Mudit Agarwal <muagarwa@redhat.com>
2022-08-10 13:04:14 +05:30
yati1998 4bfd88dc4d csi: remove attacher sidecar from CephFS rook deployment
CephFS CSI driver dont have/advertise controller publish/unpublish
capabilities, thus dont need attacher sidecar for its operations.
The presence of external-attacher adds on overhead and issues wrt
attachment in various scenarios. One of them would be the lack of
performance on syncing volumeattachment from api server..etc.
More or less we don't have controller publish and unpublish capabilities,
so we should not make use of this sidecar and cause
unnecessary addon here thus other issues.

similar changes have been added to CSI
https://github.com/ceph/ceph-csi/pull/3149

Signed-off-by: yati1998 <ypadia@redhat.com>
2022-08-03 19:56:39 +05:30
Josh Soref 6e7b8767f3 core: fix spelling
* another
* are
* availability
* available
* bootstrap
* boundaries
* ceph
* certificate
* class
* codifies
* consuming
* corrupted
* createor
* csi
* deployments
* exceeded
* execute
* filesystem
* healthiness
* heuristics
* immediately
* insecure
* installed
* isolated
* maintained
* maximum
* minute
* monitor
* new
* nginx
* nonexistent
* not
* occurs
* omitempty
* operator
* orchestration
* persistentvolumes
* placement
* preexisting
* prometheus
* protecting
* provisioner
* purposes
* reconcile
* regex
* related
* requests
* returns
* rubbish
* running
* schedulable
* schedule
* serviceaccount
* simulating
* snapshots
* statement
* static
* tenants
* the
* unavailable
* volumeattachment
* waiting
* with
* wrapper
* zonegroup

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-07-07 18:10:47 -04:00
Travis Nielsen dad97f3425 core: remove support for ceph octopus
With octopus coming to end of life, we remove support from
Rook for deploying Ceph Octopus and assume a min version of
Pacific v16. Any checks for octopus or earlier are removed
from the reconciles since they are obsolete.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-07-07 15:03:26 -06:00
Travis Nielsen 34ca5d661b docs: refactor cluster crd doc for subtopics
The cluster CR doc is extremely long and in need of refactoring.
Now we have four new sub-topics for a host-based cluster,
PVC-based cluster, stretch cluster, and an external cluster.
Each of those topics has its own description and examples.
The main cluster CR topic still contains the details about
all the possible cluster CR settings.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-06-27 17:04:54 -06:00
subhamkrai 49a35a9311 docs: update doc path according to new doc change
we need to update the referred doc path
according to our latest doc change.

Signed-off-by: subhamkrai <srai@redhat.com>
2022-06-01 20:17:44 +05:30
Alexander Trost 74431443e3 docs: use mkdocs and restructure docs
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2022-05-18 16:06:22 +02:00