diff --git a/README.md b/README.md index ab528cc..5a0c391 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Terraform-Ansible-Helm Deployer [![Super-Linter](https://github.com/doddophonique/tah-deploy/actions/workflows/super-linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter) ## Usage -Everything can be done from the `terraform/` folder: +From the `terraform/` folder: ``` $ terraform init $ terraform plan @@ -10,7 +10,7 @@ $ terraform apply ## Decisions and goals The `terraform-provider-libvirt` has been chosen over Vagrant to deploy the VMs as a way to simplify the structure of the project. The choice over a cloud provider such as AWS or GCP has been done to not incur into billing cost during troubleshooting and deployments. - +### Terraform script The Terraform script roughly follows these steps: 1. Deploy 3 VMs (one master and two workers) with: - 2 vCPUs; @@ -25,10 +25,10 @@ The Terraform script roughly follows these steps: 3. Create the `kiratech-test` namespace; 4. Run the CIS Kubernetes benchmark; 5. Copy the helm folder to the master node and install helm. - +### Next steps The script currently lacks: - 1. Capability of deploying an Helm application; - 2. Usage of Terraform outputs to populate Ansible files; + - [] Capability of deploying an Helm application; + - [] Usage of Terraform outputs to populate Ansible files; ### CIS Kubernetes Benchmark The CIS Benchamrk is one of (if not the) most popular benchmarks publicly available, and also has a simple way to implement it in a deployment pipeline using the [kube-bench](https://github.com/aquasecurity/kube-bench) implementation.