Skip to content

Commit 273f3b4

Browse files
nandajavarmaFuristo
andcommitted
adding networking checker
Co-authored-by: Thomas Schubart <[email protected]>
1 parent 30a60bb commit 273f3b4

File tree

9 files changed

+911
-0
lines changed

9 files changed

+911
-0
lines changed

.gitpod.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
image: gitpod/workspace-full
2+
3+
checkoutLocation: enterprise-deployment-toolkit
4+
workspaceLocation: enterprise-deployment-toolkit/enterprise-deployment-toolkit.code-workspace
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"folders": [
3+
{ "path": "." },
4+
{ "path": "gitpod-network-check" , "name": "gitpod-network-check" },
5+
],
6+
"settings": {
7+
"[go]": {
8+
"editor.formatOnSave": true
9+
},
10+
"[tf]": {
11+
"editor.insertSpaces": true,
12+
"editor.tabSize": 2
13+
},
14+
"go.formatTool": "goimports",
15+
"go.useLanguageServer": true,
16+
"workspace.supportMultiRootWorkspace": true,
17+
"launch": {},
18+
"files.exclude": {
19+
"**/.git": true
20+
},
21+
"go.lintTool": "golangci-lint",
22+
"gopls": {
23+
"allowModfileModifications": true
24+
},
25+
}
26+
}
27+

gitpod-network-check/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# gitpod-network-check
2+
3+
A CLI to check if your network setup is suitable for the installation of Gitpod.
4+
5+
## How to use
6+
7+
1. In order to perform a network check create a config filed called gitpod-network-check.yaml file that needs to be located in the same directory as the gitpod-network-check binary. Alternatively you can use the `--config` option to specify the config file. The config file needs to contain the region and the subnets that you want to use for your Gitpod installation.
8+
9+
```yaml
10+
log-level: debug # Options: debug, info, warning, error
11+
region: eu-central-1
12+
main-subnets: subnet-0554e84f033a64c56, subnet-08584621e7754e505, subnet-094c6fd68aea493b7
13+
pod-subnets: subnet-028d11dce93b8eefc, subnet-04ec8257d95c434b7,subnet-00a83550ce709f39c
14+
```
15+
16+
2. Get the AWS credentials of the account where you want to install Gitpod and set them as environment variables
17+
18+
3. Run `gitpod-network-check diagnose`. The expected output should look similar to this.
19+
20+
```
21+
INFO[0000] ✅ Main Subnets are valid
22+
INFO[0000] ✅ Pod Subnets are valid
23+
INFO[0000] ℹ️ Checking prerequisites
24+
INFO[0000] ✅ VPC endpoint com.amazonaws.eu-central-1.ec2messages is configured
25+
INFO[0000] ✅ VPC endpoint com.amazonaws.eu-central-1.ssm is configured
26+
INFO[0000] ✅ VPC endpoint com.amazonaws.eu-central-1.ssmmessages is configured
27+
INFO[0001] ℹ️ Launching EC2 instance in a Main subnet
28+
INFO[0007] ℹ️ Launching EC2 instance in a Pod subnet
29+
INFO[0009] ℹ️ Waiting for EC2 instances to become ready (can take up to 2 minutes)
30+
INFO[0167] ✅ EC2 Instances are now running successfully
31+
INFO[0167] ℹ️ Connecting to SSM...
32+
INFO[0175] ℹ️ Checking if the required AWS Services can be reached from the ec2 instances
33+
INFO[0178] ✅ Autoscaling is available
34+
INFO[0179] ✅ CloudFormation is available
35+
INFO[0179] ✅ CloudWatch is available
36+
INFO[0180] ✅ EC2 is available
37+
INFO[0181] ✅ EC2messages is available
38+
INFO[0182] ✅ ECR is available
39+
INFO[0183] ✅ ECR Api is available
40+
INFO[0184] ✅ EKS is available
41+
INFO[0185] ✅ Elastic LoadBalancing is available
42+
INFO[0185] ✅ KMS is available
43+
INFO[0186] ✅ Kinesis Firehose is available
44+
INFO[0187] ✅ SSM is available
45+
INFO[0188] ✅ SSMmessages is available
46+
INFO[0189] ✅ SecretsManager is available
47+
INFO[0190] ✅ Sts is available
48+
INFO[0190] ✅ DynamoDB is available
49+
INFO[0191] ✅ S3 is available
50+
```

0 commit comments

Comments
 (0)