From 1fbc1d71c9eb26b692bb1fcabaefa4686ab8b140 Mon Sep 17 00:00:00 2001 From: "Scott S. Lowe" Date: Tue, 25 Oct 2016 23:36:35 -0600 Subject: [PATCH] Update main README.md Update main repository README file to include new environments and tools that had been added but were not reflected in the READE. Signed-off-by: Scott S. Lowe --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 05aae47..5dcbf24 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ This repository contains a variety of files and tools for learning new technolog ## Contents +**ansible-aws**: This set of files shows how to use Ansible to both provision infrastructure on AWS as well as how to decommission (tear down) that same infrastructure. + +**complex-yaml**: This folder contains files that illustrate how to use "complex" YAML files in a `Vagrantfile`. + **consul-ansible**: In this folder you'll find a `Vagrantfile` and supporting documents to run a Consul cluster under Vagrant on your local laptop. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host. **consul**: In this folder you'll find a `Vagrantfile` and supporting documents to run a Consul cluster under Vagrant on your local laptop. The provisioning is handled via shell scripts. @@ -30,10 +34,10 @@ This repository contains a variety of files and tools for learning new technolog **ipvs-docker**: Use this learning environment to experiment with using IPVS/LVS for load balancing Docker containers. -**kvm-macvtap**: This learning environment has a `Vagrantfile` and supporting files for working with KVM and macvtap interfaces on Ubuntu 14.04. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host. - **junos**: _This is a placeholder for future work._ +**kvm-macvtap**: This learning environment has a `Vagrantfile` and supporting files for working with KVM and macvtap interfaces on Ubuntu 14.04. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host. + **kvm**: The files in this folder allow you to create a learning environment for working with KVM and Libvirt on Ubuntu 14.04. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host. **lxc**: This folder holds a `Vagrantfile` and supporting files to create an environment for working with LXC (pronounced "lex-see"). LXC is a set of tools for working with OS containers. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host. @@ -44,8 +48,16 @@ This repository contains a variety of files and tools for learning new technolog **lxd-shell**: In this folder you'll find a `Vagrantfile`, instructions, and other files to help work with LXD (pronounced "lex-dee"), a new daemon and CLI for working with LXC-based OS containers. For this environment, the provisioning is handled via shell scripts. +**multi-provider-simple**: The `Vagrantfile` and supporting documents in this folder show how to build Vagrant environments to support multiple back-end providers. + **openstack-cli**: This folder contains the files for a Vagrant environment that spins up an Ubuntu box with all the OpenStack CLI clients pre-installed. The provisioning is handled via shell scripts. +**ovn**: _This is a placeholder for future work._ + +**ovn-docker-ansible**: _This is a placeholder for future work._ + +**ovs-cl-vtep**: _This is a placeholder for future work._ + **ovs-geneve**: This folder contains a Vagrant environment and supporting files for compiling Open vSwitch (OVS) from source and using Geneve tunneling to connect network namespaces on two different VMs. **ovs-multi-br**: In this folder is a Vagrant environment, Ansible playbook, and related data files for experimenting with multiple Open vSwitch (OVS) bridges. @@ -62,16 +74,22 @@ This repository contains a variety of files and tools for learning new technolog **ssh-bastion**: In this folder is a Vagrant environment, leveraging multiple VMs, that allow you to work with SSH multiplexing via an SSH bastion host. The provisioning is handled by Vagrant's file and shell provisioners. +**ssh-bastion-ansible**: In this folder is a Vagrant environment, leveraging multiple VMs, that allow you to work with SSH multiplexing via an SSH bastion host. The provisioning is handled by Ansible 2.x. + **swarm-consul-openstack**: This folder contains files to create a Consul-backed Docker Swarm cluster on OpenStack. _THIS ENVIRONMENT IS NOT YET FULLY FUNCTIONAL._ **swarm-etcd2-photon:** This folder contains a Vagrant environment and associated support files to turn up an etcd-backed Docker Swarm cluster where the Docker Engine instances are running on VMware Photon. Provisioning is handled by Ansible 2.x. **terraform:** This directory provides an example Terraform configuration (in both Terraform format as well as JSON format) designed to work with OpenStack. +**terraform-aws**: This directory contains a number of different examples of using Terraform with AWS. Refer to the `README.md` in this folder for more details. + **ubuntu-generic**: This folder contains a Vagrant environment for spinning up a generic 64-bit Ubuntu 14.04 VM. Note there's nothing special going on here---just a plain, generic, Ubuntu VM. No custom provisioning is provided in this environment. **vagrant-aws**: This folder contains a `Vagrantfile` and supporting files for using Vagrant to spin up an instance on AWS. This allows you to use Vagrant to spin up and destroy an instance on AWS. +**vagrant-aws-multi**: Like "vagrant-aws", but for spinning up multiple instances on AWS. + **vagrant-docker-json**: Like `vagrant-docker-yaml`, this folder is an extension of "vagrant-docker" in that it provides the ability to specify, in an external JSON file, a list of Docker containers to be instantiated by Vagrant. The provisioning is handled by Vagrant's built-in Docker provisioner. **vagrant-docker-yaml**: This folder is an extension of "vagrant-docker" in that it provides the ability to specify the list of Docker containers that Vagrant will create in a separate YAML file. The provisioning is handled by Vagrant's built-in Docker provisioner.