Skip to content

Commit e8e1c8f

Browse files
committed
readme: Be specific about SSL cert
Current instructions about SSL certificate are pretty much open to interpretation, and users might probably end up not adding all the required domain names, causing gitpod instance to fail on startup. This updates the guide to be more clear Signed-off-by: Tarun Pothulapati <[email protected]>
1 parent ff5bbec commit e8e1c8f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,20 @@ Before starting the installation process, you need:
66

77
- An AWS account with Administrator access
88
- [Create one now by clicking here](https://aws.amazon.com/getting-started/)
9-
- A SSL Certificate created with [AWS Certificate Manager](https://aws.amazon.com/en/certificate-manager/)
109
- AWS credentials set up. By default, those configs are present in `$HOME/.aws/`.
1110
- [eksctl](https://eksctl.io/) config file describing the cluster.
1211
- Here is an [eks-cluster.yaml](eks-cluster.yaml) you can use as example.
1312
- A `.env` file with basic details about the environment.
1413
- We provide an example of such file [here](.env.example).
1514
- [Docker](https://docs.docker.com/engine/install/) installed on your machine, or better, a Gitpod workspace :)
1615

16+
### SSL Certificate
17+
18+
Create a public SSL/TLS certificate with [AWS Certificate Manager](https://aws.amazon.com/en/certificate-manager/),
19+
valid for the `<domain>`, `*.ws.<domain>` and `*.<domain>` Domain names.
20+
21+
Once the certificate is issued and verified, Update the `CERTIFICATE_ARN` field in the `.env` file accordingly.
22+
1723
### Choose an Amazon Machine Image (AMI)
1824

1925
Please update the `ami` field in the [eks-cluster.yaml](eks-cluster.yaml) file with the proper AMI ID for the region of the cluster.

0 commit comments

Comments
 (0)