Skip to content

Commit

Permalink
docs: k8s dry run section added
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeWithEmad committed Oct 19, 2024
1 parent 9e5a87b commit 9e25bc2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/k8s.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,21 @@ All non-persisting data will be deleted, and then re-created.
Common tasks
------------

### Using `tutor k8s apply` with Dry Run

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.

Executing commands inside service pods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 9e25bc2

Please sign in to comment.