Skip to content

Commit

Permalink
Updated README for examples/full-cluster-tf-upgrade/1.25
Browse files Browse the repository at this point in the history
  • Loading branch information
dang0317 committed Nov 2, 2023
1 parent 279d0f3 commit 491ae95
Showing 1 changed file with 9 additions and 38 deletions.
47 changes: 9 additions & 38 deletions examples/full-cluster-tf-upgrade/1.25/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,20 @@ There are a number of steps to end up with a cluster.

1. From main repository, in the same `vpc/{region}/vpc{number}` directory
1. [Tag subnets](#subnet-tagging) in main repository (before creating nodegroup)
1. [Copy variables.vpc.*](#copy-variable-settings) from main respository in the same `vpc/{region}/vpc{number}`
1. Copy the [includes.d structure](#copy-includesd)
1. In the submodule repository, in the `vpc/{region}/vpc{number}/apps/{clustername}` directory
1. Update `settings.auto.tfvars`
1. Update `includes.d/parent_rs.tf`
1. Terraform [Automated Setup](#terraform-automated-setup)
1. Optionally, follow the Terraform Setup-by-Step, which is essentially the same as following the automated tf-run.data
1. Initialize [Cluster Main](#initialize-cluster-main) directory
1. Create [policies](#policies)
1. Create [EC2 Keypair](#keypair-creation)
1. Finish [cluster setup](#cluster-creation)
1. Setup [aws-auth](#setup-aws-auth)
1. Setup [EFS](#setup-efs)
1. Setup [aws-auth](#setup-aws-auth)
1. Setup [EFS](#setup-efs)
1. Setup [Common Services](#common-services)
1. [Access to the cluster](#access-to-the-cluster)
1. [Cluster Setup](#cluster-setup)

## Post-Setup Tasks

Expand Down Expand Up @@ -56,38 +59,6 @@ For creating a service which uses load balancers (ELB, ALB, or NLB), the last ta
to the subnet(s) for load balancing. A separate set of subnets exist for load balacning, with a name including `private-lb`.


## Copy Variable Settings when in a submodule repo

We need the `variables.vpc.tf` and `variables.vpc.auto.tfvars` from the main repository. These are not to be modified in
this submodule.

```shell
cd MAIN-REPOSITORY
MAINTOP=$(git rev-parse --show-toplevel)
cd applications/{APPNAME}
cd vpc/{region}/vpc{number}
for f in $(ls $MAINTOP/vpc/{region}/vpc{number}/variables.vpc*)
do
cp $f ./
done
```

Replace {region} and {number} and {APPNAME} with the correct values.

## Copy includes.d when in a submodule repo

This makes a copy of the entire `MAIN/includes.d` structure in the submodule, for use as soft links to bring in
application variables for tagging.

```shell
cd MAIN-REPOSITORY
MAINTOP=$(git rev-parse --show-toplevel)
cd applications/{APPNAME}
rsync -avRWH $MAINTOP/./includes.d ./
```

Replace {APPNAME} with the correct value.

## Update the settings.auto.tfvars file

Set the appropriate values in the `settings.auto.tfvars` file. An example starter file is at `settings.auto.tfvars.example`.
Expand All @@ -108,7 +79,7 @@ cluster_version = "1.25"
region = "us-gov-east-1"
domain = "org-project-env.env.domain.census.gov"
eks_instance_disk_size = 40
eks_vpc_name = "*vpcshortname*"
eks_vpc_name = "vpc_full_name"
eks_instance_type = "t3.xlarge"
eks_ng_desire_size = 3
eks_ng_max_size = 15
Expand All @@ -121,7 +92,7 @@ You need to change these values:
These are tracked in the repo cloud-information/aws/documentation/containers/ (fix link).
* region: include the correct region. This really is a duplicate of the `region` variable, so it may be removed in the future.
* domain: this is the domain name of the clsuter, consisting of the cluster name and the proper domain name for the environment/VPC.
* eks_vpc_name: replace *vpcshortname* with the appropriate vpc name. This is used to find the vpc ID. This will be fixed at a later date.
* eks_vpc_name: replace *vpc_full_name* with the appropriate vpc full name. This is used to find the vpc ID.

All the others are subject to your configuration. They are a good starting point, but can vary.

Expand Down

0 comments on commit 491ae95

Please sign in to comment.