From f6d93e5ecd9717f75e13000ce1e0263889edc108 Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Wed, 22 Mar 2017 11:05:35 +0000 Subject: [PATCH] [deploy-guide] Moving the quick start to the deploy folder Currently the project-deploy-guide links to the entire dev doc repo for Kolla-Ansible. This is incorrect. It should link only to installation information that can be found in the quick start guide. This patch remedies that change, and ensures that there is a link to the kolla deploy guide published at docs.o.o. Change-Id: I43738e341e996cb5a589a09c4c59c0dc8b058458 --- .../source/advanced-configuration.rst | 2 - deploy-guide/source/bifrost.rst | 2 - deploy-guide/source/central-logging-guide.rst | 2 - deploy-guide/source/ceph-guide.rst | 2 - deploy-guide/source/cinder-guide-hnas.rst | 2 - deploy-guide/source/cinder-guide.rst | 2 - deploy-guide/source/conf.py | 4 +- deploy-guide/source/deployment-philosophy.rst | 2 - deploy-guide/source/designate-guide.rst | 2 - deploy-guide/source/external-ceph-guide.rst | 2 - deploy-guide/source/index.rst | 30 +++--------- deploy-guide/source/ironic-guide.rst | 2 - deploy-guide/source/kolla-ansible-index.rst | 46 ------------------- deploy-guide/source/kuryr-guide.rst | 2 - deploy-guide/source/manila-guide.rst | 2 - deploy-guide/source/manila-hnas-guide.rst | 2 - deploy-guide/source/multinode.rst | 2 +- deploy-guide/source/networking-guide.rst | 2 - deploy-guide/source/nova-fake-driver.rst | 2 - deploy-guide/source/operating-kolla.rst | 2 - .../source/production-architecture-guide.rst | 2 - deploy-guide/source/quickstart.rst | 2 +- deploy-guide/source/security.rst | 2 - deploy-guide/source/swift-guide.rst | 2 - deploy-guide/source/troubleshooting.rst | 2 - deploy-guide/source/vagrant-dev-env.rst | 2 - doc/quickstart.rst | 13 ++++-- 27 files changed, 18 insertions(+), 121 deletions(-) delete mode 100644 deploy-guide/source/advanced-configuration.rst delete mode 100644 deploy-guide/source/bifrost.rst delete mode 100644 deploy-guide/source/central-logging-guide.rst delete mode 100644 deploy-guide/source/ceph-guide.rst delete mode 100644 deploy-guide/source/cinder-guide-hnas.rst delete mode 100644 deploy-guide/source/cinder-guide.rst delete mode 100644 deploy-guide/source/deployment-philosophy.rst delete mode 100644 deploy-guide/source/designate-guide.rst delete mode 100644 deploy-guide/source/external-ceph-guide.rst delete mode 100644 deploy-guide/source/ironic-guide.rst delete mode 100644 deploy-guide/source/kolla-ansible-index.rst delete mode 100644 deploy-guide/source/kuryr-guide.rst delete mode 100644 deploy-guide/source/manila-guide.rst delete mode 100644 deploy-guide/source/manila-hnas-guide.rst delete mode 100644 deploy-guide/source/networking-guide.rst delete mode 100644 deploy-guide/source/nova-fake-driver.rst delete mode 100644 deploy-guide/source/operating-kolla.rst delete mode 100644 deploy-guide/source/production-architecture-guide.rst delete mode 100644 deploy-guide/source/security.rst delete mode 100644 deploy-guide/source/swift-guide.rst delete mode 100644 deploy-guide/source/troubleshooting.rst delete mode 100644 deploy-guide/source/vagrant-dev-env.rst diff --git a/deploy-guide/source/advanced-configuration.rst b/deploy-guide/source/advanced-configuration.rst deleted file mode 100644 index 449f13c076..0000000000 --- a/deploy-guide/source/advanced-configuration.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. advanced-configuration.rst: -.. include:: ../../doc/advanced-configuration.rst diff --git a/deploy-guide/source/bifrost.rst b/deploy-guide/source/bifrost.rst deleted file mode 100644 index 5610b02480..0000000000 --- a/deploy-guide/source/bifrost.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. bifrost.rst: -.. include:: ../../doc/bifrost.rst diff --git a/deploy-guide/source/central-logging-guide.rst b/deploy-guide/source/central-logging-guide.rst deleted file mode 100644 index ef6621381e..0000000000 --- a/deploy-guide/source/central-logging-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. central-logging-guide.rst: -.. include:: ../../doc/central-logging-guide.rst diff --git a/deploy-guide/source/ceph-guide.rst b/deploy-guide/source/ceph-guide.rst deleted file mode 100644 index 09f8df3452..0000000000 --- a/deploy-guide/source/ceph-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. ceph-guide.rst: -.. include:: ../../doc/ceph-guide.rst diff --git a/deploy-guide/source/cinder-guide-hnas.rst b/deploy-guide/source/cinder-guide-hnas.rst deleted file mode 100644 index 4d4b458240..0000000000 --- a/deploy-guide/source/cinder-guide-hnas.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. cinder-guide-hnas.rst: -.. include:: ../../doc/cinder-guide-hnas.rst diff --git a/deploy-guide/source/cinder-guide.rst b/deploy-guide/source/cinder-guide.rst deleted file mode 100644 index d4d886498f..0000000000 --- a/deploy-guide/source/cinder-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. cinder-guide.rst: -.. include:: ../../doc/cinder-guide.rst diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index 1e92d6cb6b..bf6eedc697 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -55,7 +55,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Deployment Guide for Kolla Service' +project = u'Kolla-Ansible' bug_tag = u'deploy-guide' copyright = u'2016, OpenStack contributors' @@ -258,7 +258,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'installguide', u'Deploy Guide', + ('index', 'deployguide', u'Deploy Guide', [u'OpenStack contributors'], 1) ] diff --git a/deploy-guide/source/deployment-philosophy.rst b/deploy-guide/source/deployment-philosophy.rst deleted file mode 100644 index 2f87649d40..0000000000 --- a/deploy-guide/source/deployment-philosophy.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. deployment-philosophy.rst: -.. include:: ../../doc/deployment-philosophy.rst diff --git a/deploy-guide/source/designate-guide.rst b/deploy-guide/source/designate-guide.rst deleted file mode 100644 index fab6253f06..0000000000 --- a/deploy-guide/source/designate-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. designate-guide.rst: -.. include:: ../../doc/designate-guide.rst diff --git a/deploy-guide/source/external-ceph-guide.rst b/deploy-guide/source/external-ceph-guide.rst deleted file mode 100644 index 60d1b5d077..0000000000 --- a/deploy-guide/source/external-ceph-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. external-ceph-guide.rst: -.. include:: ../../doc/external-ceph-guide.rst diff --git a/deploy-guide/source/index.rst b/deploy-guide/source/index.rst index 897bd24cec..640356251d 100644 --- a/deploy-guide/source/index.rst +++ b/deploy-guide/source/index.rst @@ -1,25 +1,6 @@ -.. - Copyright 2014-2015 OpenStack Foundation - All Rights Reserved. - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - -====================== -Kolla Deployment Guide -====================== - -Kolla's Mission -=============== +============================== +Kolla-Ansible Deployment Guide +============================== Kolla provides Docker containers and Ansible playbooks to meet Kolla's mission. Kolla's mission is to provide production-ready containers and deployment tools @@ -31,6 +12,7 @@ OpenStack quickly and as experience grows modify the OpenStack configuration to suit the operator's exact requirements. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - kolla-ansible-index.rst + quickstart + multinode diff --git a/deploy-guide/source/ironic-guide.rst b/deploy-guide/source/ironic-guide.rst deleted file mode 100644 index 1cc05ee5d5..0000000000 --- a/deploy-guide/source/ironic-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. ironic-guide.rst: -.. include:: ../../doc/ironic-guide.rst diff --git a/deploy-guide/source/kolla-ansible-index.rst b/deploy-guide/source/kolla-ansible-index.rst deleted file mode 100644 index 3936e73d27..0000000000 --- a/deploy-guide/source/kolla-ansible-index.rst +++ /dev/null @@ -1,46 +0,0 @@ - -.. kolla-ansible-index.rst: - -Kolla-Ansible -============= - -Overview --------- - -.. toctree:: - :maxdepth: 2 - - deployment-philosophy.rst - production-architecture-guide.rst - quickstart.rst - multinode.rst - advanced-configuration.rst - operating-kolla.rst - security.rst - nova-fake-driver.rst - troubleshooting.rst - -Services --------- - -.. toctree:: - :maxdepth: 2 - - bifrost.rst - central-logging-guide.rst - ceph-guide.rst - cinder-guide.rst - cinder-guide-hnas.rst - designate-guide.rst - external-ceph-guide.rst - ironic-guide.rst - kuryr-guide.rst - manila-guide.rst - manila-hnas-guide.rst - networking-guide.rst - swift-guide.rst - -.. toctree:: - :hidden: - - vagrant-dev-env.rst diff --git a/deploy-guide/source/kuryr-guide.rst b/deploy-guide/source/kuryr-guide.rst deleted file mode 100644 index 6bcf5c7cb4..0000000000 --- a/deploy-guide/source/kuryr-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. kuryr-guide.rst: -.. include:: ../../doc/kuryr-guide.rst diff --git a/deploy-guide/source/manila-guide.rst b/deploy-guide/source/manila-guide.rst deleted file mode 100644 index d6bc5d9265..0000000000 --- a/deploy-guide/source/manila-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. manila-guide.rst: -.. include:: ../../doc/manila-guide.rst diff --git a/deploy-guide/source/manila-hnas-guide.rst b/deploy-guide/source/manila-hnas-guide.rst deleted file mode 100644 index e0a2c313f1..0000000000 --- a/deploy-guide/source/manila-hnas-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. manila-hnas-guide.rst: -.. include:: ../../doc/manila-hnas-guide.rst diff --git a/deploy-guide/source/multinode.rst b/deploy-guide/source/multinode.rst index 4d5409102a..f5a22f6c91 100644 --- a/deploy-guide/source/multinode.rst +++ b/deploy-guide/source/multinode.rst @@ -1,2 +1,2 @@ -.. multinode.rst: +.. multinode: .. include:: ../../doc/multinode.rst diff --git a/deploy-guide/source/networking-guide.rst b/deploy-guide/source/networking-guide.rst deleted file mode 100644 index 3abbc2edc8..0000000000 --- a/deploy-guide/source/networking-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. networking-guide.rst: -.. include:: ../../doc/networking-guide.rst diff --git a/deploy-guide/source/nova-fake-driver.rst b/deploy-guide/source/nova-fake-driver.rst deleted file mode 100644 index 95d684694d..0000000000 --- a/deploy-guide/source/nova-fake-driver.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. nova-fake-driver.rst: -.. include:: ../../doc/nova-fake-driver.rst diff --git a/deploy-guide/source/operating-kolla.rst b/deploy-guide/source/operating-kolla.rst deleted file mode 100644 index f0d13b7e0e..0000000000 --- a/deploy-guide/source/operating-kolla.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. operating-kolla.rst: -.. include:: ../../doc/operating-kolla.rst diff --git a/deploy-guide/source/production-architecture-guide.rst b/deploy-guide/source/production-architecture-guide.rst deleted file mode 100644 index d6ad14e611..0000000000 --- a/deploy-guide/source/production-architecture-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. production-architecture-guide.rst: -.. include:: ../../doc/production-architecture-guide.rst diff --git a/deploy-guide/source/quickstart.rst b/deploy-guide/source/quickstart.rst index 1109553109..63f89ea559 100644 --- a/deploy-guide/source/quickstart.rst +++ b/deploy-guide/source/quickstart.rst @@ -1,2 +1,2 @@ -.. quickstart.rst: +.. quickstart: .. include:: ../../doc/quickstart.rst diff --git a/deploy-guide/source/security.rst b/deploy-guide/source/security.rst deleted file mode 100644 index 9fa89ae71c..0000000000 --- a/deploy-guide/source/security.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. security.rst: -.. include:: ../../doc/security.rst diff --git a/deploy-guide/source/swift-guide.rst b/deploy-guide/source/swift-guide.rst deleted file mode 100644 index d7c5766241..0000000000 --- a/deploy-guide/source/swift-guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. swift-guide.rst: -.. include:: ../../doc/swift-guide.rst diff --git a/deploy-guide/source/troubleshooting.rst b/deploy-guide/source/troubleshooting.rst deleted file mode 100644 index 9601abcdda..0000000000 --- a/deploy-guide/source/troubleshooting.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. troubleshooting.rst: -.. include:: ../../doc/troubleshooting.rst diff --git a/deploy-guide/source/vagrant-dev-env.rst b/deploy-guide/source/vagrant-dev-env.rst deleted file mode 100644 index 047b471b77..0000000000 --- a/deploy-guide/source/vagrant-dev-env.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. vagrant-dev-env.rst: -.. include:: ../../doc/vagrant-dev-env.rst diff --git a/doc/quickstart.rst b/doc/quickstart.rst index 3d07dd2471..bafd3cce37 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -29,7 +29,7 @@ bare metal or a virtual machine with Kolla. If developing Kolla on a system that provides VirtualBox or Libvirt in addition to Vagrant, use the Vagrant virtual environment documented in -:doc:`vagrant-dev-env`. +`Development Environment with Vagrant `_. Prerequisites ============= @@ -388,8 +388,10 @@ A local registry is recommended but not required for an ``all-in-one`` installation when developing for master. Since no master images are available on docker hub, the docker cache may be used for all-in-one deployments. When deploying multinode, a registry is strongly recommended to serve as a single -source of images. Reference the :doc:`multinode` for more information on using -a local Docker registry. Otherwise, the Docker Hub Image Registry contains all +source of images. Reference the +`Multinode Deployment of Kolla `_ +for more information on using a local Docker registry. +Otherwise, the Docker Hub Image Registry contains all images from each of Kolla’s major releases. The latest release tag is 3.0.2 for Newton. @@ -527,11 +529,12 @@ There are two methods of deployment: *all-in-one* and *multinode*. The `__ deploy which installs all OpenStack services on a single host. In the *multinode* deployment, OpenStack services can be run on specific hosts. This documentation describes deploying -an *all-in-one* setup. To setup *multinode* see the :doc:`multinode`. +an *all-in-one* setup. To setup *multinode* see the +`Multinode Deployment of Kolla `_. Each method is represented as an Ansible inventory file. More information on the Ansible inventory file can be found in the Ansible `inventory introduction -`__. +`_. All variables for the environment can be specified in the files: ``/etc/kolla/globals.yml`` and ``/etc/kolla/passwords.yml``.