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

docs: k8s dry run section added #1142

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/k8s.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,22 @@ 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 acts as a wrapper around ``kubectl apply``, facilitating the application of Kubernetes resource configurations stored in ``$(tutor config printroot)/env/k8s``. To apply the configurations, execute the following command::

tutor k8s apply

Before making any changes, it is possible to validate the configurations without modifications by using the ``dry-run`` option along with server-side validation. The command is as follows::

tutor k8s apply --dry-run=server --validate=true

- ``--dry-run=server``: This option simulates the application of configurations on the server-side, providing insights into how Kubernetes would interpret the changes.
- ``--validate=true``: This option validates the manifests against Kubernetes API standards, which aids in catching potential errors prior to application.

Utilizing the dry-run feature ensures a more robust deployment process for the Open edX platform on Kubernetes.

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

Expand Down
Loading