From d25f87bff00349b0585e675fe9b724ec76b8e9d3 Mon Sep 17 00:00:00 2001 From: Major Hayden Date: Wed, 13 Jan 2016 14:17:31 -0600 Subject: [PATCH] Docs: overview cleanup Cleaning up the About page and merging in Ansible/LXC overviews since those technologies are talked about in the About page anyway. Change-Id: I571ef104be977b87bf484e64b855128318a287b4 --- doc/source/install-guide/overview-ansible.rst | 32 ------ doc/source/install-guide/overview-lxc.rst | 64 ----------- doc/source/install-guide/overview-osa.rst | 101 ++++++++++++++++-- doc/source/install-guide/overview.rst | 2 - 4 files changed, 93 insertions(+), 106 deletions(-) delete mode 100644 doc/source/install-guide/overview-ansible.rst delete mode 100644 doc/source/install-guide/overview-lxc.rst diff --git a/doc/source/install-guide/overview-ansible.rst b/doc/source/install-guide/overview-ansible.rst deleted file mode 100644 index 39f8f544e3..0000000000 --- a/doc/source/install-guide/overview-ansible.rst +++ /dev/null @@ -1,32 +0,0 @@ -`Home `_ OpenStack-Ansible Installation Guide - -Ansible -------- - -OpenStack-Ansible Deployment uses a combination of Ansible and -Linux Containers (LXC) to install and manage OpenStack. Ansible -provides an automation platform to simplify system and application -deployment. Ansible manages systems using Secure Shell (SSH) -instead of unique protocols that require remote daemons or agents. - -Ansible uses *playbooks* written in the YAML language for orchestration. -For more information, see `Ansible - Intro to -Playbooks `_. - -In this guide, we refer to the host running Ansible playbooks as -the *deployment host* and the hosts on which Ansible installs OSA as the -*target hosts*. - -A recommended minimal layout for deployments involves five target -hosts in total: three infrastructure hosts, one compute host, and one -logging host. All hosts require three network interfaces. More -information on setting up target hosts can be found in `the section -called "Host layout" `_. - -For more information on physical, logical, and virtual network -interfaces within hosts see `the section called "Host -networking" `_. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/install-guide/overview-lxc.rst b/doc/source/install-guide/overview-lxc.rst deleted file mode 100644 index e82962b81e..0000000000 --- a/doc/source/install-guide/overview-lxc.rst +++ /dev/null @@ -1,64 +0,0 @@ -`Home `_ OpenStack-Ansible Installation Guide - -Linux Containers (LXC) ----------------------- - -Containers provide operating-system level virtualization by enhancing -the concept of **chroot** environments, which isolate resources and file -systems for a particular group of processes without the overhead and -complexity of virtual machines. They access the same kernel, devices, -and file systems on the underlying host and provide a thin operational -layer built around a set of rules. - -The Linux Containers (LXC) project implements operating system level -virtualization on Linux using kernel namespaces and includes the -following features: - -- Resource isolation including CPU, memory, block I/O, and network - using *cgroups*. - -- Selective connectivity to physical and virtual network devices on the - underlying physical host. - -- Support for a variety of backing stores including LVM. - -- Built on a foundation of stable Linux technologies with an active - development and support community. - -Useful commands: - -- List containers and summary information such as operational state and - network configuration: - - .. code-block:: shell-session - - # lxc-ls --fancy - -- Show container details including operational state, resource - utilization, and ``veth`` pairs: - - .. code-block:: shell-session - - # lxc-info --name container_name - -- Start a container: - - .. code-block:: shell-session - - # lxc-start --name container_name - -- Attach to a container: - - .. code-block:: shell-session - - # lxc-attach --name container_name - -- Stop a container: - - .. code-block:: shell-session - - # lxc-stop --name container_name - --------------- - -.. include:: navigation.txt diff --git a/doc/source/install-guide/overview-osa.rst b/doc/source/install-guide/overview-osa.rst index f658657e19..ad7d4365e2 100644 --- a/doc/source/install-guide/overview-osa.rst +++ b/doc/source/install-guide/overview-osa.rst @@ -1,18 +1,16 @@ `Home `_ OpenStack-Ansible Installation Guide -About OpenStack-Ansible Deployment ----------------------------------- +About OpenStack-Ansible +----------------------- OpenStack-Ansible uses the Ansible IT automation framework to -create an OpenStack cluster on Ubuntu Linux. OpenStack components are +deploy an OpenStack environment on Ubuntu Linux. OpenStack components are installed into Linux Containers (LXC) for isolation and ease of maintenance. -| OpenStack-Ansible Deployment - This documentation is intended for deployers of the OpenStack-Ansible -deployment system who are interested in installing an OpenStack. The -document is for informational purposes only and is provided "AS IS." +deployment system who are interested in installing an OpenStack environment. +The document is for informational purposes only and is provided "AS IS." Third-party trademarks and tradenames appearing in this document are the property of their respective owners. Such third-party trademarks have @@ -21,7 +19,94 @@ purposes only. We do not intend our use or display of other companies" tradenames, trademarks, or service marks to imply a relationship with, or endorsement or sponsorship of us by, these other companies. -`OpenStack.org `_ +Ansible +~~~~~~~ +OpenStack-Ansible Deployment uses a combination of Ansible and +Linux Containers (LXC) to install and manage OpenStack. Ansible +provides an automation platform to simplify system and application +deployment. Ansible manages systems using Secure Shell (SSH) +instead of unique protocols that require remote daemons or agents. + +Ansible uses *playbooks* written in the YAML language for orchestration. +For more information, see `Ansible - Intro to +Playbooks `_. + +In this guide, we refer to the host running Ansible playbooks as +the *deployment host* and the hosts on which Ansible installs OSA as the +*target hosts*. + +A recommended minimal layout for deployments involves five target +hosts in total: three infrastructure hosts, one compute host, and one +logging host. All hosts will need at least one networking interface, but +multiple bonded interfaces are recommended. More information on setting up +target hosts can be found in `the section called "Host layout"`_. + +For more information on physical, logical, and virtual network +interfaces within hosts see `the section called "Host +networking"`_. + +.. _the section called "Host layout": overview-hostlayout.html +.. _the section called "Host networking": overview-hostnetworking.html + + +Linux Containers (LXC) +~~~~~~~~~~~~~~~~~~~~~~ + +Containers provide operating-system level virtualization by enhancing +the concept of **chroot** environments, which isolate resources and file +systems for a particular group of processes without the overhead and +complexity of virtual machines. They access the same kernel, devices, +and file systems on the underlying host and provide a thin operational +layer built around a set of rules. + +The Linux Containers (LXC) project implements operating system level +virtualization on Linux using kernel namespaces and includes the +following features: + +- Resource isolation including CPU, memory, block I/O, and network + using *cgroups*. + +- Selective connectivity to physical and virtual network devices on the + underlying physical host. + +- Support for a variety of backing stores including LVM. + +- Built on a foundation of stable Linux technologies with an active + development and support community. + +Useful commands: + +- List containers and summary information such as operational state and + network configuration: + + .. code-block:: shell-session + + # lxc-ls --fancy + +- Show container details including operational state, resource + utilization, and ``veth`` pairs: + + .. code-block:: shell-session + + # lxc-info --name container_name + +- Start a container: + + .. code-block:: shell-session + + # lxc-start --name container_name + +- Attach to a container: + + .. code-block:: shell-session + + # lxc-attach --name container_name + +- Stop a container: + + .. code-block:: shell-session + + # lxc-stop --name container_name .. include:: navigation.txt diff --git a/doc/source/install-guide/overview.rst b/doc/source/install-guide/overview.rst index aac0b5d874..dd46524ac8 100644 --- a/doc/source/install-guide/overview.rst +++ b/doc/source/install-guide/overview.rst @@ -6,8 +6,6 @@ Chapter 1. Overview .. toctree:: overview-osa.rst - overview-ansible.rst - overview-lxc.rst overview-hostlayout.rst overview-hostnetworking.rst overview-neutron.rst