From 78cf8abd1b193aa8a904bbbb49ce2bdee7c5af6f Mon Sep 17 00:00:00 2001
From: Sayantani Goswami <sayantani.goswami@intel.com>
Date: Wed, 1 Feb 2017 23:22:44 +0000
Subject: [PATCH] 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
---
.../source/advanced-configuration.rst | 2 +
deploy-guide/source/bifrost.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/deployment-philosophy.rst | 2 +
deploy-guide/source/designate-guide.rst | 2 +
deploy-guide/source/external-ceph-guide.rst | 2 +
deploy-guide/source/get-started.rst | 4 --
deploy-guide/source/index.rst | 36 ++++++++++++---
deploy-guide/source/ironic-guide.rst | 2 +
deploy-guide/source/kibana-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/next-steps.rst | 4 --
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/troubleshooting.rst | 32 +------------
28 files changed, 122 insertions(+), 46 deletions(-)
create mode 100644 deploy-guide/source/advanced-configuration.rst
create mode 100644 deploy-guide/source/bifrost.rst
create mode 100644 deploy-guide/source/ceph-guide.rst
create mode 100644 deploy-guide/source/cinder-guide-hnas.rst
create mode 100644 deploy-guide/source/cinder-guide.rst
create mode 100644 deploy-guide/source/deployment-philosophy.rst
create mode 100644 deploy-guide/source/designate-guide.rst
create mode 100644 deploy-guide/source/external-ceph-guide.rst
delete mode 100644 deploy-guide/source/get-started.rst
create mode 100644 deploy-guide/source/ironic-guide.rst
create mode 100644 deploy-guide/source/kibana-guide.rst
create mode 100644 deploy-guide/source/kolla-ansible-index.rst
create mode 100644 deploy-guide/source/kuryr-guide.rst
create mode 100644 deploy-guide/source/manila-guide.rst
create mode 100644 deploy-guide/source/manila-hnas-guide.rst
create mode 100644 deploy-guide/source/multinode.rst
create mode 100644 deploy-guide/source/networking-guide.rst
delete mode 100644 deploy-guide/source/next-steps.rst
create mode 100644 deploy-guide/source/nova-fake-driver.rst
create mode 100644 deploy-guide/source/operating-kolla.rst
create mode 100644 deploy-guide/source/production-architecture-guide.rst
create mode 100644 deploy-guide/source/quickstart.rst
create mode 100644 deploy-guide/source/security.rst
create mode 100644 deploy-guide/source/swift-guide.rst
create mode 100644 deploy-guide/source/troubleshooting.rst
create 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
new file mode 100644
index 0000000000..449f13c076
--- /dev/null
+++ b/deploy-guide/source/advanced-configuration.rst
@@ -0,0 +1,2 @@
+.. advanced-configuration.rst:
+.. include:: ../../doc/advanced-configuration.rst
diff --git a/deploy-guide/source/bifrost.rst b/deploy-guide/source/bifrost.rst
new file mode 100644
index 0000000000..5610b02480
--- /dev/null
+++ b/deploy-guide/source/bifrost.rst
@@ -0,0 +1,2 @@
+.. bifrost.rst:
+.. include:: ../../doc/bifrost.rst
diff --git a/deploy-guide/source/ceph-guide.rst b/deploy-guide/source/ceph-guide.rst
new file mode 100644
index 0000000000..09f8df3452
--- /dev/null
+++ b/deploy-guide/source/ceph-guide.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..4d4b458240
--- /dev/null
+++ b/deploy-guide/source/cinder-guide-hnas.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..d4d886498f
--- /dev/null
+++ b/deploy-guide/source/cinder-guide.rst
@@ -0,0 +1,2 @@
+.. cinder-guide.rst:
+.. include:: ../../doc/cinder-guide.rst
diff --git a/deploy-guide/source/deployment-philosophy.rst b/deploy-guide/source/deployment-philosophy.rst
new file mode 100644
index 0000000000..2f87649d40
--- /dev/null
+++ b/deploy-guide/source/deployment-philosophy.rst
@@ -0,0 +1,2 @@
+.. deployment-philosophy.rst:
+.. include:: ../../doc/deployment-philosophy.rst
diff --git a/deploy-guide/source/designate-guide.rst b/deploy-guide/source/designate-guide.rst
new file mode 100644
index 0000000000..fab6253f06
--- /dev/null
+++ b/deploy-guide/source/designate-guide.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..60d1b5d077
--- /dev/null
+++ b/deploy-guide/source/external-ceph-guide.rst
@@ -0,0 +1,2 @@
+.. external-ceph-guide.rst:
+.. include:: ../../doc/external-ceph-guide.rst
diff --git a/deploy-guide/source/get-started.rst b/deploy-guide/source/get-started.rst
deleted file mode 100644
index ef6694a521..0000000000
--- a/deploy-guide/source/get-started.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Kolla deployment guide
-======================
-
-.. Populate these files with the Kolla Deployment guide -JR.
diff --git a/deploy-guide/source/index.rst b/deploy-guide/source/index.rst
index 2f88dd0c0e..897bd24cec 100644
--- a/deploy-guide/source/index.rst
+++ b/deploy-guide/source/index.rst
@@ -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
======================
-.. toctree::
- :maxdepth: 2
+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.
- get-started.rst
- next-steps.rst
+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.
-The Kolla service provides...
+.. toctree::
+ :maxdepth: 1
-This chapter assumes a working setup of OpenStack following the
-`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
+ kolla-ansible-index.rst
diff --git a/deploy-guide/source/ironic-guide.rst b/deploy-guide/source/ironic-guide.rst
new file mode 100644
index 0000000000..1cc05ee5d5
--- /dev/null
+++ b/deploy-guide/source/ironic-guide.rst
@@ -0,0 +1,2 @@
+.. ironic-guide.rst:
+.. include:: ../../doc/ironic-guide.rst
diff --git a/deploy-guide/source/kibana-guide.rst b/deploy-guide/source/kibana-guide.rst
new file mode 100644
index 0000000000..6b0b5ea944
--- /dev/null
+++ b/deploy-guide/source/kibana-guide.rst
@@ -0,0 +1,2 @@
+.. kibana-guide.rst:
+.. include:: ../../doc/kibana-guide.rst
diff --git a/deploy-guide/source/kolla-ansible-index.rst b/deploy-guide/source/kolla-ansible-index.rst
new file mode 100644
index 0000000000..490c1b2ae7
--- /dev/null
+++ b/deploy-guide/source/kolla-ansible-index.rst
@@ -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
diff --git a/deploy-guide/source/kuryr-guide.rst b/deploy-guide/source/kuryr-guide.rst
new file mode 100644
index 0000000000..6bcf5c7cb4
--- /dev/null
+++ b/deploy-guide/source/kuryr-guide.rst
@@ -0,0 +1,2 @@
+.. kuryr-guide.rst:
+.. include:: ../../doc/kuryr-guide.rst
diff --git a/deploy-guide/source/manila-guide.rst b/deploy-guide/source/manila-guide.rst
new file mode 100644
index 0000000000..d6bc5d9265
--- /dev/null
+++ b/deploy-guide/source/manila-guide.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..e0a2c313f1
--- /dev/null
+++ b/deploy-guide/source/manila-hnas-guide.rst
@@ -0,0 +1,2 @@
+.. manila-hnas-guide.rst:
+.. include:: ../../doc/manila-hnas-guide.rst
diff --git a/deploy-guide/source/multinode.rst b/deploy-guide/source/multinode.rst
new file mode 100644
index 0000000000..4d5409102a
--- /dev/null
+++ b/deploy-guide/source/multinode.rst
@@ -0,0 +1,2 @@
+.. multinode.rst:
+.. include:: ../../doc/multinode.rst
diff --git a/deploy-guide/source/networking-guide.rst b/deploy-guide/source/networking-guide.rst
new file mode 100644
index 0000000000..3abbc2edc8
--- /dev/null
+++ b/deploy-guide/source/networking-guide.rst
@@ -0,0 +1,2 @@
+.. networking-guide.rst:
+.. include:: ../../doc/networking-guide.rst
diff --git a/deploy-guide/source/next-steps.rst b/deploy-guide/source/next-steps.rst
deleted file mode 100644
index f3a68ce2d3..0000000000
--- a/deploy-guide/source/next-steps.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Kolla deployment guide next steps
-=================================
-
-.. Populate these files with the Kolla Deployment guide -JR.
diff --git a/deploy-guide/source/nova-fake-driver.rst b/deploy-guide/source/nova-fake-driver.rst
new file mode 100644
index 0000000000..95d684694d
--- /dev/null
+++ b/deploy-guide/source/nova-fake-driver.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..f0d13b7e0e
--- /dev/null
+++ b/deploy-guide/source/operating-kolla.rst
@@ -0,0 +1,2 @@
+.. 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
new file mode 100644
index 0000000000..d6ad14e611
--- /dev/null
+++ b/deploy-guide/source/production-architecture-guide.rst
@@ -0,0 +1,2 @@
+.. production-architecture-guide.rst:
+.. include:: ../../doc/production-architecture-guide.rst
diff --git a/deploy-guide/source/quickstart.rst b/deploy-guide/source/quickstart.rst
new file mode 100644
index 0000000000..1109553109
--- /dev/null
+++ b/deploy-guide/source/quickstart.rst
@@ -0,0 +1,2 @@
+.. quickstart.rst:
+.. include:: ../../doc/quickstart.rst
diff --git a/deploy-guide/source/security.rst b/deploy-guide/source/security.rst
new file mode 100644
index 0000000000..9fa89ae71c
--- /dev/null
+++ b/deploy-guide/source/security.rst
@@ -0,0 +1,2 @@
+.. security.rst:
+.. include:: ../../doc/security.rst
diff --git a/deploy-guide/source/swift-guide.rst b/deploy-guide/source/swift-guide.rst
new file mode 100644
index 0000000000..d7c5766241
--- /dev/null
+++ b/deploy-guide/source/swift-guide.rst
@@ -0,0 +1,2 @@
+.. swift-guide.rst:
+.. include:: ../../doc/swift-guide.rst
diff --git a/deploy-guide/source/troubleshooting.rst b/deploy-guide/source/troubleshooting.rst
new file mode 100644
index 0000000000..9601abcdda
--- /dev/null
+++ b/deploy-guide/source/troubleshooting.rst
@@ -0,0 +1,2 @@
+.. troubleshooting.rst:
+.. include:: ../../doc/troubleshooting.rst
diff --git a/deploy-guide/source/vagrant-dev-env.rst b/deploy-guide/source/vagrant-dev-env.rst
new file mode 100644
index 0000000000..047b471b77
--- /dev/null
+++ b/deploy-guide/source/vagrant-dev-env.rst
@@ -0,0 +1,2 @@
+.. vagrant-dev-env.rst:
+.. include:: ../../doc/vagrant-dev-env.rst
diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst
index ae56e532cd..77d587a116 100644
--- a/doc/troubleshooting.rst
+++ b/doc/troubleshooting.rst
@@ -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,
execute:
-Production
-==========
-
::
kolla-ansible prechecks
-Development
-===========
-
-::
-
- ./tools/kolla-ansible prechecks
-
If a failure during deployment occurs it nearly always occurs during evaluation
of the software. Once the Operator learns the few configuration options
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
remove the failed deployment:
-Production
-==========
-
::
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
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
must be refreshed with the latest images before a new deployment can occur. To
refresh the docker cache from the local Docker registry:
-Production
-==========
-
::
kolla-ansible pull
-Development
-===========
-
-::
-
- ./tools/kolla-ansible pull
-
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
Kolla.
-.. _launchpad bug: https://bugs.launchpad.net/kolla/+filebug
+.. _launchpad bug: https://bugs.launchpad.net/kolla-ansible/+filebug
--
GitLab