Add directory-specific README files

Add directory-specific README files following the reorganization into primary technology areas

Signed-off-by: Scott Lowe <scott.lowe@scottlowe.org>
This commit is contained in:
Scott Lowe 2017-02-23 18:04:15 -07:00
parent 9d9d81f711
commit 6515f139f3
No known key found for this signature in database
GPG key ID: 949F43F6E6C11780
11 changed files with 125 additions and 0 deletions

9
kvm/README.md Normal file
View file

@ -0,0 +1,9 @@
# Learning Tools: KVM
The contents of this folder are targeted toward increasing knowledge and understanding of KVM.
## Contents
**kvm-generic**: 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.
**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.

13
lxc-lxd/README.md Normal file
View file

@ -0,0 +1,13 @@
# Learning Tools: LXC/LXD
Here are found Vagrant environments and other tools/resources for working with and learning more about LXC and LXD.
## Contents
**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.
**lxd-ansible**: 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. The provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host.
**lxd-ovs**: Use the `Vagrantfile` and other files in this directory to work with LXD and Open vSwitch (OVS) 2.3.1 on Ubuntu 14.04. Use the instructions from the `lxd` directory to set up containers and container images. The provisioning is handled via shell scripts.
**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.

7
netos/README.md Normal file
View file

@ -0,0 +1,7 @@
# Learning Tools: Network Operating Systems
This folder contains Vagrant environments and other resources for learning more about various network operating systems, such as JunOS, Arista EOS, Cumulus, or others.
## Contents
**junos**: _This is a placeholder for future work._

9
openstack/README.md Normal file
View file

@ -0,0 +1,9 @@
# Learning Tools: OpenStack
This folder contains tools, resources, and environments for learning more about OpenStack.
## Contents
**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.
**swarm-consul**: This folder contains files to create a Consul-backed Docker Swarm cluster on OpenStack. _THIS ENVIRONMENT IS NOT YET FULLY FUNCTIONAL._

15
ovs-ovn/README.md Normal file
View file

@ -0,0 +1,15 @@
# Learning Tools: Open vSwitch (OVS) and Open Virtual Network (OVN)
This folder contains tools, resources, and environments for experimenting with and learning more about Open vSwitch (OVS) and Open Virtual Network (OVN).
## Contents
**ovn**: This directory contains a Vagrant environment for working with Open Virtual Network (OVN).
**ovn-docker-ansible**: _This is a placeholder for future work._
**ovn-kvm**: This folder contains a Vagrant environment for spinning up OVN and using it with KVM-based virtual machines.
**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.

11
photon/README.md Normal file
View file

@ -0,0 +1,11 @@
# Learning Tools: VMware Photon OS
This folder contains tools, resources, and environments designed around VMware's Photon OS Linux distribution.
## Contents
**photon-ansible**: In this folder is a Vagrant environment for using Ansible with VMware Photon; specifically, for using Ansible to configure Photon's pre-installed Docker daemon to listen over a network socket. Naturally, the provisioning is handled via Ansible (pre-2.0) installed on the Vagrant host.
**photon-cloudinit**: This folder contains the files to spin up VMs, using Vagrant and customized via `cloud-init`, running the VMware Photon Technical Preview. The provisioning is handled via shell scripts.
**photon-generic**: This folder contains the files to spin up an instance of the VMware Photon Technical Preview using Vagrant. No custom provisioning is provided in this environment.

7
rkt/README.md Normal file
View file

@ -0,0 +1,7 @@
# Learning Tools: rkt ("Rocket") Container Runtime
This folder contains tools, resources, and environments for working with `rkt`, the CoreOS container runtime.
## Contents
**rkt-ubuntu**: This folder contains the files to work with `rkt` (version 1.4.0), the CoreOS implementation of the App Container (appc) specification, on Ubuntu 14.04. Provisioning is handled by Vagrant's file and shell provisioners.

9
ssh/README.md Normal file
View file

@ -0,0 +1,9 @@
# Learning Tools: SSH
This folder contains tools, resources, and environments that are intended to help build understanding of Secure Shell (SSH), a key component in many Linux/UNIX environments.
## Contents
**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.

9
terraform/README.md Normal file
View file

@ -0,0 +1,9 @@
# Learning Tools: Terraform
This folder contains materials for working with Terraform.
## Contents
**tf-general:** This directory provides an example Terraform configuration (in both Terraform format as well as JSON format) designed to work with OpenStack.
**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.

7
ubuntu/README.md Normal file
View file

@ -0,0 +1,7 @@
# Learning Tools: Ubuntu Linux
This folder contains materials for learning more about Ubuntu Linux.
## Contents
**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.

29
vagrant/README.md Normal file
View file

@ -0,0 +1,29 @@
# Learning Tools: Vagrant
This folder contains materials for learning more about how to use Vagrant. This includes various `Vagrantfile` examples with different data formats and structures. Examples of working with various providers are also found here.
## Contents
**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.
**aws-multi**: Like "vagrant-aws", but for spinning up multiple instances on AWS.
**complex-json**: This folder contains files that illustrate how to use a "complex" JSON file as an external data source for a `Vagrantfile`.
**complex-yaml**: This folder contains files that illustrate how to use "complex" YAML files in a `Vagrantfile`.
**docker**: In this folder you'll find `Vagrantfiles` and supporting documents for using the Docker provider in Vagrant to turn up Docker containers. The provisioning is handled by Vagrant's built-in Docker provisioner.
**docker-json**: Like `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.
**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.
**json**: The files in this folder illustrate the use of an external JSON data file to drive Vagrant.
**multi-platform**: This Vagrant environment demonstrates one possible way to create a `Vagrantfile` that supports multiple virtualization platforms without any edits needed across platforms.
**multi-provider**: The `Vagrantfile` and supporting documents in this folder show how to build Vagrant environments to support multiple back-end providers.
**openstack**: This folder contains a `Vagrantfile` and supporting files for using Vagrant with the OpenStack provider. This allows you to use Vagrant to provision and destroy an instance in an OpenStack cloud.
**openstack-multi**: This folder is similar to `vagrant/openstack`, but supports Vagrant operations on multiple instances.