-
Notifications
You must be signed in to change notification settings - Fork 13
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
fix: changed the storageClass to default #66
Conversation
Caution Review failedThe pull request is closed. WalkthroughThe changes in this pull request involve updates to the Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
charts/plane-ce/values.yaml (1)
32-32
: LGTM! Good improvement in storage class configuration.The change from hardcoded 'longhorn' to empty string ("") is a good improvement as it:
- Makes the chart more portable across different Kubernetes clusters
- Allows the cluster's default storage class to be used
- Enables users to explicitly specify their preferred storage class if needed
Consider adding a comment in the values.yaml file to clarify that an empty string will use the cluster's default storage class. This would improve the self-documentation of the configuration.
Also applies to: 41-41, 52-52, 66-66
charts/plane-ce/README.md (1)
18-18
: Improve clarity in the setup instructions.Consider these minor text improvements:
- Line 18: Add "a" before "default storage class"
- Line 38: Avoid starting consecutive sentences with "the default"
Apply these changes:
-This will create stateful deployments for Postgres, Redis, and Minio with a persistent volume claim using the default storage class. +This will create stateful deployments for Postgres, Redis, and Minio with a persistent volume claim using a default storage class. -You can change the default namespace from `plane-ce`, the default appname from `plane-app`, the default storage class from `[postgres, redis, minio].storageClass`, and the default ingress class +You can change the namespace from `plane-ce`, the application name from `plane-app`, the storage class from `[postgres, redis, minio].storageClass`, and the ingress classAlso applies to: 38-38
charts/plane-enterprise/README.md (1)
29-29
: Improve clarity in the setup instructions.Similar to the CE version, consider these text improvements:
- Line 29: Add "a" before "default storage class"
- Lines 48-49: Avoid starting consecutive sentences with "the default"
Apply these changes:
-This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using the default storage class. +This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using a default storage class. -from `plane-app`, the default storage class from default storage class, and the default ingress class from `nginx` to +from `plane-app`, the storage class configuration, and the ingress class from `nginx` toAlso applies to: 48-49
🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Possible missing article found.
Context: ... This is the fastest way to deploy Plane with default settings. This will create...(AI_HYDRA_LEO_MISSING_A)
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... claim using the default storage class. This also sets up the ingress routes for you...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (4)
charts/plane-ce/README.md
(6 hunks)charts/plane-ce/values.yaml
(4 hunks)charts/plane-enterprise/README.md
(4 hunks)charts/plane-enterprise/values.yaml
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- charts/plane-enterprise/values.yaml
🧰 Additional context used
🪛 LanguageTool
charts/plane-enterprise/README.md
[uncategorized] ~29-~29: Possible missing article found.
Context: ... This is the fastest way to deploy Plane with default settings. This will create...
(AI_HYDRA_LEO_MISSING_A)
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... claim using the default storage class. This also sets up the ingress routes for you...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (2)
charts/plane-ce/README.md (1)
40-48
: LGTM! Clear instructions for custom storage class configuration.
The new section provides clear and actionable instructions for users who need to specify a custom storage class.
charts/plane-enterprise/README.md (1)
51-56
: LGTM! Clear documentation for storage class configuration.
The storage class configuration is well documented:
- Clear instructions for setting a custom storage class
- Good explanation in the environment settings table
Also applies to: 276-276
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
charts/plane-enterprise/README.md (2)
29-29
: Consider rephrasing for better readabilityConsider rephrasing to avoid repetitive sentence beginnings:
-This is the fastest way to deploy Plane with default settings. This will create stateful deployments for Postgres, Rabbitmq, Redis/Valkey, and Minio with a persistent volume claim using the default storage class.This also sets up the ingress routes for you using `nginx` ingress class. +This is the fastest way to deploy Plane with default settings. The deployment will create stateful deployments for Postgres, Rabbitmq, Redis/Valkey, and Minio with a persistent volume claim using the default storage class. Additionally, it sets up the ingress routes for you using `nginx` ingress class.🧰 Tools
🪛 LanguageTool
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e claim using the default storage class.This also sets up the ingress routes for you...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
49-54
: Consider adding an example for clarityThe custom storage class section is clear but could benefit from a concrete example:
To specify a custom StorageClass for Plane-Enterprise components, add the following options to the above `helm upgrade --install` command: ```bash --set env.storageClass=<your-storageclass-name>
+For example:
+bash +--set env.storageClass=standard +
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7d8c02f0eb681663713eed30567cdecbe8f63d2c and b28a9883c3b3f2775993e46c132a02012a4809fd. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `charts/plane-ce/README.md` (6 hunks) * `charts/plane-enterprise/README.md` (4 hunks) </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * charts/plane-ce/README.md </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>charts/plane-enterprise/README.md</summary> [style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ...e claim using the default storage class.This also sets up the ingress routes for you... (ENGLISH_WORD_REPEAT_BEGINNING_RULE) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary> <details> <summary>charts/plane-enterprise/README.md (1)</summary> `274-274`: **LGTM! Documentation accurately reflects storage class configuration** The environment variable documentation correctly describes the storage class configuration and aligns with the PR objectives. </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Changed storageClass from
longhorn
todefault
Updated README for both CE and EE
Summary by CodeRabbit
Documentation
Configuration Changes
longhorn
to an unspecified value in the configuration files.