rearrange existing docs to fit the new standard layout
Refer to https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html for details. Change-Id: Icd7cca752c8b87eb4543f0307bbf6e7ae07194b5 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
3ec5f770a7
commit
0859794433
10
doc/source/admin/index.rst
Normal file
10
doc/source/admin/index.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
=======================
|
||||||
|
Administrator's Guide
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
building_guest_images.rst
|
||||||
|
guest_cloud_init.rst
|
||||||
|
secure_oslo_messaging.rst
|
14
doc/source/contributor/index.rst
Normal file
14
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
=======================
|
||||||
|
Contributor Resources
|
||||||
|
=======================
|
||||||
|
|
||||||
|
For those wishing to develop Trove itself, or to extend Trove's
|
||||||
|
functionality, the following resources are provided.
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
design
|
||||||
|
testing
|
||||||
|
how_to_create_a_trove_instance.rst
|
@ -1,93 +0,0 @@
|
|||||||
.. _install:
|
|
||||||
|
|
||||||
==================
|
|
||||||
Trove Installation
|
|
||||||
==================
|
|
||||||
|
|
||||||
Trove is constantly under development. The easiest way to install
|
|
||||||
Trove is using the Trove integration scripts that can be found in
|
|
||||||
git in the `Trove Repository`_.
|
|
||||||
|
|
||||||
|
|
||||||
Steps to set up a Trove Developer Environment
|
|
||||||
=============================================
|
|
||||||
|
|
||||||
----------------
|
|
||||||
Installing trove
|
|
||||||
----------------
|
|
||||||
|
|
||||||
* Install a fresh Ubuntu 14.04 (Trusty Tahr) image (preferably a
|
|
||||||
virtual machine)
|
|
||||||
|
|
||||||
* Make sure we have git installed::
|
|
||||||
|
|
||||||
# apt-get update
|
|
||||||
# apt-get install git -y
|
|
||||||
|
|
||||||
* Add a user named ubuntu if you do not already have one::
|
|
||||||
|
|
||||||
# adduser ubuntu
|
|
||||||
|
|
||||||
* Set the ubuntu user up with sudo access::
|
|
||||||
|
|
||||||
# visudo
|
|
||||||
|
|
||||||
Add *ubuntu ALL=(ALL) NOPASSWD: ALL* to the sudoers file.
|
|
||||||
|
|
||||||
* Login with ubuntu::
|
|
||||||
|
|
||||||
# su ubuntu
|
|
||||||
# mkdir -p /opt/stack
|
|
||||||
# cd /opt/stack
|
|
||||||
|
|
||||||
* Clone this repo::
|
|
||||||
|
|
||||||
# git clone https://git.openstack.org/openstack/trove.git
|
|
||||||
|
|
||||||
* cd into the scripts directory::
|
|
||||||
|
|
||||||
# cd trove/integration/scripts/
|
|
||||||
|
|
||||||
It is important to understand that this process is different now with
|
|
||||||
the elements and scripts being part of the trove repository. In the
|
|
||||||
past, one could clone trove-integration into the home directory and
|
|
||||||
run trovestack from there, and it would clone trove in the right
|
|
||||||
place. And if you were making changes in trove-integration, it didn't
|
|
||||||
really matter where trove-integration was; it could be in home
|
|
||||||
directory or /opt/stack, or for that matter, anywhere. This is no
|
|
||||||
longer the case. If you are making changes to trove and would like to
|
|
||||||
run the trovestack script, you have to be sure that trove is in fact
|
|
||||||
cloned in /opt/stack as shown above.
|
|
||||||
|
|
||||||
|
|
||||||
---------------------------------
|
|
||||||
Running trovestack to setup Trove
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
Now you run trovestack to help setup your development environment. For
|
|
||||||
complete details about the trovestack script refer to
|
|
||||||
trove/integration/README.md
|
|
||||||
|
|
||||||
------------------------
|
|
||||||
Running the trove client
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
* The trove client is run using the trove command. You can show the
|
|
||||||
complete documentation on the shell by running trove help::
|
|
||||||
|
|
||||||
# trove help
|
|
||||||
|
|
||||||
|
|
||||||
-----------------------
|
|
||||||
Running the nova client
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
* The nova client is run using the nova command. You can show the
|
|
||||||
complete documentation on the shell by running nova help:::
|
|
||||||
|
|
||||||
# nova help
|
|
||||||
|
|
||||||
References
|
|
||||||
==========
|
|
||||||
|
|
||||||
.. _Trove Repository: https://git.openstack.org/cgit/openstack/trove
|
|
@ -2,9 +2,6 @@
|
|||||||
Welcome to Trove's developer documentation!
|
Welcome to Trove's developer documentation!
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
Introduction
|
|
||||||
============
|
|
||||||
|
|
||||||
Trove is Database as a Service for OpenStack. It's designed to run
|
Trove is Database as a Service for OpenStack. It's designed to run
|
||||||
entirely on OpenStack, with the goal of allowing users to quickly and
|
entirely on OpenStack, with the goal of allowing users to quickly and
|
||||||
easily utilize the features of a relational database without the
|
easily utilize the features of a relational database without the
|
||||||
@ -18,42 +15,16 @@ including deployment, configuration, patching, backups, restores, and
|
|||||||
monitoring.
|
monitoring.
|
||||||
|
|
||||||
For an in-depth look at the project's design and structure, see the
|
For an in-depth look at the project's design and structure, see the
|
||||||
:doc:`dev/design` page.
|
:doc:`contributor/design` page.
|
||||||
|
|
||||||
|
|
||||||
Installation And Deployment
|
|
||||||
===========================
|
|
||||||
|
|
||||||
Trove is constantly under development. The easiest way to install
|
|
||||||
Trove is using the Trove integration scripts that can be found in
|
|
||||||
git in the `Trove`_ Repository.
|
|
||||||
|
|
||||||
For further details on how to install Trove using the integration
|
|
||||||
scripts please refer to the :doc:`dev/install` page.
|
|
||||||
|
|
||||||
For further details on how to install Trove to work with existing
|
|
||||||
OpenStack environment please refer to the :doc:`dev/manual_install` page.
|
|
||||||
|
|
||||||
Developer Resources
|
|
||||||
===================
|
|
||||||
|
|
||||||
For those wishing to develop Trove itself, or to extend Trove's
|
|
||||||
functionality, the following resources are provided.
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
|
install/index
|
||||||
|
admin/index
|
||||||
|
contributor/index
|
||||||
|
reference/index
|
||||||
|
|
||||||
dev/design
|
|
||||||
dev/testing
|
|
||||||
dev/install
|
|
||||||
dev/manual_install.rst
|
|
||||||
dev/building_guest_images.rst
|
|
||||||
dev/guest_cloud_init.rst
|
|
||||||
dev/notifier.rst
|
|
||||||
dev/trove_api_extensions.rst
|
|
||||||
dev/secure_oslo_messaging.rst
|
|
||||||
deploy/apache-mod-wsgi
|
|
||||||
dev/how_to_create_a_trove_instance.rst
|
|
||||||
|
|
||||||
* Source Code Repositories
|
* Source Code Repositories
|
||||||
|
|
||||||
|
@ -4,8 +4,13 @@ Database service
|
|||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
|
apache-mod-wsgi.rst
|
||||||
get_started.rst
|
get_started.rst
|
||||||
install.rst
|
install.rst
|
||||||
|
install-obs.rst
|
||||||
|
install-rdo.rst
|
||||||
|
install-ubuntu.rst
|
||||||
|
manual_install.rst
|
||||||
dashboard.rst
|
dashboard.rst
|
||||||
verify.rst
|
verify.rst
|
||||||
next-steps.rst
|
next-steps.rst
|
9
doc/source/reference/index.rst
Normal file
9
doc/source/reference/index.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
==================
|
||||||
|
Reference Guides
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
notifier.rst
|
||||||
|
trove_api_extensions.rst
|
Loading…
Reference in New Issue
Block a user