[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
This commit is contained in:
parent
792b253b3a
commit
f6d93e5ecd
|
@ -1,2 +0,0 @@
|
||||||
.. advanced-configuration.rst:
|
|
||||||
.. include:: ../../doc/advanced-configuration.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. bifrost.rst:
|
|
||||||
.. include:: ../../doc/bifrost.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. central-logging-guide.rst:
|
|
||||||
.. include:: ../../doc/central-logging-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. ceph-guide.rst:
|
|
||||||
.. include:: ../../doc/ceph-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. cinder-guide-hnas.rst:
|
|
||||||
.. include:: ../../doc/cinder-guide-hnas.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. cinder-guide.rst:
|
|
||||||
.. include:: ../../doc/cinder-guide.rst
|
|
|
@ -55,7 +55,7 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Deployment Guide for Kolla Service'
|
project = u'Kolla-Ansible'
|
||||||
bug_tag = u'deploy-guide'
|
bug_tag = u'deploy-guide'
|
||||||
copyright = u'2016, OpenStack contributors'
|
copyright = u'2016, OpenStack contributors'
|
||||||
|
|
||||||
|
@ -258,7 +258,7 @@ latex_documents = [
|
||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
('index', 'installguide', u'Deploy Guide',
|
('index', 'deployguide', u'Deploy Guide',
|
||||||
[u'OpenStack contributors'], 1)
|
[u'OpenStack contributors'], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. deployment-philosophy.rst:
|
|
||||||
.. include:: ../../doc/deployment-philosophy.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. designate-guide.rst:
|
|
||||||
.. include:: ../../doc/designate-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. external-ceph-guide.rst:
|
|
||||||
.. include:: ../../doc/external-ceph-guide.rst
|
|
|
@ -1,25 +1,6 @@
|
||||||
..
|
==============================
|
||||||
Copyright 2014-2015 OpenStack Foundation
|
Kolla-Ansible Deployment Guide
|
||||||
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 provides Docker containers and Ansible playbooks to meet Kolla's mission.
|
Kolla provides Docker containers and Ansible playbooks to meet Kolla's mission.
|
||||||
Kolla's mission is to provide production-ready containers and deployment tools
|
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.
|
suit the operator's exact requirements.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
kolla-ansible-index.rst
|
quickstart
|
||||||
|
multinode
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. ironic-guide.rst:
|
|
||||||
.. include:: ../../doc/ironic-guide.rst
|
|
|
@ -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
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. kuryr-guide.rst:
|
|
||||||
.. include:: ../../doc/kuryr-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. manila-guide.rst:
|
|
||||||
.. include:: ../../doc/manila-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. manila-hnas-guide.rst:
|
|
||||||
.. include:: ../../doc/manila-hnas-guide.rst
|
|
|
@ -1,2 +1,2 @@
|
||||||
.. multinode.rst:
|
.. multinode:
|
||||||
.. include:: ../../doc/multinode.rst
|
.. include:: ../../doc/multinode.rst
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. networking-guide.rst:
|
|
||||||
.. include:: ../../doc/networking-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. nova-fake-driver.rst:
|
|
||||||
.. include:: ../../doc/nova-fake-driver.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. operating-kolla.rst:
|
|
||||||
.. include:: ../../doc/operating-kolla.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. production-architecture-guide.rst:
|
|
||||||
.. include:: ../../doc/production-architecture-guide.rst
|
|
|
@ -1,2 +1,2 @@
|
||||||
.. quickstart.rst:
|
.. quickstart:
|
||||||
.. include:: ../../doc/quickstart.rst
|
.. include:: ../../doc/quickstart.rst
|
||||||
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. security.rst:
|
|
||||||
.. include:: ../../doc/security.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. swift-guide.rst:
|
|
||||||
.. include:: ../../doc/swift-guide.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. troubleshooting.rst:
|
|
||||||
.. include:: ../../doc/troubleshooting.rst
|
|
|
@ -1,2 +0,0 @@
|
||||||
.. vagrant-dev-env.rst:
|
|
||||||
.. include:: ../../doc/vagrant-dev-env.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
|
If developing Kolla on a system that provides VirtualBox or Libvirt in addition
|
||||||
to Vagrant, use the Vagrant virtual environment documented in
|
to Vagrant, use the Vagrant virtual environment documented in
|
||||||
:doc:`vagrant-dev-env`.
|
`Development Environment with Vagrant <https://docs.openstack.org/project-deploy-guide/kolla-ansible/ocata/vagrant-dev-env.html>`_.
|
||||||
|
|
||||||
Prerequisites
|
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
|
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
|
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
|
deploying multinode, a registry is strongly recommended to serve as a single
|
||||||
source of images. Reference the :doc:`multinode` for more information on using
|
source of images. Reference the
|
||||||
a local Docker registry. Otherwise, the Docker Hub Image Registry contains all
|
`Multinode Deployment of Kolla <https://docs.openstack.org/project-deploy-guide/kolla-ansible/ocata/multinode.html>`_
|
||||||
|
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
|
images from each of Kolla’s major releases. The latest release tag is 3.0.2 for
|
||||||
Newton.
|
Newton.
|
||||||
|
|
||||||
|
@ -527,11 +529,12 @@ There are two methods of deployment: *all-in-one* and *multinode*. The
|
||||||
<http://docs.openstack.org/developer/devstack/>`__ deploy which installs all
|
<http://docs.openstack.org/developer/devstack/>`__ deploy which installs all
|
||||||
OpenStack services on a single host. In the *multinode* deployment, OpenStack
|
OpenStack services on a single host. In the *multinode* deployment, OpenStack
|
||||||
services can be run on specific hosts. This documentation describes deploying
|
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 <https://docs.openstack.org/project-deploy-guide/kolla-ansible/ocata/multinode.html>`_.
|
||||||
|
|
||||||
Each method is represented as an Ansible inventory file. More information on
|
Each method is represented as an Ansible inventory file. More information on
|
||||||
the Ansible inventory file can be found in the Ansible `inventory introduction
|
the Ansible inventory file can be found in the Ansible `inventory introduction
|
||||||
<https://docs.ansible.com/intro_inventory.html>`__.
|
<https://docs.ansible.com/intro_inventory.html>`_.
|
||||||
|
|
||||||
All variables for the environment can be specified in the files:
|
All variables for the environment can be specified in the files:
|
||||||
``/etc/kolla/globals.yml`` and ``/etc/kolla/passwords.yml``.
|
``/etc/kolla/globals.yml`` and ``/etc/kolla/passwords.yml``.
|
||||||
|
|
Loading…
Reference in New Issue