Skip to content

README.md

Latest commit

 

History

History
70 lines (45 loc) · 3.13 KB

README.md

File metadata and controls

70 lines (45 loc) · 3.13 KB

Stage 1

Stage 1 of the bootstrap procedure is responsible for setting up static resources for shared services in the Kubernetes cluster. These are self-contained resources that are common to any implementation regardless of the specific use-case, such as: CRDs, operators, classes, etc. Some of these resources are specific to the cloud-provider, if any, hosting the k8s cluster.

Dependencies

  • Stage 0 completed
  • Terraform CLI
  • Kubernetes configuration

Procedure

Define your Terraform backend

Add a backend.tf file in the stage1 directory and include your particular backend configuration. If you run bin/bootstrap-cloud the backend.tf should be automatically generated. For example AWS S3 backend configuration:

terraform {
  backend "s3" {
    bucket = "mybucket"
    key    = "path/to/my/key"
    region = "us-east-1"
  }
}

Tip

You can skip this step and Terraform by default will use a local state backend which stores the data in the current folder. This is an easy and good approach for local development or testing, but it doesn't scale easily for production environments.

Initialize Terraform

Initialize the stage 1 module by running the init command from stage1 directory:

terraform init

Make sure that terraform command completed successfully and there're no error reports in the terminal output.

Define Variable Values

Specify the correct values for the required stage1 variables by copying the env.auto.tfvars.example file to env.auto.tfvars and modifying the file.

The following variables are required:

  • k8s_context: The name of the k8s context as defined in the kube config file. This should match the context created during the stage0 setup of your k8s cluster. kubectl config get-contexts can be used to list the available contexts. Looking for a name that matches your k8s cluster (example: k3d-dmtr).
  • cloud_provider: A key to identify the cloud provider, if any, that is hosting the k8s cluster. This allows the script to install provider-specific requirements. Valid values are: aws, gcp, azure, k3d, kind.

Tip

There are other variables available that you can use to tailor the installation but they have reasonable defaults. Check the variables.tf file for the definition of each. If you want to override the default value, add the corresponding line to env.auto.tfvars specifying the adjusted value.

Tip

If you wish to commit your env.auto.tfvars file to git, you can create a .gitignore file in this directory containing !env.auto.tfvars which will remove the file from git's ignore list.

Apply Terraform

Apply the required changes for stage2 by running the apply command from stage2 directory.

terraform apply

The output will show you the planned changes before applying them. Answer 'yes' in the confirmation step to continue with the process.

The execution of the command might take a while depending on the specific cluster. Make sure that terraform command completed successfully and there're no error reports in the terminal output.

Next Steps

You're done with stage 1. You can continue with Stage 2