diff --git a/docs/tutorials/deployment-on-nesi.md b/docs/tutorials/deployment-on-nesi.md index 169c020..8abe1b1 100644 --- a/docs/tutorials/deployment-on-nesi.md +++ b/docs/tutorials/deployment-on-nesi.md @@ -94,3 +94,25 @@ To destroy your environment after you have finished using it: !!! important Double check that you have selected the correct branch + +## Deploying vs destroying + +Many changes can be redeployed on top of an existing deployment rather than destroying and deploying from scratch. + +For example, with the following changes you can probably just rerun the deployment workflow and the changes will be applied to the existing environment: + +- add a new app to `ood_apps` +- change the `version` of an existing app +- change the `k8s_container` of an existing app +- enable the pod pre-puller +- add additional users + +However, in some cases you will need to destroy the existing environment and deploy a new one from scratch: + +- change the flavor of the web or services node +- change the disk space of the web or services node +- change the number of k8s worker nodes +- change the flavor of the k8s worker nodes +- change the control plane flavour + +The above lists are not exhaustive, they just provide some examples. diff --git a/mkdocs.yml b/mkdocs.yml index 58dfe61..7c55e8d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ nav: - Overview: 'index.md' - Tutorials: - "Adding a new app": "tutorials/adding-new-app.md" + - "Deploying on NeSI": "tutorials/deployment-on-nesi.md" - "JupyterLab app for Intermediate Shell for Bioinformatics": "tutorials/jupyterlab-app-for-intermediate-shell-for-bioinformatics.md" - Apps: - Overview: 'apps/index.md'