Commit Graph
51 Commits
Author SHA1 Message Date
Viraj Jadhav 659d574633 doc: typo for imagePullSecrets
Signed-off-by: Viraj Jadhav <vjadhav7@slb.com>
2025-02-22 18:25:51 +05:30
Travis Nielsen 7c2f41e72e build: add support for k8s 1.32
With the release of K8s 1.32, we update the CI and docs
to support this new release, to maintain the most recent
six releases of K8s.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-12-12 09:48:42 -07:00
subhamkrai 72885c7927 ci: upgrade k8s min version to 1.27
since k8s 1.32 is coming out soon and we
want to support the latest six k8s versions so,
let's upgrade the min k8s version to 1.27 for rook 1.16.

Signed-off-by: subhamkrai <srai@redhat.com>
2024-11-26 21:01:46 +05:30
Travis Nielsen e157bb5a56 core: support k8s versions 1.26 through 1.31
With the release of K8s v1.31.0, we update the minimum
supported version to v1.26, and add v1.31 to the CI
so we can test the most recent six versions of K8s.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2024-08-13 16:54:52 -06:00
parth-gr 2ca0d1390b csi: add securityContext to csi containers
With the recent enhancements csi containers for using
logrotate, they need to run with securityContext to privileged,
on platform like openshift.
Used the ROOK_HOSTPATH_REQUIRES_PRIVILEGED flag
wich is set with operator deployment to see
if the securityCOntext is needed or not

Closes: https://github.com/rook/rook/issues/14400

Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-07-08 18:47:26 +05:30
Onur C. Cakmak d1e139cdb3 docs: add a note for NixOS and containerd
Add a note to remove LimitNOFILE setting in containerd service configuration.

This setting causes multiple issues such as slow `ceph status` commands (and failing healthchecks),
various timeouts, and mons failing/timing out.

Upstream containerd already removed the setting. NixOS hasn't incorporated the change.

This note can be removed once https://github.com/NixOS/nixpkgs/pull/313507 makes it to a stable release.

Signed-off-by: Onur Cakmak <occ@occ.me>
2024-05-27 22:42:49 -04: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
smoshiur1237 dab17f72a1 external: restructure external cluster examples manifests
This PR will add separate directory to handle the external manifest. Here external manifests will have same namespace (rook-ceph) for external cluster.

Signed-off-by: smoshiur1237 <moshiur.rahman@est.tech>
2024-04-26 14:54:59 +03:00
subhamkrai 128ec16ee6 ci: add k8s 1.30 support in ci
adding support for kubernetes 1.30 in ci which released yesterday.

Signed-off-by: subhamkrai <srai@redhat.com>
2024-04-19 07:41:05 +05:30
parth-gr 0aa431c7e1 external: add ci and design documet
Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-03-18 22:17:25 +05:30
Travis Nielsen 4817a0442c Merge pull request #13896 from parth-gr/k8s-1.25
ci: upgrade min k8s supported version to 1.25 combiner
2024-03-07 10:29:36 -07:00
parth-gr ed6fb58bd1 ci: upgrade min k8s supported version to 1.25 combiner
upgrading minimum kubernetes supported version to v1.25.16
and max to k8s 1.29.2

Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-03-07 21:59:04 +05:30
karthik-us 6867adaf29 Revert "doc: fix broken links"
This reverts commit ebc812c4ed.

Signed-off-by: karthik-us <ksubrahm@redhat.com>
2024-03-06 23:17:45 +05:30
karthik-us ebc812c4ed doc: fix broken links
This patch fixes the broken links in the non rendered documents
on github and keeps the structre of the rendered documents on
the website intact as well.

Signed-off-by: karthik-us <ksubrahm@redhat.com>
2024-03-01 19:44:15 +05:30
parth-gr f7a9d8ff7b core: added rook-ceph-default service account
When a private docker registry is used and an
image pull secret is specified in the chart,
the pods with default Service Account fail to pull
the image due to authentication issues.
Added rook-ceph-default service account and modify the pods
specifications by adding the serviceAccountName

closes: https://github.com/rook/rook/issues/12786

Closes: https://github.com/rook/rook/issues/6673
Co-authored-by: Tareq Sharafy <tareq.sha@gmail.com>
Signed-off-by: parth-gr <partharora1010@gmail.com>
(cherry picked from commit 737fb099fe)
Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-02-28 13:32:55 +05:30
subhamkrai 135307a4df ci: upgrade min k8s supported version to 1.24.17
upgrading minimum kubernetes supported version to v1.24.17
and also upgrading other kubernetes version to their latest
respective version.

Signed-off-by: subhamkrai <srai@redhat.com>
2024-02-13 22:11:44 +05:30
parth-gr bad4e972ee docs: clarify the k8s versioning in the doc
we need to clarify what all version we do support

Signed-off-by: parth-gr <partharora1010@gmail.com>
2024-01-30 23:03:58 +05:30
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
Satoru Takeuchi b2116d945d Merge pull request #12166 from cybozu-go/doc-add-table-to-know-supported-osd-configuration
doc: add the table to know supported osd configuration
2023-10-26 05:15:32 +09:00
Satoru Takeuchi bab6e01d37 doc: add the table to know supported osd configuration
It's convenient to visualize the supported OSD configurations.
In addition, remove the reference to the common issue section
about OSD on LV-backed PVC because this issue doesn't happen anymore
for new OSDs.

Closes: https://github.com/rook/rook/issues/10859

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2023-10-25 20:10:35 +00:00
sp98 8854497d00 doc: update lvm prerequisites
lvm packages should be required if `osdPerDevice` is set
to greater than 1.

Signed-off-by: sp98 <sapillai@redhat.com>
2023-10-25 12:02:45 +05:30
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
parth-gr 62e3ffb2ba helm: install rook in openshift cluster
The sccs were missing in the helm installation,
added it

Closes: https://github.com/rook/rook/issues/12280

Signed-off-by: parth-gr <paarora@redhat.com>
2023-08-16 14:43:36 +05:30
Sheetal Pamecha eee31f2b72 ci: update the minimum kubernetes version supported
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>
2023-06-25 22:01:40 +05:30
Alexander Trost 75dbc7d7fb docs: update storage architecture diagram
This includes the source code of the diagram, created using draw.io, so
anyone can easily update it.

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2023-06-20 23:32:50 +02:00
travisn ecdeb7aa9f docs: clarify docs for wording or obsolete info
Update the getting started guide, prereqs, architecture,
and other basic docs with more concise wording and removed
some obsolete information. Some links are removed so they
don't distract the user from reading the critical information
that we are conveying in the rook docs.

Signed-off-by: travisn <tnielsen@redhat.com>
2023-04-27 11:58:08 -06:00
Travis Nielsen 11e80b7047 Merge pull request #11436 from subhamkrai/bump-ci-k8s-version
ci: Update min K8s support to 1.21 and add 1.26 support
2023-02-14 20:26:56 -07:00
subhamkrai 1effb11a0a ci: bump min and max k8s support
this commit bump minmum k8s version to 1.21.14 and
max k8s version to latest 1.26.0. Keeping support for
most recent 6 versions.

Signed-off-by: subhamkrai <srai@redhat.com>
2023-02-15 07:08:02 +05:30
Travis Nielsen eb4a727658 docs: remove mention of psps from documentation
The PSPs have long since been deprected. In K8s 1.21 the PSPs
were first deprecated, and support was completely removed
for them in 1.25. With Rook v1.11, the min supported version of
K8s is now 1.21. To reduce confusion in the documentation,
mention of the PSPs is now removed from the 1.11 docs.
For the corner case that users still require the PSPs,
the helm chart still contains the option for creating PSPs
or other users can still create the psp.yaml.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2023-02-13 13:30:32 -07:00
gauravsitlani 71c5969758 docs: add glossary page
Signed-off-by: gauravsitlani <gauravsitlani@riseup.net>
2023-02-08 20:20:28 +05:30
Travis Nielsen 01d71c41ea Merge pull request #10652 from anthonyeleven/anthonyeleven/update-RBD-image-features
docs: add additional RBD image features to docs and YAML files
2022-11-10 11:09:21 -07:00
Jairo Llopis e0ad2f9789 helm: bugs following docs for NixOS deployment
85b079105b introduced some bugs that here I'm fixing.

1. Docs missing `csi.` prefix.
2. Chart was using `cis.csiRBDPluginVolumes` instead of `csi.csiCephFSPluginVolume`.
3. Values had to be a scalar value, not a raw string. Otherwise, the operator can't parse it.
4. Link to `/run/booted-system` instead of `/run/current-system`. In the former, the kernel modules will always match the current kernel; in the latter, it could happen that after a new `nixos-rebuild switch`, plugin containers can't find the kernel modules for the booted kernel version.
5. Values included in the `values.yaml` template were plural. These are not supported, they must all be singular.

About that 3rd point, this was the error being logged:

```
2022-11-04 09:54:47.489851 I | op-k8sutil: CSI_RBD_PLUGIN_VOLUME="|\n - name: lib-modules\n hostPath:\n path: /run/current-system/kernel-modules/lib/modules/\n - name: host-nix\n hostPath:\n path: /nix" (configmap)
2022-11-04 09:54:47.489907 W | ceph-csi: failed to parse "|\n - name: lib-modules\n hostPath:\n path: /run/current-system/kernel-modules/lib/modules/\n - name: host-nix\n hostPath:\n path: /nix" for "CSI_RBD_PLUGIN_VOLUME". json: cannot unmarshal string into Go value of type []v1.Volume
2022-11-04 09:54:47.489916 I | op-k8sutil: CSI_RBD_PLUGIN_VOLUME_MOUNT="|\n - name: host-nix\n mountPath: /nix\n readOnly: true" (configmap)
2022-11-04 09:54:47.489937 W | ceph-csi: failed to parse "|\n - name: host-nix\n mountPath: /nix\n readOnly: true" for "CSI_RBD_PLUGIN_VOLUME_MOUNT". json: cannot unmarshal string into Go value of type []v1.VolumeMount
```

@moduon MT-1503

Signed-off-by: Jairo Llopis <yajo.sk8@gmail.com>
2022-11-04 13:24:31 +00:00
Anthony D'Atri 10b398cc02 docs: add additional RBD image features to docs and YAML files
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-10-27 10:57:50 -06:00
Travis Nielsen fc035c7a5b docs: document expectations for releases
The release schedule and maintenance approach has been
left as undefined until now to give flexibility to the
maintainers to release as needed. The community is
asking for clarity around the planned release schedule
so it is time to document the procedures.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-10-10 14:32:26 -06:00
Travis Nielsen 9e89c8e06e Merge pull request #11029 from moduon/docs-nixos
docs: explain specific nixos configurations
2022-10-04 07:28:09 -06:00
Jairo Llopis 7fecca3d6f docs: explain specific nixos configurations
Explain the fix for https://github.com/rook/rook/issues/10932 to let NixOS users set up Rook more easily.

Signed-off-by: Jairo Llopis <jairo@moduon.team>
2022-10-04 07:27:43 +01:00
Travis Nielsen 3484eb7520 docs: symlink cleanup page to the getting started doc folder
The cleanup guide is difficult to find under the storage configuration section
with so many other topics. We will show the cleanup guide also from the getting
started section to make it more discoverable.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-09-28 15:05:07 -06:00
Satoru Takeuchi b52e6a0da8 docs: add logical volume to storage options
Rook supports osd on logical volume in host-based clusters. Let's add it
to the list of valid device types.

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2022-09-15 11:31:20 +00:00
Travis Nielsen d5f100def1 docs: clarify storage prereqs in quickstart guide
The quickstart guide prerequisites have diverged from the storage
requirements on the prereqs doc page, now they are in sync again.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-09-09 15:23:58 -06:00
Travis Nielsen a6dfb77827 build: update min version to k8s 1.19
Rook will support the most recent seven K8s releases,
so we update the min version to 1.19 for Rook v1.10.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-08-30 15:15:20 -06:00
Blaine Gardner 1e9bbae583 docs: move PSPs from common.yaml to psp.yaml
Also update docs. Use `make gen-rbac` to generate psp.yaml.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2022-08-25 16:39:52 -06: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
Travis Nielsen 6eda2654a6 Merge pull request #10581 from chienfuchen32/patch-2
docs: update Example Configurations document
2022-07-25 13:12:03 -06:00
chienfuchen32 5ddca98460 docs: update Example Configurations Docs
Some link fixing in Example Configurations
Ref: https://rook.io/docs/rook/v1.9/Storage-Configuration/Block-Storage-RBD/rbd-mirroring/
     https://rook.io/docs/rook/v1.9/Getting-Started/example-configurations/#block-devices

Signed-off-by: chienfuchen32 <chienfuchen32@gmail.com>
2022-07-19 12:43:38 +08:00
Travis Nielsen 9ea37be45f docs: add telemetry section to quickstart guide
To start collecting telemetry on upstream clusters,
we add a new section to the quickstart guide that
requests users to enable the telemetry.

Signed-off-by: Travis Nielsen <tnielsen@redhat.com>
2022-07-15 10:12:15 -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
Satoru Takeuchi 6b0f539f61 test: add canary test for encrypted osd in host-based clusters
It's better to test the creation of encrypted devices in host-based clusters.
This test will reduce the potential risks of regression when modifying
the osd-creation code.

Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
2022-06-08 22:34:01 +00: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
Gaurav Sitlani 84c53d1444 docs: added cpu requirements
Signed-off-by: Gaurav Sitlani <gaurav@koor.tech>
2022-05-24 12:02:38 +05:30