Deployment Guide

This builds the deployment guide that will be published to
https://docs.openstack.org/project-deploy-guide/newton/.

In this approach, all existing documents in kolla-ansible/doc directory
will remain. The kolla-ansible/deploy-guide directory will simply
include all documents that exist in the kolla-ansible/doc directory.
All new changes will be made to the documents in the docs directory
which will be imported to the deployment-guide. However, I believe we
will also have to build the deployment-guide every time a change is
merged to the docs in the doc directory.

Change-Id: I98db4ec45403cf48086381b45bf5a12bbf998911
This commit is contained in:
Sayantani Goswami 2017-02-01 23:22:44 +00:00
parent 8ca634fa70
commit 78cf8abd1b
28 changed files with 123 additions and 47 deletions

View File

@ -0,0 +1,2 @@
.. advanced-configuration.rst:
.. include:: ../../doc/advanced-configuration.rst

View File

@ -0,0 +1,2 @@
.. bifrost.rst:
.. include:: ../../doc/bifrost.rst

View File

@ -0,0 +1,2 @@
.. ceph-guide.rst:
.. include:: ../../doc/ceph-guide.rst

View File

@ -0,0 +1,2 @@
.. cinder-guide-hnas.rst:
.. include:: ../../doc/cinder-guide-hnas.rst

View File

@ -0,0 +1,2 @@
.. cinder-guide.rst:
.. include:: ../../doc/cinder-guide.rst

View File

@ -0,0 +1,2 @@
.. deployment-philosophy.rst:
.. include:: ../../doc/deployment-philosophy.rst

View File

@ -0,0 +1,2 @@
.. designate-guide.rst:
.. include:: ../../doc/designate-guide.rst

View File

@ -0,0 +1,2 @@
.. external-ceph-guide.rst:
.. include:: ../../doc/external-ceph-guide.rst

View File

@ -1,4 +0,0 @@
Kolla deployment guide
======================
.. Populate these files with the Kolla Deployment guide -JR.

View File

@ -1,14 +1,36 @@
..
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 Deployment Guide
====================== ======================
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
for operating OpenStack clouds.
Kolla is highly opinionated out of the box, but allows for complete
customization. This permits operators with minimal experience to deploy
OpenStack quickly and as experience grows modify the OpenStack configuration to
suit the operator's exact requirements.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
get-started.rst kolla-ansible-index.rst
next-steps.rst
The Kolla service provides...
This chapter assumes a working setup of OpenStack following the
`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.

View File

@ -0,0 +1,2 @@
.. ironic-guide.rst:
.. include:: ../../doc/ironic-guide.rst

View File

@ -0,0 +1,2 @@
.. kibana-guide.rst:
.. include:: ../../doc/kibana-guide.rst

View File

@ -0,0 +1,46 @@
.. 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
ceph-guide.rst
cinder-guide.rst
cinder-guide-hnas.rst
designate-guide.rst
external-ceph-guide.rst
ironic-guide.rst
kibana-guide.rst
kuryr-guide.rst
manila-guide.rst
manila-hnas-guide.rst
networking-guide.rst
swift-guide.rst
.. toctree::
:hidden:
vagrant-dev-env.rst

View File

@ -0,0 +1,2 @@
.. kuryr-guide.rst:
.. include:: ../../doc/kuryr-guide.rst

View File

@ -0,0 +1,2 @@
.. manila-guide.rst:
.. include:: ../../doc/manila-guide.rst

View File

@ -0,0 +1,2 @@
.. manila-hnas-guide.rst:
.. include:: ../../doc/manila-hnas-guide.rst

View File

@ -0,0 +1,2 @@
.. multinode.rst:
.. include:: ../../doc/multinode.rst

View File

@ -0,0 +1,2 @@
.. networking-guide.rst:
.. include:: ../../doc/networking-guide.rst

View File

@ -1,4 +0,0 @@
Kolla deployment guide next steps
=================================
.. Populate these files with the Kolla Deployment guide -JR.

View File

@ -0,0 +1,2 @@
.. nova-fake-driver.rst:
.. include:: ../../doc/nova-fake-driver.rst

View File

@ -0,0 +1,2 @@
.. operating-kolla.rst:
.. include:: ../../doc/operating-kolla.rst

View File

@ -0,0 +1,2 @@
.. production-architecture-guide.rst:
.. include:: ../../doc/production-architecture-guide.rst

View File

@ -0,0 +1,2 @@
.. quickstart.rst:
.. include:: ../../doc/quickstart.rst

View File

@ -0,0 +1,2 @@
.. security.rst:
.. include:: ../../doc/security.rst

View File

@ -0,0 +1,2 @@
.. swift-guide.rst:
.. include:: ../../doc/swift-guide.rst

View File

@ -0,0 +1,2 @@
.. troubleshooting.rst:
.. include:: ../../doc/troubleshooting.rst

View File

@ -0,0 +1,2 @@
.. vagrant-dev-env.rst:
.. include:: ../../doc/vagrant-dev-env.rst

View File

@ -15,20 +15,10 @@ Kolla community has added a precheck feature which ensures the deployment
targets are in a state where Kolla may deploy to them. To run the prechecks, targets are in a state where Kolla may deploy to them. To run the prechecks,
execute: execute:
Production
==========
:: ::
kolla-ansible prechecks kolla-ansible prechecks
Development
===========
::
./tools/kolla-ansible prechecks
If a failure during deployment occurs it nearly always occurs during evaluation If a failure during deployment occurs it nearly always occurs during evaluation
of the software. Once the Operator learns the few configuration options of the software. Once the Operator learns the few configuration options
required, it is highly unlikely they will experience a failure in deployment. required, it is highly unlikely they will experience a failure in deployment.
@ -40,40 +30,20 @@ In this scenario, Kolla's behavior is undefined.
The fastest way during to recover from a deployment failure is to The fastest way during to recover from a deployment failure is to
remove the failed deployment: remove the failed deployment:
Production
==========
:: ::
kolla-ansible destroy -i <<inventory-file>> kolla-ansible destroy -i <<inventory-file>>
Development
===========
::
./tools/kolla-ansible destroy -i <<inventory-file>>
Any time the tags of a release change, it is possible that the container Any time the tags of a release change, it is possible that the container
implementation from older versions won't match the Ansible playbooks in a new implementation from older versions won't match the Ansible playbooks in a new
version. If running multinode from a registry, each node's Docker image cache version. If running multinode from a registry, each node's Docker image cache
must be refreshed with the latest images before a new deployment can occur. To must be refreshed with the latest images before a new deployment can occur. To
refresh the docker cache from the local Docker registry: refresh the docker cache from the local Docker registry:
Production
==========
:: ::
kolla-ansible pull kolla-ansible pull
Development
===========
::
./tools/kolla-ansible pull
Debugging Kolla Debugging Kolla
=============== ===============
@ -129,4 +99,4 @@ values are overridden, in ``/etc/kolla/globals.yml``. The value of
This step is necessary until the default Kibana dashboard is implemented in This step is necessary until the default Kibana dashboard is implemented in
Kolla. Kolla.
.. _launchpad bug: https://bugs.launchpad.net/kolla/+filebug .. _launchpad bug: https://bugs.launchpad.net/kolla-ansible/+filebug