docs: k8s dry run section added #1142
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/k8s.rst
Outdated
| @@ -116,6 +116,21 @@ All non-persisting data will be deleted, and then re-created. | |||
| Common tasks | |||
| ------------ | |||
|
|
|||
| ### Using `tutor k8s apply` with Dry Run | |||
There was a problem hiding this comment.
nit: this is not rendering as a heading. You might want to try underlining it with =
docs/k8s.rst
Outdated
Comment on lines
121
to
132
| The `tutor k8s apply` command serves as a wrapper around `kubectl apply`, allowing you to easily apply your Kubernetes resource configurations stored in `$(tutor config printroot)/env/k8s`. To apply your configurations, simply run:: | ||
|
|
||
| tutor k8s apply | ||
|
|
||
| Before applying changes, you can validate your configurations without making any modifications by using the dry-run option with the server-side validation. Run:: | ||
|
|
||
| tutor k8s apply --dry-run=server --validate=true | ||
|
|
||
| - `--dry-run=server`: This option simulates the application of configurations on the server-side, allowing you to see how Kubernetes would interpret your changes. | ||
| - `--validate=true`: This validates your manifests against Kubernetes API standards, helping to catch any errors before applying them. | ||
|
|
||
| Utilizing the dry-run feature ensures a more robust deployment process for your Open edX platform on Kubernetes. |
There was a problem hiding this comment.
nit: We are trying to avoid the usage of you, yours etc. in the docs. The aim is to make the docs generic and not address anyone.
CodeWithEmad
force-pushed
the
fix/dry-run
branch
from
9e25bc2
to
e9daf9c
Compare
DawoudSheraz
approved these changes
Oct 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A section will be added to the Kubernetes documentation, explaining the apply command and the benefits of running a dry run before the final deployment.
#1138