Skip to content

Latest commit

 

History

History
202 lines (144 loc) · 5.81 KB

INSTRUCTOR.md

File metadata and controls

202 lines (144 loc) · 5.81 KB
Raw

Gloo Mesh workshop

Prerequisites

Install terraform:

# Tested with terraform v0.15.4, v1.0.2
brew install terraform

Install ansible:

# Tested with ansible v2.11.1 / python 3.9.5
# Fails with ansible versions < 2.11
pip3 install ansible

Provide credentials for both AWS and GCP:

# Authenticate with GCP. The easiest way to do this is to run
gcloud auth application-default login
# Authenticate with AWS. The easiest way to do this is to run
aws configure

Configure region and zone for your remote resources:

# Create a file named configuration.auto.tfvars, you can use as template the one called configuration-example.auto.tfvars
# This step is optional, but if you don't do it it will use default values from terraform.tfvars
# Use this file to configure your desired resources too

Install aws-iam-authenticator if you are going to create eks clusters. This is because we use the module howdio/eks/aws, that have the authenticator as dependency. EKS auth is possible just with aws-cli, but the dependency is not very maintained.

When hosting the Livestorm workshop, it is recommeded to use Chrome browser.

Deploy

Go to the terraform directory:

cd terraform

Run the following command to initialize the working directory:

terraform init

Set your workspace:

terraform workspace list
terraform workspace select <workspace_name> || terraform workspace new <workspace_name>

Edit the configuration.auto.tfvars file to adapt it to your needs:

  • Add as many entries to environment as desired (or none). Every entry can be considered an isolated unit from the others
  • Inside an environment all parameters are optional, and default values are defined in the same file
  • Possible options:
  workshop1 = { # Prefix that will be shared in all objects
    # https://cloud.google.com/compute/docs/machine-types
    machine_type  = "n1-standard-8"
    # Zone where replicas will be created
    zone          = "europe-west4-d"
    # Replicas to deploy
    num_instances = 1
    source_machine_image = "workshop-generic-v20211019"
  }

**NOTE**  
If you only want to create the source vm image and not any replica, just set num_instances = 0. You can re-run terraform again later with a number and the source image step will be skipped. The generation of the source image is a SLOW process.

When the deployment is finished, you need to run the ansible script to deploy the prerequisites.

Load the lab ssh key:

NOTE
If you don't already have the lab private key available locally, retrieve it from the shared Google Drive that contains other workshop resources.

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_workshop

All solo.io enterprise products require a license key. If you'd like to preset limited-term keys on the student Virtual Machines, then set the LICENSE_KEY and GLOO_MESH_LICENSE_KEY and PORTAL_LICENSE_KEY environment variables on your workstation before running the ansible-playbook command.

export LICENSE_KEY=VeryLongKeyString
export GLOO_MESH_LICENSE_KEY=AnotherVeryLongKeyString
export PORTAL_LICENSE_KEY=AnotherVeryLongKeyString

Run the following command to deploy the Virtual Machines:

terraform apply -auto-approve

NOTE
Check TROUBLESHOOTING.md file in case you see errors

Manual provisioning

Create the ansible hosts file from the terraform output:

export env_name = <myname> # PUT HERE YOUR ENV NAME IN terraform.tfvars
echo "[hosts]" > hosts
terraform output -json | jq -r ".gce_replicas_public_ip.value.${env_name}[]" | while read ip; do echo $ip ansible_host=$ip ansible_user=solo >> hosts; done

Remove the SSH known hosts (optional, but recommended as Google Cloud reuses the same IP addresses quite often):

terraform output -json | jq -r '.gce_replicas_public_ip.value.${env_name}[]' | while read ip; do ssh-keygen -R $ip; done

Run the ansible playbook to apply all the prerequisites to the Virtual Machines.

ANSIBLE_HOST_KEY_CHECKING=False ansible-playbook -i ./hosts -f 30 -e ansible_python_interpreter=/usr/bin/python3 -e reboot_vm=true ansible-playbook.yml

Deliver

When you deliver the workshop, take the IP addresses from the hosts file and provide one to each student.

They simply need to access their Virtual Machine using http://<ip address>/guacamole/.

The user is solo and the password is Workshop1#

Test

From any workshop directory (gloo/federation, for example), you can run the following command to extract all the instructions from the README.md and run them:

cat README.md | ../../md-to-bash.sh | bash

It allows you to test that all the instructions are still working after you modify the README.md

Cleanup

Go to the terraform directory:

cd terraform

Run the following command to destroy all the replicas:

terraform destroy -target=module.vm-replica

Run the following command to destroy some replicas:

terraform destroy -target=module.vm-replica[\"myname\"]

Run the following command to destroy all the source images:

terraform destroy -target=module.vm-image

Run the following command to destroy all:

terraform destroy -force

Additional reference

You can use emoji's in GitHub markdown to signal additional callouts such as:

  • ℹ️ - Info
  • 📝 - Note
  • ⚠️ - Warning
  • 💡 - hint
  • ❌ - Error
  • ✔️ - Correct
  • ❓ - Question
  • 🚧 - WIP
  • 👀 - Be careful

You can use GitBook hints and callouts with the following types:

  • info
  • success
  • danger
  • warning