Skip to content

Commit

Permalink
add note about deploy vs destroy
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdjscott committed Apr 29, 2024
1 parent 8aa9b4d commit cfbbef4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/tutorials/deployment-on-nesi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit cfbbef4

Please sign in to comment.