From 84af1645ac8b98389cea134f3d4c9e5df78cf61c Mon Sep 17 00:00:00 2001 From: David Rabel Date: Sat, 28 Oct 2017 16:31:45 +0200 Subject: [PATCH] Fix indent in docs Change-Id: Ic83980366fda6ce82e04a3c45777092ef14bae5f --- doc/source/install/dashboard.rst | 24 ++++----- doc/source/install/manual_install.rst | 74 +++++++++++++-------------- 2 files changed, 49 insertions(+), 49 deletions(-) diff --git a/doc/source/install/dashboard.rst b/doc/source/install/dashboard.rst index c38640d6a8..fe4936ea22 100644 --- a/doc/source/install/dashboard.rst +++ b/doc/source/install/dashboard.rst @@ -4,21 +4,21 @@ Install and configure the Trove dashboard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - * Installation of the Trove dashboard for Horizon is straightforward. - It is best to install it via pip. +* Installation of the Trove dashboard for Horizon is straightforward. + It is best to install it via pip. - .. code-block:: console + .. code-block:: console - # pip install trove-dashboard + # pip install trove-dashboard - * The command above will install the latest version which is - appropriate if you are running the latest Trove. If you are - running an earlier version of Trove you may need to specify - a compatible version of trove-dashboard. +* The command above will install the latest version which is + appropriate if you are running the latest Trove. If you are + running an earlier version of Trove you may need to specify + a compatible version of trove-dashboard. - * After pip installs it, locate the trove-dashboard directory and - copy the contents of the ``enabled/`` directory to your horizon - ``openstack_dashboard/local/enabled/`` directory. +* After pip installs it, locate the trove-dashboard directory and + copy the contents of the ``enabled/`` directory to your horizon + ``openstack_dashboard/local/enabled/`` directory. - * Reload Apache to pick up the changes to Horizon. +* Reload Apache to pick up the changes to Horizon. diff --git a/doc/source/install/manual_install.rst b/doc/source/install/manual_install.rst index 0edb431f86..18d8c68a29 100644 --- a/doc/source/install/manual_install.rst +++ b/doc/source/install/manual_install.rst @@ -12,34 +12,34 @@ an existing OpenStack environment for development purposes. This document will not cover: - - OpenStack setup - - Trove service configuration +- OpenStack setup +- Trove service configuration Requirements ============ A running OpenStack environment is required, including the following components: - - Compute (Nova) - - Image Service (Glance) - - Identity (Keystone) - - A networking component (either Neutron or Nova-Network) - - If you want to provision datastores on block-storage volumes, you also will need Block Storage (Cinder) - - If you want to do backup/restore and replication, you will also need Object Storage (Swift) - - An environment with a freshly installed Ubuntu 14.04 LTS to run Trove services. - This will be referred to as "local environment" - - AMQP service (RabbitMQ or QPID) - - MySQL (SQLite, PostgreSQL) database for Trove's internal needs, accessible from the local environment - - Certain OpenStack services must be accessible from VMs: - - Swift +- Compute (Nova) +- Image Service (Glance) +- Identity (Keystone) +- A networking component (either Neutron or Nova-Network) +- If you want to provision datastores on block-storage volumes, you also will need Block Storage (Cinder) +- If you want to do backup/restore and replication, you will also need Object Storage (Swift) +- An environment with a freshly installed Ubuntu 14.04 LTS to run Trove services. + This will be referred to as "local environment" +- AMQP service (RabbitMQ or QPID) +- MySQL (SQLite, PostgreSQL) database for Trove's internal needs, accessible from the local environment +- Certain OpenStack services must be accessible from VMs: + - Swift - - VMs must be accessible from local environment for development/debugging purposes +- VMs must be accessible from local environment for development/debugging purposes - - OpenStack services must be accessible directly from the local environment, such as: - - Nova - - Cinder - - Swift - - Heat +- OpenStack services must be accessible directly from the local environment, such as: + - Nova + - Cinder + - Swift + - Heat Installation ============ @@ -50,14 +50,14 @@ Gather info The following information about the existing environment is required: - - Keystone host and port(s) - - OpenStack administrator's username, tenant name and password - - Nova URL - - Cinder URL - - Swift URL - - Heat URL - - AMQP connection credentials (server URL, user, password) - - Trove's controller backend connection string (MySQL, SQLite, PostgreSQL) +- Keystone host and port(s) +- OpenStack administrator's username, tenant name and password +- Nova URL +- Cinder URL +- Swift URL +- Heat URL +- AMQP connection credentials (server URL, user, password) +- Trove's controller backend connection string (MySQL, SQLite, PostgreSQL) -------------------- Install dependencies @@ -190,11 +190,11 @@ Prepare Trove configuration files There are several configuration files for Trove: - - api-paste.ini and trove.conf — For trove-api service - - trove-taskmanager.conf — For trove-taskmanager service - - trove-guestagent.conf — For trove-guestagent service - - trove-conductor.conf — For trove-conductor service - - .cloudinit — Userdata for VMs during provisioning +- api-paste.ini and trove.conf — For trove-api service +- trove-taskmanager.conf — For trove-taskmanager service +- trove-guestagent.conf — For trove-guestagent service +- trove-conductor.conf — For trove-conductor service +- .cloudinit — Userdata for VMs during provisioning Cloud-init scripts are userdata that is being used for different datastore types like mysql/percona, cassandra, mongodb, redis, couchbase while provisioning new compute instances. @@ -242,7 +242,7 @@ Cloud-init content Each cloud-init script for Trove-compatible images should contain: - - Trove installation +- Trove installation Custom images with Trove code inside ==================================== @@ -254,9 +254,9 @@ Prepare the database Create the Trove database schema: - - Connect to the storage backend (MySQL, PostgreSQL) - - Create a database called `trove` (this database will be used for storing Trove ORM) - - Compose connection string. Example: mysql+pymysql://:@:/ +- Connect to the storage backend (MySQL, PostgreSQL) +- Create a database called `trove` (this database will be used for storing Trove ORM) +- Compose connection string. Example: mysql+pymysql://:@:/ Initialize the database =======================