Update README.md #40
Update README.md #40
Conversation
WalkthroughThe update transitions the deployment process of the Ceph S3 Operator from a Makefile-based approach to one that primarily utilizes the Operator Lifecycle Manager (OLM). This change streamlines the installation process and integrates Helm for specific operations, including version updates. The documentation has been reorganized to prioritize the OLM method, reflecting a shift towards more modern, Kubernetes-native deployment practices. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (1 hunks)
Additional comments: 4
README.md (4)
- 32-34: The instructions for using OLM to install the Ceph S3 Operator are clear and concise. However, it would be beneficial to include a brief explanation of what OLM is and why it's recommended for managing Kubernetes operators, especially for readers who might be unfamiliar with it.
- 41-41: The Helm upgrade command specifies version
v0.3.7. Ensure this version aligns with the latest stable release of the Ceph S3 Operator and reflects any necessary updates or enhancements mentioned in the PR objectives.Verification successful
The Helm upgrade command in the README.md correctly specifies version
v0.3.7for the Ceph S3 Operator, which aligns with the latest stable release according to the GitHub repository. The verification confirms that the documentation is up-to-date with the actual release version.* 44-50: The Makefile approach for deployment is still included in the README. Given the PR's objective to prioritize OLM and Helm for installation, consider removing this section or explicitly stating that it's a less recommended method compared to OLM and Helm. * 29-53: > 📝 **NOTE** > This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [128-128]Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the latest stable release version of the Ceph S3 Operator Helm chart curl -s https://api.github.com/repos/snapp-incubator/ceph-s3-operator/releases/latest | jq -r '.tag_name'Length of output: 112
The phrase "feel free to" is commonly used but can be replaced with a more formal alternative to enhance the professionalism of the document.
Consider using "We welcome contributions. Please submit issues or pull requests." as an alternative.
| > Note: prior Ceph versions [don't support the subuser bucket policy](https://github.com/ceph/ceph/pull/33714). Nevertheless, other features are expected to work properly within those earlier releases. | ||
| - ClusterResourceQuota CRD: `kubectl apply -f config/external-crd` | ||
|
|
||
| ### Using Makefile | ||
|
|
||
| Deploy using a simple command: | ||
| ### Using OLM | ||
|
|
||
| ```bash | ||
| make deploy | ||
| ``` | ||
| You can find the operator on [OperatorHub](https://operatorhub.io/operator/ceph-s3-operator) and install it using OLM. | ||
|
|
||
| ### Using Helm | ||
|
|
||
| Deploy using Helm (version 3.8.0 or later), which supports OCI charts. To use the helm chart, edit the `values.yaml` file and set `controllerManagerConfig.configYaml` to your Ceph cluster configuration like [secret.yaml](config/manager/secret.yaml). | ||
|
|
||
| ```bash | ||
| helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.6 | ||
| helm upgrade --install ceph-s3-operator oci://ghcr.io/snapp-incubator/ceph-s3-operator/helm-charts/ceph-s3-operator --version v0.3.7 | ||
| ``` | ||
|
|
||
| ### Using OLM | ||
| ### Using Makefile | ||
|
|
||
| You can find the operator on [OperatorHub](https://operatorhub.io/operator/ceph-s3-operator) and install it using OLM. | ||
| Deploy using a simple command: | ||
|
|
||
| ```bash | ||
| make deploy | ||
| ``` | ||
|
|
||
| ## Usage and Documentation | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [91-93]
Consider changing "setup" to "set up" when used as a verb, to improve grammatical correctness.
- First setup the local Ceph cluster:
+ First set up the local Ceph cluster:
Summary by CodeRabbit