From ba77a12899c3632a2368b55f1ec2cfc354914c16 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Thu, 7 May 2020 14:28:11 -0700 Subject: [PATCH] Mention undeploy in tutorial (#457) --- docs/tutorials/hello-tye/01_deploy.md | 14 ++++++++++++++ docs/tutorials/hello-tye/02_add_redis.md | 4 ++++ 2 files changed, 18 insertions(+) diff --git a/docs/tutorials/hello-tye/01_deploy.md b/docs/tutorials/hello-tye/01_deploy.md index 05416aec..60141683 100644 --- a/docs/tutorials/hello-tye/01_deploy.md +++ b/docs/tutorials/hello-tye/01_deploy.md @@ -133,6 +133,20 @@ Tye has a optional configuration file (`tye.yaml`) to allow customizing settings > :question: This step may not make much sense if you're using `tye.yaml` to store a personal Dockerhub username. A more typical use case would storing the name of a private registry for use in a CI/CD system. +## Undeploying the application + +After deploying and playing around with the application, you may want to remove all resources associated from the Kubernetes cluster. You can remove resources by running: + +```text +tye undeploy +``` + +This will remove all deployed resources. If you'd like to see what resources would be deleted, you can run: + +```text +tye undeploy --what-if +``` + ## Next Steps Now that you are able to deploy an application to Kubernetes, learn how to add a non-project dependency to tye with [the next step (add Redis)](02_add_redis.md). diff --git a/docs/tutorials/hello-tye/02_add_redis.md b/docs/tutorials/hello-tye/02_add_redis.md index f936db25..649d49f1 100644 --- a/docs/tutorials/hello-tye/02_add_redis.md +++ b/docs/tutorials/hello-tye/02_add_redis.md @@ -182,3 +182,7 @@ We just showed how `tye` makes it easier to communicate between 2 applications r ``` Visit `http://localhost:5000` to see the `frontend` working in kubernetes. + +4. Clean-up + + At this point, you may want to undeploy the application by running `tye undeploy`.