forked from interuss/dss
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README with debugging instructions
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# AWS-1 CI deployment | ||
|
||
This module deploys a kubernetes cluster to AWS and provisions the dss using helm. | ||
|
||
## Terraform state | ||
|
||
The terraform backend is configured to be shared using a S3 bucket. (see [`main.tf`](./main.tf)). | ||
|
||
## Debugging | ||
|
||
In case of issue, it is possible to connect to the cluster and retrieve the terraform state to manage it | ||
locally. | ||
|
||
### Connection to the cluster | ||
|
||
To connect to the cluster, authenticate yourself to the AWS account. | ||
Run the following command to load the kubernetes config: | ||
``` | ||
aws eks --region us-east-1 update-kubeconfig --name dss-ci-aws-ue1 | ||
``` | ||
Call the kubernetes cluster using `kubectl` | ||
|
||
#### Add other roles | ||
|
||
Access to the cluster is managed using the config map `aws-auth`. | ||
Its definition is managed by [`kubernetes_admin_access.tf`](./kubernetes_admin_access.tf). | ||
Currently only the user who bootstrapped the cluster and the ones assuming | ||
the administrator role (see [`local_variables.tf`](./local_variables.tf)) have access. | ||
|
||
### Run terraform locally | ||
|
||
In case of failure, a user with administrator role can take over the deployment by cloning this | ||
repository and retrieving the current deployment state by running the following command: | ||
|
||
``` | ||
terraform init | ||
``` | ||
|
||
At this point, the user can replay or clean the deployment as if it was the CI runner. |