1ff983782a
The install guide did not have a chapter on how to add the Database service. Created one with the following sections: overview, install, verify. This draft reflects the fact that some technical issues are still being worked out: -- image creation questions. Before you can use Trove, you need to create an image for each flavor of database you want to have (MySQL, MongoDB, etc.) The appropriate level of documentation for this step is still under discussion and has not yet been determined. Change-Id: I31e02f48975c7050022ee6fb8f31b878c6b508ff Partial-Bug: #1304584
72 lines
3.6 KiB
XML
72 lines
3.6 KiB
XML
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
|
xml:id="trove-service">
|
|
<title>Database service overview</title>
|
|
<para>The Database service provides scalable and reliable cloud provisioning functionality for both relational and non-relational database engines. Users can quickly and easily utilize database features without the burden of handling complex administrative tasks. Cloud users and database administrators can provision and manage multiple database instances as needed.</para>
|
|
<para>The Database service provides resource isolation at high performance levels, and automates complex administrative tasks such as deployment, configuration, patching, backups, restores, and monitoring.</para>
|
|
<formalpara>
|
|
<title>Process flow example.</title><para>Here is a high-level process flow example for using Database services:</para>
|
|
</formalpara>
|
|
<procedure>
|
|
<step><para>Administrator sets up infrastructure:</para>
|
|
<substeps>
|
|
<step>
|
|
<para>OpenStack administrator installs the Database service.</para>
|
|
</step>
|
|
<step>
|
|
<para>She creates one image for each type of database the
|
|
administrator wants to have (one for MySQL, one for MongoDB,
|
|
and so on).</para>
|
|
</step>
|
|
<step>
|
|
<para>OpenStack administrator updates the datastore to use the
|
|
new images, using the <command>trove-manage</command>
|
|
command.</para>
|
|
</step>
|
|
</substeps>
|
|
</step>
|
|
<step>
|
|
<para>End user uses database service:</para>
|
|
<substeps>
|
|
<step>
|
|
<para>Now that the basic infrastructure is set up, an end user
|
|
can create a Trove instance (database) whenever the user
|
|
wants, using the <command>trove create</command>
|
|
command.</para>
|
|
</step>
|
|
<step>
|
|
<para>The end user gets the IP address of the Trove instance by using
|
|
the <command>trove list</command> command to get the ID of the instance, and
|
|
then using the <command>trove show <replaceable>instanceID</replaceable></command> command to get the IP address.</para>
|
|
</step>
|
|
<step>
|
|
<para>The end user can now access the Trove instance using typical database access commands. MySQL example:</para>
|
|
<screen><prompt>$</prompt> mysql -u myuser -pmypass -h <replaceable>trove_ip_address</replaceable> mydb</screen>
|
|
</step>
|
|
</substeps>
|
|
</step>
|
|
</procedure>
|
|
<formalpara>
|
|
<title>Components:</title><para>The Database service includes the following components:</para>
|
|
</formalpara>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><code>python-troveclient</code> command-line client. A CLI that communicates with the <code>trove-api</code> component.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>trove-api</code> component. Provides an
|
|
OpenStack-native RESTful API that supports JSON to provision and manage Trove instances.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>trove-conductor</code> service. Runs on the host, and receives messages from guest instances that want to update information on the host.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>trove-taskmanager</code> service. Instruments the complex system flows that support provisioning instances, managing the lifecycle of instances, and performing operations on instances.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><code>trove-guestagent</code> service. Runs within the guest instance. Manages and performs operations on the database itself.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</section>
|