[checks] make api-endpoint parameter optional & update usage docs

[kylos101]

Description

It is only necessary for customers to specify a value for api-endpoint when the VPC endpoints are not in the same account as Gitpod.

Related Issue(s)

Fixes CLC-1118

How to test

Documentation

/hold

[kylos101]

Test without the api-endpoint:

go run . diagnose
INFO[0000] ℹ️  Running with region `eu-central-1`, main subnet `[subnet-02a57899464adb227  subnet-013003bf204f47611]`, pod subnet `[subnet-0f59b6bfead78792c  subnet-0d6ae7d559bcf50db]`, hosts `[accounts.google.com  https://github.com]`, and api endpoint `` 
INFO[0000] ✅ Main Subnets are valid                     
INFO[0000] ✅ Pod Subnets are valid                      
INFO[0000] ℹ️  Checking prerequisites                   
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ec2messages is not configured, testing service connectivity... 
INFO[0000] ✅ Service ec2messages.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ssm is not configured, testing service connectivity... 
INFO[0000] ✅ Service ssm.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ssmmessages is not configured, testing service connectivity... 
INFO[0000] ✅ Service ssmmessages.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ✅ VPC endpoint com.amazonaws.eu-central-1.execute-api is configured 
INFO[0001] ✅ IAM role created and policy attached       
INFO[0001] ℹ️  Launching EC2 instances in Main subnets  
INFO[0001] ℹ️  Created security group with ID: sg-01516553b330a0c90 
INFO[0002] ℹ️  Instance type t2.micro shall be used     
INFO[0008] ℹ️  Created security group with ID: sg-07e4eca32a508081d 
INFO[0009] ℹ️  Instance type t2.micro shall be used     
INFO[0010] ℹ️  Main EC2 instances: [i-0a5cd2ba4bdb4662b i-09a06f7c7f2c09500] 
INFO[0010] ℹ️  Launching EC2 instances in a Pod subnets 
INFO[0011] ℹ️  Created security group with ID: sg-088e98cc0fc760c4e 
INFO[0011] ℹ️  Instance type t2.micro shall be used     
INFO[0013] ℹ️  Created security group with ID: sg-07ee7f5077001748e 
INFO[0013] ℹ️  Instance type t2.micro shall be used     
INFO[0015] ℹ️  Pod EC2 instances: [i-078c89c4a6d371725 i-0c667729055857500] 
INFO[0015] ℹ️  Waiting for EC2 instances to become ready (can take up to 2 minutes) 
INFO[0020] ✅ EC2 Instances are now running successfully 
INFO[0020] ℹ️  Connecting to SSM...                     
INFO[0107] ℹ️  Checking if the required AWS Services can be reached from the ec2 instances in the pod subnet 
INFO[0108] ✅ Autoscaling is available                   
INFO[0109] ✅ CloudFormation is available                
INFO[0109] ✅ CloudWatch is available                    
INFO[0110] ✅ EC2 is available                           
INFO[0111] ✅ EC2messages is available                   
INFO[0112] ✅ ECR is available                           
INFO[0113] ✅ ECR Api is available                       
INFO[0114] ✅ EKS is available                           
INFO[0114] ✅ Elastic LoadBalancing is available         
INFO[0115] ✅ KMS is available                           
INFO[0116] ✅ Kinesis Firehose is available              
INFO[0117] ✅ SSM is available                           
INFO[0118] ✅ SSMmessages is available                   
INFO[0119] ✅ SecretsManager is available                
INFO[0120] ✅ Sts is available                           
INFO[0120] ℹ️  Checking if certain AWS Services can be reached from ec2 instances in the main subnet 
INFO[0121] ✅ DynamoDB is available                      
INFO[0121] ✅ S3 is available                            
INFO[0121] ℹ️  Checking if hosts can be reached with HTTPS from ec2 instances in the main subnets 
INFO[0122] ✅ accounts.google.com is available           
INFO[0124] ✅ https://github.com is available            
INFO[0124] ✅ Instances terminated                       
INFO[0124] Cleaning up: Waiting for 2 minutes so network interfaces are deleted 

[kylos101]

Test with the API endpoint:

go run . diagnose
INFO[0000] ℹ️  Running with region `eu-central-1`, main subnet `[subnet-02a57899464adb227  subnet-013003bf204f47611]`, pod subnet `[subnet-0f59b6bfead78792c  subnet-0d6ae7d559bcf50db]`, hosts `[accounts.google.com  https://github.com]`, and api endpoint `xxxxxxx` 
INFO[0000] ✅ Main Subnets are valid                     
INFO[0000] ✅ Pod Subnets are valid                      
INFO[0000] ℹ️  Checking prerequisites                   
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ec2messages is not configured, testing service connectivity... 
INFO[0000] ✅ Service ec2messages.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ssm is not configured, testing service connectivity... 
INFO[0000] ✅ Service ssm.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ℹ️  VPC endpoint com.amazonaws.eu-central-1.ssmmessages is not configured, testing service connectivity... 
INFO[0000] ✅ Service ssmmessages.eu-central-1.amazonaws.com has connectivity 
INFO[0000] ✅ VPC endpoint com.amazonaws.eu-central-1.execute-api is configured 
INFO[0000] ✅ IAM role created and policy attached       
INFO[0001] ℹ️  Launching EC2 instances in Main subnets  
INFO[0001] ℹ️  Created security group with ID: sg-09b2284c0093eb035 
INFO[0001] ℹ️  Instance type t2.micro shall be used     
INFO[0009] ℹ️  Created security group with ID: sg-0ff72f7773ceec85e 
INFO[0009] ℹ️  Instance type t2.micro shall be used     
INFO[0011] ℹ️  Main EC2 instances: [i-016cabdc0b33087eb i-07a6e83f7aed2c751] 
INFO[0011] ℹ️  Launching EC2 instances in a Pod subnets 
INFO[0011] ℹ️  Created security group with ID: sg-04daed7857405ac7a 
INFO[0011] ℹ️  Instance type t2.micro shall be used     
INFO[0013] ℹ️  Created security group with ID: sg-041069ca53407ff1f 
INFO[0014] ℹ️  Instance type t2.micro shall be used     
INFO[0015] ℹ️  Pod EC2 instances: [i-0658de2c693df5adf i-0820ec912ffd9c4f5] 
INFO[0015] ℹ️  Waiting for EC2 instances to become ready (can take up to 2 minutes) 
INFO[0021] ✅ EC2 Instances are now running successfully 
INFO[0021] ℹ️  Connecting to SSM...                     
INFO[0106] ℹ️  Checking if the required AWS Services can be reached from the ec2 instances in the pod subnet 
INFO[0107] ✅ Autoscaling is available                   
INFO[0108] ✅ CloudFormation is available                
INFO[0110] ✅ CloudWatch is available                    
INFO[0111] ✅ EC2 is available                           
INFO[0112] ✅ EC2messages is available                   
INFO[0112] ✅ ECR is available                           
INFO[0113] ✅ ECR Api is available                       
INFO[0114] ✅ EKS is available                           
INFO[0115] ✅ Elastic LoadBalancing is available         
INFO[0116] ✅ KMS is available                           
INFO[0117] ✅ Kinesis Firehose is available              
INFO[0119] ✅ SSM is available                           
INFO[0120] ✅ SSMmessages is available                   
INFO[0120] ✅ SecretsManager is available                
INFO[0121] ✅ Sts is available                           
INFO[0121] ℹ️  Checking if certain AWS Services can be reached from ec2 instances in the main subnet 
INFO[0122] ✅ DynamoDB is available                      
INFO[0124] ✅ ExecuteAPI is available           <--- here         
INFO[0124] ✅ S3 is available                            
INFO[0124] ℹ️  Checking if hosts can be reached with HTTPS from ec2 instances in the main subnets 
INFO[0125] ✅ accounts.google.com is available           
INFO[0125] ✅ https://github.com is available            
INFO[0126] ✅ Instances terminated                       
INFO[0126] Cleaning up: Waiting for 2 minutes so network interfaces are deleted