feat: add advanced deployment config documentation #76
Conversation
ENG-915 Write documentation
Write documentation for end users and pass to the customer success team. Add link to this documentation in the configuration forms in the UI. |
Reviewer's Guide by SourceryThis pull request adds documentation for advanced deployment configuration in Kubernetes, enabling users to customize their deployments with more granular control over Kubernetes resources. The changes primarily focus on updating the installation documentation to include this new feature and its usage instructions. File-Level Changes
Tips
|
WalkthroughThe changes introduce an advanced deployment configuration feature in the installation documentation for the SettleMint platform. This feature allows users to customize Kubernetes configurations through the Changes
Poem
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
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @SilVdB - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a brief example of how to use one or two of these advanced configurations in practice. This would help users better understand how to implement these features in their own deployments.
- It might be beneficial to include a note about the potential implications of using these advanced configurations, such as impacts on portability or maintenance. This would help users make informed decisions when utilizing these features.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 3 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
Outdated
Show resolved
Hide resolved
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
Outdated
Show resolved
Hide resolved
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
Show resolved
Hide resolved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (2 hunks)
Additional context used
Markdownlint
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
46-46: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
50-50: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
54-54: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (3)
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (3)
27-40: LGTM!The introduction of the advanced deployment configuration feature and the instructions to enable it are clear and accurate.
56-60: LGTM!The usage section clearly explains how the advanced deployment configurations can be applied when creating new cluster services or modifying existing ones.
137-138: LGTM!Enabling the advanced deployment configuration feature in the example values file is a helpful addition for users.
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Hey @SilVdB - I've reviewed your changes - here's some feedback:
Overall Comments:
- Great addition to the documentation. Minor suggestion: 'adviced' should be spelled 'advised' in the sentence 'Basic knowledge of Kubernetes is adviced when using this feature.'
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (2 hunks)
Additional context used
Markdownlint
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (2)
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (2)
103-104: LGTM!The code segment correctly enables the advanced deployment configuration feature in the
values.yamlfile.
181-221: Great addition to the documentation!The new section provides clear instructions on enabling and using the advanced deployment configuration feature. It also gives users a helpful overview of the configurable options available.
Tools
Markdownlint
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
| 1. **Labels and Annotations** | ||
| - For Deployments, Ingress, and Services | ||
| 2. **Environment Variables** | ||
| - Custom environment variables for your containers | ||
| 3. **Tolerations** | ||
| - Specify which nodes your pods can be scheduled on | ||
| 4. **Affinities** | ||
| - Define rules for pod scheduling preferences | ||
| 5. **Node Selectors** | ||
| - Constrain pods to specific nodes |
There was a problem hiding this comment.
Fix the list indentation for consistency.
The configurable options are listed correctly. However, please fix the indentation of the list items to improve readability and adhere to Markdown best practices.
Apply this diff to fix the indentation:
When enabled, you can configure the following aspects of your Kubernetes resources:
-1. **Labels and Annotations**
- - For Deployments, Ingress, and Services
-2. **Environment Variables**
- - Custom environment variables for your containers
-3. **Tolerations**
- - Specify which nodes your pods can be scheduled on
-4. **Affinities**
- - Define rules for pod scheduling preferences
-5. **Node Selectors**
- - Constrain pods to specific nodes
+1. **Labels and Annotations**
+ - For Deployments, Ingress, and Services
+2. **Environment Variables**
+ - Custom environment variables for your containers
+3. **Tolerations**
+ - Specify which nodes your pods can be scheduled on
+4. **Affinities**
+ - Define rules for pod scheduling preferences
+5. **Node Selectors**
+ - Constrain pods to specific nodesCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. **Labels and Annotations** | |
| - For Deployments, Ingress, and Services | |
| 2. **Environment Variables** | |
| - Custom environment variables for your containers | |
| 3. **Tolerations** | |
| - Specify which nodes your pods can be scheduled on | |
| 4. **Affinities** | |
| - Define rules for pod scheduling preferences | |
| 5. **Node Selectors** | |
| - Constrain pods to specific nodes | |
| 1. **Labels and Annotations** | |
| - For Deployments, Ingress, and Services | |
| 2. **Environment Variables** | |
| - Custom environment variables for your containers | |
| 3. **Tolerations** | |
| - Specify which nodes your pods can be scheduled on | |
| 4. **Affinities** | |
| - Define rules for pod scheduling preferences | |
| 5. **Node Selectors** | |
| - Constrain pods to specific nodes |
Tools
Markdownlint
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (1)
212-221: Enhance the list of configurable options.The list provides a good overview of the available configuration options.
Consider adding brief explanations for each option to help users who are not familiar with Kubernetes concepts, as suggested in the previous review:
When enabled, you can configure the following aspects of your Kubernetes resources: 1. **Labels and Annotations** + - Metadata to organize and identify Kubernetes resources - For Deployments, Ingress, and Services 2. **Environment Variables** + - Key-value pairs to configure application behavior - Custom environment variables for your containers 3. **Tolerations** + - Allow pods to be scheduled on nodes with matching taints - Specify which nodes your pods can be scheduled on 4. **Affinities** + - Define rules for pod-to-node or pod-to-pod scheduling preferences - Define rules for pod scheduling preferences 5. **Node Selectors** + - Simple key-value pairs to constrain pods to specific nodes - Constrain pods to specific nodesAlso, please fix the list indentation for consistency and readability, as flagged by static analysis:
When enabled, you can configure the following aspects of your Kubernetes resources: -1. **Labels and Annotations** - - For Deployments, Ingress, and Services -2. **Environment Variables** - - Custom environment variables for your containers -3. **Tolerations** - - Specify which nodes your pods can be scheduled on -4. **Affinities** - - Define rules for pod scheduling preferences -5. **Node Selectors** - - Constrain pods to specific nodes +1. **Labels and Annotations** + - For Deployments, Ingress, and Services +2. **Environment Variables** + - Custom environment variables for your containers +3. **Tolerations** + - Specify which nodes your pods can be scheduled on +4. **Affinities** + - Define rules for pod scheduling preferences +5. **Node Selectors** + - Constrain pods to specific nodesTools
Markdownlint
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (2 hunks)
Additional context used
Markdownlint
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (2)
docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation.md (2)
103-104: LGTM!The new feature is correctly enabled in the configuration.
Consider adding a comment linking this to the new 'Advanced deployment configuration' section, as suggested in the previous review:
advancedDeploymentConfig: # For more information on Advanced deployment configuration, see: # https://docs.example.com/advanced-deployment-config enabled: true
181-221: Excellent addition of the 'Advanced deployment configuration' section!The new section provides clear details on enabling and using the feature.
Please fix the list indentation for consistency and readability, as suggested in the previous review and flagged by static analysis:
When enabled, you can configure the following aspects of your Kubernetes resources: -1. **Labels and Annotations** - - For Deployments, Ingress, and Services -2. **Environment Variables** - - Custom environment variables for your containers -3. **Tolerations** - - Specify which nodes your pods can be scheduled on -4. **Affinities** - - Define rules for pod scheduling preferences -5. **Node Selectors** - - Constrain pods to specific nodes +1. **Labels and Annotations** + - For Deployments, Ingress, and Services +2. **Environment Variables** + - Custom environment variables for your containers +3. **Tolerations** + - Specify which nodes your pods can be scheduled on +4. **Affinities** + - Define rules for pod scheduling preferences +5. **Node Selectors** + - Constrain pods to specific nodesAlso, please correct the spelling:
-Basic knowledge of Kubernetes is adviced when using this feature. +Basic knowledge of Kubernetes is advised when using this feature.Tools
Markdownlint
213-213: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
215-215: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
217-217: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
219-219: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
221-221: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
Summary by Sourcery
Add advanced deployment configuration documentation to guide users on overriding default Kubernetes settings, enabling the feature, and configuring various aspects of Kubernetes resources.
Documentation:
Summary by CodeRabbit
New Features
Documentation