From 6db1e636d0c46e68b583d9d6141eb64dfb62cd07 Mon Sep 17 00:00:00 2001 From: Scott Lowe Date: Sat, 13 Jul 2019 08:03:36 -0600 Subject: [PATCH] Update documentation Update documentation in various directories. Add missing documentation to some environments. Fix typos in some documentation. Signed-off-by: Scott Lowe --- docker/README.md | 8 ++++++++ fedora-atomic/README.md | 9 ++++++++ kubernetes/README.md | 7 +++++++ ovs-ovn/README.md | 2 ++ ovs-ovn/ovs-simple/README.md | 33 ++++++++++++++++++++++++++++++ ovs-ovn/ovs-simple/provision.retry | 1 - traefik/README.md | 2 +- vagrant/README.md | 4 +++- 8 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 fedora-atomic/README.md create mode 100644 kubernetes/README.md create mode 100644 ovs-ovn/ovs-simple/README.md delete mode 100644 ovs-ovn/ovs-simple/provision.retry diff --git a/docker/README.md b/docker/README.md index 9abd1e7..4bb425f 100644 --- a/docker/README.md +++ b/docker/README.md @@ -4,8 +4,14 @@ Here you'll find a collection of tools and resources for learning about (or expe ## Contents +**atomic-swarm-mode**: Here is a learning environment and instructions for manually building a Docker Swarm cluster on CentOS Atomic Host. + **containerd-runc**: _This is a placeholder for future work._ +**coreos-swarm-mode**: Here is a learning environment and instructions for manually building a Docker Swarm cluster on CoreOS Container Linux. + +**docker-ce-edge**: This folder is for quickly turning up a learning environment running the "Edge" release of Docker CE. + **ipvlan-l2**: This folder has files to create a learning environment for using ipvlan interfaces with Docker containers. **ipvlan-l3**: This folder has files to create a learning environment for using ipvlan L3 interfaces with Docker containers. @@ -21,3 +27,5 @@ Here you'll find a collection of tools and resources for learning about (or expe **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. **swarm-ha**: This folder holds a `Vagrantfile`, supporting files, and instructions for turning up a Consul-backed Docker Swarm cluster with multiple Swarm managers for high availability. The provisioning is handled via shell scripts. + +**ubuntu-Swarm-mode**: In this folder is a learning environment that uses Vagrant and Ansible to establish a Swarm mode cluster on Ubuntu. diff --git a/fedora-atomic/README.md b/fedora-atomic/README.md new file mode 100644 index 0000000..be1f340 --- /dev/null +++ b/fedora-atomic/README.md @@ -0,0 +1,9 @@ +# Learning Tools: Fedora Atomic Host + +Here you'll find Vagrant environments and other resources for learning more about Fedora Atomic Host. + +## Contents + +**26-atomic-generic**: This folder has a Vagrant environment for spinning up a generic VM instance of Fedora 26 Atomic Host. No custom provisioning is provided in this environment. + +**27-atomic-generic**: This folder has a Vagrant environment for spinning up a generic VM instance of Fedora 27 Atomic Host. No custom provisioning is provided in this environment. diff --git a/kubernetes/README.md b/kubernetes/README.md new file mode 100644 index 0000000..0fe8ab6 --- /dev/null +++ b/kubernetes/README.md @@ -0,0 +1,7 @@ +# Learning Tools: Kubernetes + +The contents of this folder are targeted toward increasing knowledge and understanding of Kubernetes. + +## Contents + +**kubeadm-vagrant**: The files in this folder focus on the use of Vagrant and Ansible to establish an environment for users to experiment with using `kubeadm` to bootstrap a Kubernetes cluster. diff --git a/ovs-ovn/README.md b/ovs-ovn/README.md index c0a6bcc..3a1b70d 100644 --- a/ovs-ovn/README.md +++ b/ovs-ovn/README.md @@ -13,3 +13,5 @@ This folder contains tools, resources, and environments for experimenting with a **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. + +**ovs-simple**: This environment uses Vagrant and Ansible to provision an Ubuntu 16.04 VM with Open vSwitch and a single OVS bridge. Users could use this environment as a building block for more complex environments. diff --git a/ovs-ovn/ovs-simple/README.md b/ovs-ovn/ovs-simple/README.md new file mode 100644 index 0000000..e63d4e5 --- /dev/null +++ b/ovs-ovn/ovs-simple/README.md @@ -0,0 +1,33 @@ +# Simple Open vSwitch (OVS) Environment + +These files were created to allow users to use Vagrant ([http://www.vagrantup.com](http://www.vagrantup.com)) to quickly and easily spin up an environment to test Open vSwitch (OVS). + +## Contents + +* **ansible.cfg**: This is an Ansible configuration file that instructs Ansible to use the "vagrant" remote user, and to use Vagrant's built-in Ansible inventory. + +* **machines.yml**: This YAML file contains a list of VM definitions and associated configuration data. It is referenced by `Vagrantfile` when Vagrant instantiates the VMs. + +* **provision.yml**: This Ansible playbook installs the OVS/OVN components on each Vagrant machine. It's called automatically by Vagrant. + +* **README.md**: This file you're currently reading. + +* **Vagrantfile**: This file is used by Vagrant to spin up the virtual machines. This file is fairly extensively commented to help explain what's happening. You should be able to use this file unchanged; all the VM configuration options are stored outside this file. + +## Instructions + +These instructions assume you've already installed Vagrant, your back-end virtualization provider (such as VMware Fusion or VirtualBox), and any necessary plugins (such as the Vagrant VMware plugin). Please refer to the documentation for those products for more information on installation or configuration. + +1. Use `vagrant box add` to add an Ubuntu 16.04 box to your system. The "bento/ubuntu-16.04" box is very good for both VirtualBox and VMware Fusion/Workstation. (Note that the "ubuntu/xenial64" box for VirtualBox is currently broken under Vagrant.) + +2. Edit the `machines.yml` file to ensure the box you downloaded in step 1 is specified on the "box:" sections of this file. Specify the name of a VMware-formatted box on the "vmw:" line; place the name of a VirtualBox-formatted box on the "vb:" line. + +3. Run `vagrant up` to have Vagrant instantiate the three machines configured by default in this environment, and provision them using Ansible. (Note you'll need Ansible installed locally on the system where you're running `vagrant up`.) + +4. Use `vagrant ssh ovs-01` to log into the first system. Verify that OVS is installed and working with `ovs-vsctl show`. + +5. Repeat step #4 with `ovs-02`. + +You now have a two-node system setup where both nodes are running OVS with a single bridge. + +Enjoy! diff --git a/ovs-ovn/ovs-simple/provision.retry b/ovs-ovn/ovs-simple/provision.retry deleted file mode 100644 index ecb9f0b..0000000 --- a/ovs-ovn/ovs-simple/provision.retry +++ /dev/null @@ -1 +0,0 @@ -ovs-01 diff --git a/traefik/README.md b/traefik/README.md index 0cab737..ae884c1 100644 --- a/traefik/README.md +++ b/traefik/README.md @@ -1,6 +1,6 @@ # Learning Tools: Traefik -This folder contains materials for working with Traefik, a dynamic reverse proxy often using in microservices-based architectures. +This folder contains materials for working with Traefik, a dynamic reverse proxy often used in microservices-based architectures. ## Contents diff --git a/vagrant/README.md b/vagrant/README.md index 538bd13..44b4238 100644 --- a/vagrant/README.md +++ b/vagrant/README.md @@ -6,7 +6,9 @@ This folder contains materials for learning more about how to use Vagrant. This **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. +**aws-multi**: Like "aws", but for spinning up multiple instances on AWS. + +**azure**: Like "aws", but for spinning up an instance on Microsoft Azure instead. **complex-json**: This folder contains files that illustrate how to use a "complex" JSON file as an external data source for a `Vagrantfile`.