Skip to content

Latest commit

 

History

History
 
 

provisioner

README.md

Ansible AWS training provisioner

The github.com/ansible/workshops contains an Ansible Playbook provision_lab.yml, which is an automated lab setup for Ansible training on AWS (Amazon Web Services). Set the workshop_type variable below to provision the corresponding workshop.

Workshop Workshop Type Var
Ansible for Red Hat Enterprise Linux Workshop workshop_type: rhel
Ansible for Red Hat Enterprise Linux Workshop - 90 minutes workshop_type: rhel_90
Ansible Network Automation Workshop workshop_type: network
Ansible F5 Workshop workshop_type: f5
Ansible Security Automation workshop_type: security
Ansible Windows Automation workshop_type: windows
Ansible Demo Mode workshop_type: demo

Table Of Contents

Requirements

  • This provisioner must be run with Ansible Engine v2.8.0 or higher.
  • AWS Account (follow directions on one time setup below)

Lab Setup

One Time Setup

For One Time Setup - click here

Setup (per workshop)

  1. Define the following variables in a file passed in using -e @extra_vars.yml
---
# region where the nodes will live
ec2_region: us-east-1

# name prefix for all the VMs
ec2_name_prefix: TESTWORKSHOP

# creates student_total of workbenches for the workshop
student_total: 2

# Set the right workshop type, like network, rhel or f5 (see above)
workshop_type: rhel

#####OPTIONAL VARIABLES

# turn DNS on for control nodes, and set to type in valid_dns_type
dns_type: aws

# password for Ansible control node
admin_password: your_password123

# creates AWS S3 website for ec2_name_prefix.workshop_dns_zone
# this is defaulted to on as of May 13th, 2020
create_login_page: false

# Sets the Route53 DNS zone to use for the S3 website
workshop_dns_zone: rhdemo.io

# automatically installs Tower to control node
towerinstall: true

# IBM Community Grid - defaults to true if you don't tell the provisioner
ibm_community_grid: false

If you want to license it you must copy a license called tower_license.json into this directory. If you do not have a license already please request one using the Workshop License Link.

For more extra_vars examples, look at the following:

  1. Run the playbook:

     ansible-playbook provision_lab.yml -e @extra_vars.yml

  2. Login to the AWS EC2 console and you will see instances being created. For example:

     `tesworkshop-student1-ansible`

Accessing student documentation and slides

  • Exercises and instructor slides are hosted at http://ansible.github.io/workshops

  • Workbench information is stored in two places after you provision:

    1. in a local directory named after the workshop (e.g. testworkshop/instructor_inventory)

    2. By default there will be a website ec2_name_prefix.workshop_dns_zone (e.g. testworkshop.rhdemo.io)

      • NOTE: It is possible to change the DNS domain (right now this is only supported via a AWS Route 53 Hosted Zone) using the parameter workshop_dns_zone in your extra_vars.yml file.

      • NOTE: The playbook does not create the route53 zone and must exist prior to running the playbook.

DNS

The provisioner currently supports creating DNS records per control node with valid SSL certs using Lets Encrypt. Right now DNS is only supported via AWS Route 53, however we are building it in a way that this can be more pluggable and take advantage of other public clouds.

This means that each student workbench will get an individual DNS entry. For example a DNS name will look like this: https://student1.testworkshop.rhdemo.io

  • NOTE: The variable dns_type defaults to aws. This can also be set to dns_type: none.

  • NOTE: If Lets Encrypt fails, the workshop provisioner will still pass, and alert you of errors in the summary_information at the end of the provision_lab.yml Ansible Playbook.

Lab Teardown

The teardown_lab.yml playbook deletes all the training instances as well as local inventory files.

To destroy all the EC2 instances after training is complete:

  1. Run the playbook:

     ansible-playbook teardown_lab.yml -e @extra_vars.yml

  2. Optionally you can enable verbose debug output of the information gathered that drives the teardown process by passing the extra optional variable debug_teardown=true. Example:

     ansible-playbook teardown_lab.yml -e @extra_vars.yml -e debug_teardown=true

Demos

There is a variable you can pass in within your extra_vars named demo. When this keyword is defined it will install the specified demo from the Github repository https://github.com/ansible/product-demos.

For example you can put:

demo: all

Which will install all demos onto the Ansible Tower instance. Not all demos will work on any workshop_type. Please refer to the Demo repository list.

FAQ

For frequently asked questions see the FAQ

More info on what is happening

The provision_lab.yml playbook creates a work bench for each student, configures them for password authentication, and creates an inventory file for each user with their IPs and credentials. An instructor inventory file is also created in the current directory which will let the instructor access the nodes of any student. This file will be called instructor_inventory.txt

What does the AWS provisioner take care of automatically?

  • AWS VPC creation (Amazon WebServices Virtual Private Cloud)
  • Creation of an SSH key pair (stored at ./WORKSHOPNAME/WORKSHOPNAME-private.pem)
  • Creation of a AWS EC2 security group
  • Creation of a subnet for the VPC
  • Creation of an internet gateway for the VPC
  • Creation of route table for VPC (for reachability from internet)

Getting Help

Please file issues on Github. Please fill out all required information. Your issue will be closed if you skip required information in the Github issues template.