Skip to content

Commit b9ffb31

Browse files
committed
Add docs for clean command
1 parent fdc3c34 commit b9ffb31

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

gitpod-network-check/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A CLI to check if your network setup is suitable for the installation of Gitpod.
1717
```
1818

1919
2. Set up AWS credentials
20-
20+
2121
`gitpod-network-check` needs access to the AWS account you are planning to use to deploy Gitpod in. Much like AWS CLI, `gitpod-network-check` uses the available AWS profile in your terminal to authenticate against the account. This means that you can rely on any locally available [AWS profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) or just set the right environment variables in your terminal for the CLI to use:
2222
```
2323
export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
@@ -44,7 +44,7 @@ A CLI to check if your network setup is suitable for the installation of Gitpod.
4444
4545
To start the diagnosis, the the command: `./gitpod-network-check diagnose`
4646

47-
```
47+
```console
4848
./gitpod-network-check diagnose
4949
INFO[0000] ✅ Main Subnets are valid
5050
INFO[0000] ✅ Pod Subnets are valid
@@ -77,3 +77,18 @@ A CLI to check if your network setup is suitable for the installation of Gitpod.
7777
INFO[0191] ✅ S3 is available
7878
```
7979

80+
3. Clean up after network diagnosis
81+
82+
Dianosis is designed to do clean-up before it finishes. However, if the process terminates unexpectedly, you may clean-up AWS resources it creates like so:
83+
84+
```console
85+
./gitpod-network-check clean
86+
INFO[0000] ✅ Main Subnets are valid
87+
INFO[0000] ✅ Pod Subnets are valid
88+
INFO[0000] ✅ Instances terminated
89+
INFO[0000] Cleaning up: Waiting for 2 minutes so network interfaces are deleted
90+
INFO[0121] ✅ Role 'GitpodNetworkCheck' deleted
91+
INFO[0121] ✅ Instance profile deleted
92+
INFO[0122] ✅ Security group 'sg-0a6119dcb6a564fc1' deleted
93+
INFO[0122] ✅ Security group 'sg-07373362953212e54' deleted
94+
```

0 commit comments

Comments
 (0)