From c57ae019d205c107c75f28988f13a2643ba59fe9 Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Thu, 4 May 2017 11:14:13 +0100 Subject: [PATCH] [ops-guide] Removing 'draft' from operations-guide 1. Also adds intro context to index.rst Change-Id: Icab5381fed34bc57c11140fcbc6cd28540264075 Implements: blueprint create-ops-guide --- doc/source/draft-operations-guide/index.rst | 16 ------------ doc/source/index.rst | 2 +- .../advanced-config.rst | 0 doc/source/operations-guide/index.rst | 25 +++++++++++++++++++ .../maintenance-tasks.rst | 4 +-- .../maintenance-tasks/ansible-modules.rst | 0 .../maintenance-tasks/backups.rst | 0 .../maintenance-tasks/containers.rst | 0 .../maintenance-tasks/firewalls.rst | 0 .../maintenance-tasks/galera.rst | 0 .../maintenance-tasks/managing-swift.rst | 0 .../maintenance-tasks/network-maintain.rst | 0 .../maintenance-tasks/rabbitmq-maintain.rst | 0 .../maintenance-tasks/scale-environment.rst | 0 .../monitor-environment.rst | 0 .../monitoring-systems.rst | 0 .../openstack-operations.rst | 4 +-- .../openstack-operations/cli-operations.rst | 0 .../openstack-operations/managing-images.rst | 0 .../managing-instances.rst | 0 .../openstack-operations/network-service.rst | 0 .../openstack-operations/verify-deploy.rst | 0 .../ref-info.rst | 0 .../ref-info/ansible-scripts.rst | 0 .../ref-info/lxc-commands.rst | 0 .../troubleshooting.rst | 0 26 files changed, 30 insertions(+), 21 deletions(-) delete mode 100644 doc/source/draft-operations-guide/index.rst rename doc/source/{draft-operations-guide => operations-guide}/advanced-config.rst (100%) create mode 100644 doc/source/operations-guide/index.rst rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks.rst (82%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/ansible-modules.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/backups.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/containers.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/firewalls.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/galera.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/managing-swift.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/network-maintain.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/rabbitmq-maintain.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/maintenance-tasks/scale-environment.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/monitor-environment.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/monitor-environment/monitoring-systems.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations.rst (67%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations/cli-operations.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations/managing-images.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations/managing-instances.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations/network-service.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/openstack-operations/verify-deploy.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/ref-info.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/ref-info/ansible-scripts.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/ref-info/lxc-commands.rst (100%) rename doc/source/{draft-operations-guide => operations-guide}/troubleshooting.rst (100%) diff --git a/doc/source/draft-operations-guide/index.rst b/doc/source/draft-operations-guide/index.rst deleted file mode 100644 index e75c1f28a9..0000000000 --- a/doc/source/draft-operations-guide/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -================ -Operations guide -================ - -This is a draft index page for the proposed OpenStack-Ansible -operations guide. - -.. toctree:: - :maxdepth: 3 - - openstack-operations.rst - maintenance-tasks.rst - monitor-environment.rst - troubleshooting.rst - advanced-config.rst - ref-info.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index e72fddd440..128c00ab96 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -19,7 +19,7 @@ OpenStack-Ansible Pike is currently in development. Deployment Guide Release Notes - draft-operations-guide/index + operations-guide/index upgrade-guide/index developer-docs/index inventory/index diff --git a/doc/source/draft-operations-guide/advanced-config.rst b/doc/source/operations-guide/advanced-config.rst similarity index 100% rename from doc/source/draft-operations-guide/advanced-config.rst rename to doc/source/operations-guide/advanced-config.rst diff --git a/doc/source/operations-guide/index.rst b/doc/source/operations-guide/index.rst new file mode 100644 index 0000000000..64b1c0c487 --- /dev/null +++ b/doc/source/operations-guide/index.rst @@ -0,0 +1,25 @@ +================ +Operations guide +================ + +This guide provides information about operating your OpenStack-Ansible +deployment. + +For information how to deploy your OpenStack-Ansible cloud, refer to the +`Deployment Guide `_ +for step-by-step instructions on how to deploy the OpenStack packages and +dependencies on your cloud using OpenStack-Ansible. + +We recommend that users of this guide have successfully deployed an +OpenStack-Ansible cloud and are able to perform basic operations such as +adding images, booting instances, and attaching volumes. + +.. toctree:: + :maxdepth: 3 + + openstack-operations.rst + maintenance-tasks.rst + monitor-environment.rst + troubleshooting.rst + advanced-config.rst + ref-info.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks.rst b/doc/source/operations-guide/maintenance-tasks.rst similarity index 82% rename from doc/source/draft-operations-guide/maintenance-tasks.rst rename to doc/source/operations-guide/maintenance-tasks.rst index fcd28a2f45..c55c7ef0b2 100644 --- a/doc/source/draft-operations-guide/maintenance-tasks.rst +++ b/doc/source/operations-guide/maintenance-tasks.rst @@ -2,8 +2,8 @@ Maintenance tasks ================= -This is a draft maintenance tasks page for the proposed OpenStack-Ansible -operations guide. +This chapter is intended for OpenStack-Ansible specific +maintenance tasks. .. toctree:: :maxdepth: 2 diff --git a/doc/source/draft-operations-guide/maintenance-tasks/ansible-modules.rst b/doc/source/operations-guide/maintenance-tasks/ansible-modules.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/ansible-modules.rst rename to doc/source/operations-guide/maintenance-tasks/ansible-modules.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/backups.rst b/doc/source/operations-guide/maintenance-tasks/backups.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/backups.rst rename to doc/source/operations-guide/maintenance-tasks/backups.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/containers.rst b/doc/source/operations-guide/maintenance-tasks/containers.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/containers.rst rename to doc/source/operations-guide/maintenance-tasks/containers.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/firewalls.rst b/doc/source/operations-guide/maintenance-tasks/firewalls.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/firewalls.rst rename to doc/source/operations-guide/maintenance-tasks/firewalls.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/galera.rst b/doc/source/operations-guide/maintenance-tasks/galera.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/galera.rst rename to doc/source/operations-guide/maintenance-tasks/galera.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/managing-swift.rst b/doc/source/operations-guide/maintenance-tasks/managing-swift.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/managing-swift.rst rename to doc/source/operations-guide/maintenance-tasks/managing-swift.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/network-maintain.rst b/doc/source/operations-guide/maintenance-tasks/network-maintain.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/network-maintain.rst rename to doc/source/operations-guide/maintenance-tasks/network-maintain.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/rabbitmq-maintain.rst b/doc/source/operations-guide/maintenance-tasks/rabbitmq-maintain.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/rabbitmq-maintain.rst rename to doc/source/operations-guide/maintenance-tasks/rabbitmq-maintain.rst diff --git a/doc/source/draft-operations-guide/maintenance-tasks/scale-environment.rst b/doc/source/operations-guide/maintenance-tasks/scale-environment.rst similarity index 100% rename from doc/source/draft-operations-guide/maintenance-tasks/scale-environment.rst rename to doc/source/operations-guide/maintenance-tasks/scale-environment.rst diff --git a/doc/source/draft-operations-guide/monitor-environment.rst b/doc/source/operations-guide/monitor-environment.rst similarity index 100% rename from doc/source/draft-operations-guide/monitor-environment.rst rename to doc/source/operations-guide/monitor-environment.rst diff --git a/doc/source/draft-operations-guide/monitor-environment/monitoring-systems.rst b/doc/source/operations-guide/monitor-environment/monitoring-systems.rst similarity index 100% rename from doc/source/draft-operations-guide/monitor-environment/monitoring-systems.rst rename to doc/source/operations-guide/monitor-environment/monitoring-systems.rst diff --git a/doc/source/draft-operations-guide/openstack-operations.rst b/doc/source/operations-guide/openstack-operations.rst similarity index 67% rename from doc/source/draft-operations-guide/openstack-operations.rst rename to doc/source/operations-guide/openstack-operations.rst index 22d6328ddb..563d0ab367 100644 --- a/doc/source/draft-operations-guide/openstack-operations.rst +++ b/doc/source/operations-guide/openstack-operations.rst @@ -2,8 +2,8 @@ OpenStack operations ==================== -This is a draft OpenStack operations page for the proposed OpenStack-Ansible -operations guide. +This chapter is intended to document basic OpenStack operations tasks that +are integral to the operations support in an OpenStack-Ansible deployment. .. toctree:: :maxdepth: 2 diff --git a/doc/source/draft-operations-guide/openstack-operations/cli-operations.rst b/doc/source/operations-guide/openstack-operations/cli-operations.rst similarity index 100% rename from doc/source/draft-operations-guide/openstack-operations/cli-operations.rst rename to doc/source/operations-guide/openstack-operations/cli-operations.rst diff --git a/doc/source/draft-operations-guide/openstack-operations/managing-images.rst b/doc/source/operations-guide/openstack-operations/managing-images.rst similarity index 100% rename from doc/source/draft-operations-guide/openstack-operations/managing-images.rst rename to doc/source/operations-guide/openstack-operations/managing-images.rst diff --git a/doc/source/draft-operations-guide/openstack-operations/managing-instances.rst b/doc/source/operations-guide/openstack-operations/managing-instances.rst similarity index 100% rename from doc/source/draft-operations-guide/openstack-operations/managing-instances.rst rename to doc/source/operations-guide/openstack-operations/managing-instances.rst diff --git a/doc/source/draft-operations-guide/openstack-operations/network-service.rst b/doc/source/operations-guide/openstack-operations/network-service.rst similarity index 100% rename from doc/source/draft-operations-guide/openstack-operations/network-service.rst rename to doc/source/operations-guide/openstack-operations/network-service.rst diff --git a/doc/source/draft-operations-guide/openstack-operations/verify-deploy.rst b/doc/source/operations-guide/openstack-operations/verify-deploy.rst similarity index 100% rename from doc/source/draft-operations-guide/openstack-operations/verify-deploy.rst rename to doc/source/operations-guide/openstack-operations/verify-deploy.rst diff --git a/doc/source/draft-operations-guide/ref-info.rst b/doc/source/operations-guide/ref-info.rst similarity index 100% rename from doc/source/draft-operations-guide/ref-info.rst rename to doc/source/operations-guide/ref-info.rst diff --git a/doc/source/draft-operations-guide/ref-info/ansible-scripts.rst b/doc/source/operations-guide/ref-info/ansible-scripts.rst similarity index 100% rename from doc/source/draft-operations-guide/ref-info/ansible-scripts.rst rename to doc/source/operations-guide/ref-info/ansible-scripts.rst diff --git a/doc/source/draft-operations-guide/ref-info/lxc-commands.rst b/doc/source/operations-guide/ref-info/lxc-commands.rst similarity index 100% rename from doc/source/draft-operations-guide/ref-info/lxc-commands.rst rename to doc/source/operations-guide/ref-info/lxc-commands.rst diff --git a/doc/source/draft-operations-guide/troubleshooting.rst b/doc/source/operations-guide/troubleshooting.rst similarity index 100% rename from doc/source/draft-operations-guide/troubleshooting.rst rename to doc/source/operations-guide/troubleshooting.rst