nginx-ansible-demo
nginx-ansible-demo copied to clipboard
Demo showcasing how NGINX is better with Ansible
NGINX: Better with Ansible Demo
Overview
This demo uses Terraform to set up four instances on AWS and then provides a series of Ansible playbooks to install NGINX Plus, configure an NGINX Plus reverse proxy load balancing between a couple NGINX Plus web servers, and install NGINX App Protect and configure NGINX App Protect to secure the NGINX Plus reverse proxy.
A PDF containing accompanying slides for this demo can also be found under the name of NGINX Better with Ansible.pdf
.
Requirements
Terraform
This demo has been developed and tested with Terraform 1.3
.
Instructions on how to install Terraform can be found in the Terraform website.
Ansible
This demo has been developed and tested with Ansible 2.12
through 2.15
.
Instructions on how to install Ansible can be found in the Ansible website.
You will also need to download the latest Ansible NGINX collection and the latest Ansible AWS collection. To install the latest versions, you can use:
ansible-galaxy install -f -r ansible/requirements.yml
Finally, in order to use the amazon.aws
collection, you will need to install the boto3
and botocore
Python packages.
NGINX Plus (Optional)
If you wish to deploy the more advanced version of this demo, you will need to download an NGINX Plus and NGINX App Protect license from your MyF5 portal before you run this script. Alternatively, a simplified NGINX Open Source version of the demo is also available.
Deployment
To use the provided Terraform scripts, you need to:
- Export your AWS credentials as environment variables (or alternatively, tweak the AWS provider in
terraform/provider.tf
). - Set up default values for variables missing a value in
terraform/variables.tf
(you can find example values commented out in the file). Alternatively, you can input those variables at runtime (beware of dictionary values if you do the latter).
Once you have configured your Terraform environment, you can either:
- Run
./setup.sh
to initialize the AWS Terraform provider and start a Terraform deployment on AWS:
./setup.sh
- Run
terraform init
andterraform apply
cd terraform && terraform init && terraform apply -auto-approve
And finally, once you are done playing with the demo, you can destroy the AWS infrastructure by either:
- Run
./cleanup.sh
to destroy your Terraform deployment:
./destroy.sh
- Run
terraform destroy
:
cd terraform && terraform destroy -auto-approve && rm -f terraform.tfstate terraform.tfstate.backup && rm -rf .terraform
Demo Overview
You will find a series of Ansible playbooks in the ansible
folder. There are two versions of playbook one. One installs NGINX Plus whilst the other installs NGINX Open Source. You will have to deploy playbook one, 1-deploy-nginx.yml
, before you attempt to deploy any other playbooks. Playbooks two through four can be deployed in any order, albeit the recommended order gradually configures a more advanced NGINX environment. Do note that if you decide to install NGINX Open Source, you will not be able to deploy playbooks four and five. If you are running the NGINX Plus playbook, you can either tweak the nginx_license
variable in playbook one itself, or pass the variable at runtime using Ansible's extra vars (--extra-vars
/-e
) CLI command.
To execute a playbook, run:
ansible-playbook --private-key=</path/to/key> -i ansible/aws-ec2.yml ansible/1-deploy-nginx.yml
This demo includes the following playbooks:
Name | Description |
---|---|
0-check-platform.yml |
Check that all platforms have been deployed correctly by Terraform |
1-deploy-nginx.yml |
Deploy NGINX Plus |
1-deploy-nginx-oss.yml |
Deploy NGINX Open Source |
2-deploy-nginx-web-server.yml |
Deploy an NGINX Plus web server |
3-deploy-nginx-web-server-proxy.yml |
Deploy an NGINX Plus reverse proxy load balancing between two NGINX Plus web servers |
4-deploy-nginx-app-protect-web-server-proxy.yml |
Deploy an NGINX Plus reverse proxy load balancing between two NGINX Plus web servers protected by NGINX App Protect |
5-check-app-protect.yml |
Check that NGINX App Protect is working as expected |