Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ceph-csi how-to (Juju) #819

Merged
merged 4 commits into from
Nov 26, 2024
Merged

Conversation

petrutlucian94
Copy link
Contributor

@petrutlucian94 petrutlucian94 commented Nov 20, 2024

We're adding a guide that describes the steps to deploy Ceph and the Ceph CSI plugin using Juju.

It mostly follows the steps outlined in the ceph-csi charm readme: https://github.com/charmed-kubernetes/ceph-csi-operator/blob/main/README.md

@petrutlucian94 petrutlucian94 requested a review from a team as a code owner November 20, 2024 15:31
@petrutlucian94 petrutlucian94 marked this pull request as draft November 20, 2024 15:31
@petrutlucian94 petrutlucian94 marked this pull request as ready for review November 21, 2024 12:15
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order for this page to be accessible from the navigation, you need to add it to the index page at docs/src/charm/howto/index.md

docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
We're adding a guide that describes the steps to deploy Ceph and the
Ceph CSI plugin using Juju.

It mostly follows the steps outlined in the ceph-csi readme:
https://github.com/charmed-kubernetes/ceph-csi-operator/blob/main/README.md
@petrutlucian94
Copy link
Contributor Author

In order for this page to be accessible from the navigation, you need to add it to the index page at docs/src/charm/howto/index.md

Whops, forgot to add that. I've updated the PR, thanks!

edited the language to be more in line with a how-to guide rather than tutorial. Also changes to layout and heading
@nhennigan
Copy link
Contributor

I made some changes to your PR. It was mainly styling. Once you have a read through to make sure it still all makes sense go ahead and merge. Great work 😄

Copy link
Contributor Author

@petrutlucian94 petrutlucian94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nhennigan thanks for making these changes! I think we should keep the juju deploy k8s example, maybe even add an explicit note about the vm resources. By default, it will allocate a single vm cpu, which isn't enough and some k8s services and pods will hang.

docs/src/charm/howto/ceph-csi.md Outdated Show resolved Hide resolved
VM containers will default to 1 vcpu, which isn't enough for K8s.
K8s services and pods will hang unless we allocate enough resources.

We'll readd the "juju k8s deploy" example and an explicit note
on resource requirements.
@nhennigan
Copy link
Contributor

LGTM. You can go ahead and merge. Thanks for all your help

@petrutlucian94 petrutlucian94 merged commit a6d3bfd into canonical:main Nov 26, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants