# S-DOEA - Workshop 4 - Terraform and Ansible ## Pre-requisites * Digital Ocean Account ## Terraform (a) ### Objective The objective of this workshop is use Terraform's HCL to write scripts to provision Docker containers and a reverse proxy. ### Setup For this workshop create a directory call workshop01 in the repository you have create in step a. above. All the files for this workshop should be created in workshop01 directory. ### Workshop In this workshop you will automate the provisioning of the following infrastructure shown in the following diagram. ![Terraform Architecture](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/terraform-1.png) The infrastructure stack consists of: 1. Docker network called bgg-net 2. Container running MySQL database (bgg-database) inside bgg-net 3. A specified number of containers running a Nodejs application (bgg-backend). These web applications connect to MySQL database. These applications are also provisioned inside bgg-net 4. An instance of Nginx running on a separate server which routes traffic to the bgg-backend instances. The following are detail description of provisioning each of the resource in the stack. ### Network (bgg-net) - Create a Docker network called bgg-net. This network will be used for all the containers in our application. ### Database (bgg-database) - Provision a Docker volume to be used by the database. - Use the image chukmunnlee/bgg-database:v3.1 to create the bgg-database container - Mount the Docker volume that you have created under /var/lib/mysql. The database will be created in this volume rather that inside the container - Expose MySQL port 3306 - The database should be created inside bgg-net network ### Application (bgg-backend) - Create 3 instances of the application using the following image: chukmunnlee/bgg-backend:v3 - Add the following environment variables: - BGG_DB_USER set to root - BGG_DB_PASSWORD set to changeit - BGG_DB_HOST set to the application database resource name - The internal port of the application is 3000. Choose a suitable external port to port bind to ### Nginx Reverse Proxy - Provision a Ubuntu server. Use Ubuntu 20.04 x64 - Add a SSH key to the server so you can SSH into the server - Install Nginx and enable the service with the following commands: - /usr/bin/apt update -y - /usr/bin/apt upgrade -y - /usr/bin/apt install nginx -y - /usr/bin/systemctl start nginx - /usr/bin/systemctl enable nginx - Create a Nginx configuration file called nginx.conf with the container endpoints. Use the following template: ```nginx user www-data; worker_processes auto; pid /run/nginx.pid; events { worker_connections 768; } http: { access_log /var/log/nginx/access.log; error_log /var/log/nginx/error.log; gzip on; upstream apps { least_conn; # the following list the container endpoints # one server line for each endpoint # eg server :; server docker_host_ip:exposed_port_0; server docker_host_ip:exposed_port_1; server docker_host_ip:exposed_port_2; } server { listen 80; location / { proxy_pass http://apps; } } } ``` > **Hint:** this configuration file should be generated from the bgg-backend external ports - Replace the /etc/nginx/nginx.conf on the reverse proxy with your nginx.conf. - Signal Nginx to reload the new configuration with the following command: - /usr/sbin/nginx -s reload, or - /usr/bin/systemctl restart nginx ### Outputs Your Terraform script should produce the following artefacts and outputs: - Reverse proxy IP address - List of all the container endpoint in the following format `:` - An empty file call `root@` ### Test Test your deployment by browsing to `http://`. You should see the following: ![Terraform Result](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/terraform-2.png) ### Submission When you have completed this workshop, commit your work to the repository. The instructor will clone your repository at the end. ## Solution 1. Access your Digital Ocean account. 2. Create a Ubuntu Droplet ![Ansible Setup 1](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible11.png) - Select Singapore as region - Select Ubuntu as the server Image v22.04 x64 ![Ansible Setup 2](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible122.png) - Select cost saving server type (6 USD) ![Ansible Setup 3](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible13.png) - Choose the SSH authentication method and generate a fresh SSH key pair. Click the "New SSH Key" button, then follow the instructions provided on the right-hand side. Paste the contents of the "cat" command into the Digital Ocean text area. ![Ansible Setup 4](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible14.png) - Finalize the droplet ![Ansible Setup 5](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible15.png) 3. Access the newly created ubuntu server ```bash ssh root@ ``` ![Ansible Setup 6](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible16.png) 4. Generate the PKI key pair on the logon server ```bash ssh-keygen ``` ![Ansible Setup 7](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible17.png) 5. Add the public key content to the Digital Ocean account security section, name it as www-1 ![Ansible Setup 8](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible18.png) ![Ansible Setup 9](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible19.png) 6. Install terraform IAC tool on the ubuntu server ```bash sudo apt update ``` ```bash sudo apt install snap ``` ```bash sudo snap install terraform --classic ``` 7. Check the terraform version ```bash terraform --version ``` ![Ansible Setup 10](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible22.png) 8. Install Docker engine, given an instructions use the - Install using the Apt repository method https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository 9. Retrieve a DO API KEY from the Digital ocean platform. Set the environment variable of your DO API key to the ubuntu server using the following command ```bash export DO_PAT= ``` ![Ansible Setup 11](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible23.png) ![Ansible Setup 12](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible24.png) 10. Install docker machine binary To download and install the Docker Machine binary, type: ```bash curl -O "https://gitlab-docker-machine-downloads.s3.amazonaws.com/v0.16.2-gitlab.40/docker-machine-Linux-x86_64" ``` The name of the file should be docker-machine-Linux-x86_64. Rename it to docker-machine to make it easier to work with: ```bash mv docker-machine-Linux-x86_64 docker-machine ``` Change the file permission to executable: ```bash chmod +x docker-machine ``` Move or copy it to the usr/local/bin directory so that it will be available as a system command. ```bash sudo mv docker-machine /usr/local/bin ``` Check the version, which will indicate that it's properly installed: ```bash docker-machine version ``` 11. Create a docker machine within your DO account with following command ```bash docker-machine create \ -d digitalocean \ --digitalocean-access-token \ --digitalocean-image ubuntu-24-04-x64 \ --digitalocean-region sgp1 \ --digitalocean-backups=false \ docker-nginx ``` ![Ansible Setup 13](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible25.png) 12. Create a working directory for the following terraform project. 13. Create provider script (provider.tf) for the provisioning of the DO servers ```hcl terraform { required_providers { docker = { source = "kreuzwerker/docker" version = ">=3.0.2" } digitalocean = { source = "digitalocean/digitalocean" version = "2.26.0" } local = { source = "hashicorp/local" version = "2.4.0" } } } provider docker { # host = "unix:///var/run/docker.sock" host = "tcp://${var.docker_host}:2376" cert_path = var.docker_cert_path } provider digitalocean { token = var.do_token } provider local { } ``` 14. Create the variable script (variables.tf) ```hcl variable do_token { type = string sensitive = true } variable docker_host { type = string } variable docker_cert_path { type = string sensitive = true } variable app_namespace { type = string default = "my" } variable database_version { type = string default = "v3.1" } variable backend_version { type = string default = "v3" } variable backend_instance_count{ type = number default = 3 } variable do_region { type = string default = "sgp1" } variable do_image { type = string default = "ubuntu-24-04-x64" } variable do_size { type = string default = "s-1vcpu-512mb-10gb" } variable do_ssh_key { type = string default = "www-1" } variable ssh_private_key { type = string } ``` 15. Create the resources script (resources.tf) ```hcl # images resource "docker_image" "bgg-database" { name = "chukmunnlee/bgg-database:${var.database_version}" } resource "docker_image" "bgg-backend" { name = "chukmunnlee/bgg-backend:${var.backend_version}" } # the stack resource "docker_network" "bgg-net" { name = "${var.app_namespace}-bgg-net" } resource "docker_volume" "data-vol" { name = "${var.app_namespace}-data-vol" } resource "docker_container" "bgg-database" { name = "${var.app_namespace}-bgg-database" image = docker_image.bgg-database.image_id networks_advanced { name = docker_network.bgg-net.id } volumes { volume_name = docker_volume.data-vol.name container_path = "/var/lib/mysql" } ports { internal = 3306 external = 3306 } } resource "docker_container" "bgg-backend" { count = var.backend_instance_count name = "${var.app_namespace}-bgg-backend-${count.index}" image = docker_image.bgg-backend.image_id networks_advanced { name = docker_network.bgg-net.id } env = [ "BGG_DB_USER=root", "BGG_DB_PASSWORD=changeit", "BGG_DB_HOST=${docker_container.bgg-database.name}", ] ports { internal = 3000 } } resource "local_file" "nginx-conf" { filename = "nginx.conf" content = templatefile("sample.nginx.conf.tftpl", { docker_host = var.docker_host, ports = docker_container.bgg-backend[*].ports[0].external }) } data "digitalocean_ssh_key" "www-1" { name = var.do_ssh_key } resource "digitalocean_droplet" "nginx" { name = "nginx" image = var.do_image region = var.do_region size = var.do_size ssh_keys = [ data.digitalocean_ssh_key.www-1.id ] connection { type = "ssh" user = "root" private_key = file(var.ssh_private_key) host = self.ipv4_address } provisioner "remote-exec" { inline = [ "apt update -y", "apt install nginx -y", ] } provisioner "file" { source = local_file.nginx-conf.filename destination = "/etc/nginx/nginx.conf" } provisioner "remote-exec" { inline = [ "systemctl restart nginx", "systemctl enable nginx", ] } } resource "local_file" "root_at_nginx" { filename = "root@${digitalocean_droplet.nginx.ipv4_address}" content = "" file_permission = "0444" } output nginx_ip { value = digitalocean_droplet.nginx.ipv4_address } output backend_ports { value = docker_container.bgg-backend[*].ports[0].external } ``` 16. Create the template configuration for the nginx reverse proxy server (sample.nginx.conf.tftpl) ```nginx user www-data; worker_processes auto; pid /run/nginx.pid; events { worker_connections 768; } http { access_log /var/log/nginx/access.log; error_log /var/log/nginx/error.log; gzip on; upstream apps { least_conn; # the following list the container endpoints # one server line for each endpoint # eg server :; %{~ for p in ports ~} server ${docker_host}:${p}; %{~ endfor ~} } server { listen 80; location / { proxy_pass http://apps; } } } ``` 17. Under the current working directory perform initialization on the scripts that was created previously. ```bash terraform init ``` 18. Take note before running the following provision command using terraform tools against DO server. The DO_PAT environment variable must be setup upfront. Replace the docker host ip with the docker-nginx public IP address. ```bash export DO_PAT= ``` ```bash terraform plan -var "do_token=${DO_PAT}" -var "ssh_private_key=/root/.ssh/id_rsa" -var "docker_host=" -var "docker_cert_path=/root/.docker/machine/machines/docker-nginx" ``` 19. Once the provision plan is done, apply the changes to the DO cloud account using the following command. Replace the docker host ip with the docker-nginx public IP address. ```bash terraform apply -auto-approve -var "do_token=${DO_PAT}" -var "ssh_private_key=/root/.ssh/id_rsa" -var "docker_host=" -var "docker_cert_path=/root/.docker/machine/machines/docker-nginx" ``` ![Ansible Setup 14](https://raw.githubusercontent.com/kenken64/NUSISS-DevSecOpsEng/master/workshop/screens/ansible26.png) ## Optional workshop Consider installing these tools to help you estimate cloud costs. https://www.infracost.io/docs/#quick-start

Unit Testing

Workshops