christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2025-01-24 14:08:23 +00:00
Code Issues Releases Activity

docs: k8s dry run section added (#1142)

Browse Source
This commit is contained in:
Emad Rad 2024-10-21 10:53:42 +03:30 committed by GitHub
parent 9e5a87bea7
commit 97e9fa4751
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/k8s.rst
View File

@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~