openstack/openstack-manuals
Code Issues Proposed changes

Add tuskar to common and CLI reference

Browse Source 
Add tuskar to Chapter1
  (for CLI Ref)
Add tuskar to Appendix
  (common part includes CLI Ref/Config Ref)
Add tuskar CLI Ref XML 0.1.18 (autogenerated)

Change-Id: I89e2bf283081b61d9339cc8a046a3b184c438e9b
This commit is contained in:
Atsushi SAKAI 2015-09-30 22:15:35 +09:00
parent 046de3d84b
commit 5abf1c99f6
8 changed files with 610 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/cli-reference/bk-cli-reference.xml
View File

@ -129,6 +129,9 @@
<!-- Data processing (sahara) -->
<xi:include href="generated/ch_cli_sahara_commands.xml"/>
<!-- Deployment service (tuskar) -->
<xi:include href="generated/ch_cli_tuskar_commands.xml"/>
<!-- DNS service (designate) -->
<xi:include href="generated/ch_cli_designate_commands.xml"/>

585
doc/cli-reference/generated/ch_cli_tuskar_commands.xml Normal file
View File

@ -0,0 +1,585 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="tuskarclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Deployment command-line client</title>
<para>The <command>tuskar</command> client is the command-line
interface (CLI) for the Deployment API and its extensions.
This chapter documents <command>tuskar</command> version
<literal>0.1.18</literal>.
</para>
<para>For help on a specific <command>tuskar</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>tuskar</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="tuskarclient_command_usage">
<title>tuskar usage</title>
<screen><computeroutput>usage: tuskar [-h] [--version] [-d] [--os-username OS_USERNAME]
[--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID]
[--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL]
[--os-auth-token OS_AUTH_TOKEN] [--tuskar-url TUSKAR_URL]
[--tuskar-api-version TUSKAR_API_VERSION]
&lt;subcommand&gt; ...
&lt;subcommand&gt;
plan-add-role Associate role to a plan.
plan-create Create a new plan.
plan-delete Delete an plan by its UUID.
plan-flavor Change flavor of role in the plan.
plan-list Show a list of the Plans.
plan-patch Change an existing plan [Deprecated].
plan-remove-role Remove role from a plan.
plan-scale Scale plan by changing count of roles.
plan-show Show an individual Plan by its UUID.
plan-show-flavors Show flavors assigned to roles of Plan.
plan-show-scale Show scale counts of Plan.
plan-templates Download the Heat templates for a Plan.
plan-update Change an existing plan.
role-list Show a list of the Roles.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</section>
<section xml:id="tuskarclient_command_optional">
<title>tuskar optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
Print this help message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
Shows the client version and exits.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d, --debug</command></term>
<listitem>
<para>
Defaults to <code>env[TUSKARCLIENT_DEBUG]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username OS_USERNAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USERNAME]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password OS_PASSWORD</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PASSWORD]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-id OS_TENANT_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_ID]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name OS_TENANT_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_NAME]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url OS_AUTH_URL</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_URL]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_TOKEN]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--tuskar-url TUSKAR_URL</command></term>
<listitem>
<para>
Defaults to <code>env[TUSKAR_URL]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--tuskar-api-version TUSKAR_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[TUSKAR_API_VERSION]</code> or 2
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-add-role">
<title>tuskar plan-add-role</title>
<screen><computeroutput>usage: tuskar plan-add-role [-h] -r &lt;ROLE UUID&gt; plan_uuid</computeroutput></screen>
<para>
Associate role to a plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan to assign role to.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-r &lt;ROLE UUID&gt;, --role-uuid &lt;ROLE UUID&gt;</command></term>
<listitem>
<para>
UUID of the Role to be assigned.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-create">
<title>tuskar plan-create</title>
<screen><computeroutput>usage: tuskar plan-create [-h] [-d &lt;DESCRIPTION&gt;] name</computeroutput></screen>
<para>
Create a new plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of the Plan to create.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d &lt;DESCRIPTION&gt;, --description &lt;DESCRIPTION&gt;</command></term>
<listitem>
<para>
User-readable text describing the Plan.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-delete">
<title>tuskar plan-delete</title>
<screen><computeroutput>usage: tuskar plan-delete [-h] &lt;PLAN&gt;</computeroutput></screen>
<para>
Delete an plan by its UUID.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;PLAN&gt;</command></term>
<listitem>
<para>
UUID of the plan to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-flavor">
<title>tuskar plan-flavor</title>
<screen><computeroutput>usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid</computeroutput></screen>
<para>
Change flavor of role in the plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>role_name</command></term>
<listitem>
<para>
Name of role which you want to flavor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-F FLAVOR, --flavor FLAVOR</command></term>
<listitem>
<para>
Flavor which shall be assigned to role.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-list">
<title>tuskar plan-list</title>
<screen><computeroutput>usage: tuskar plan-list [-h]</computeroutput></screen>
<para>
Show a list of the Plans.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-remove-role">
<title>tuskar plan-remove-role</title>
<screen><computeroutput>usage: tuskar plan-remove-role [-h] -r &lt;ROLE UUID&gt; plan_uuid</computeroutput></screen>
<para>
Remove role from a plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan to remove role from.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-r &lt;ROLE UUID&gt;, --role-uuid &lt;ROLE UUID&gt;</command></term>
<listitem>
<para>
UUID of the Role to be removed.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-scale">
<title>tuskar plan-scale</title>
<screen><computeroutput>usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid</computeroutput></screen>
<para>
Scale plan by changing count of roles.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>role_name</command></term>
<listitem>
<para>
Name of role which you want scale.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-C COUNT, --count COUNT</command></term>
<listitem>
<para>
Count of nodes to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-show">
<title>tuskar plan-show</title>
<screen><computeroutput>usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] &lt;PLAN&gt;</computeroutput></screen>
<para>
Show an individual Plan by its UUID.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;PLAN&gt;</command></term>
<listitem>
<para>
UUID of the Plan to show.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--verbose</command></term>
<listitem>
<para>
Display full plan details
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--only-empty-parameters</command></term>
<listitem>
<para>
Display only parameters with empty or None value
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-show-flavors">
<title>tuskar plan-show-flavors</title>
<screen><computeroutput>usage: tuskar plan-show-flavors [-h] &lt;PLAN&gt;</computeroutput></screen>
<para>
Show flavors assigned to roles of Plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;PLAN&gt;</command></term>
<listitem>
<para>
UUID of the Plan to show a scale.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-show-scale">
<title>tuskar plan-show-scale</title>
<screen><computeroutput>usage: tuskar plan-show-scale [-h] &lt;PLAN&gt;</computeroutput></screen>
<para>
Show scale counts of Plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;PLAN&gt;</command></term>
<listitem>
<para>
UUID of the Plan to show a scale.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-templates">
<title>tuskar plan-templates</title>
<screen><computeroutput>usage: tuskar plan-templates [-h] -O &lt;OUTPUT DIR&gt; plan_uuid</computeroutput></screen>
<para>
Download the Heat templates for a Plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan whose Templates will be retrieved.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-O &lt;OUTPUT DIR&gt;, --output-dir &lt;OUTPUT DIR&gt;</command></term>
<listitem>
<para>
Directory to write template files into. It will be
created if it does not exist.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_plan-update">
<title>tuskar plan-update</title>
<screen><computeroutput>usage: tuskar plan-update [-h] [-A &lt;KEY1=VALUE1&gt;] [-P &lt;KEY1=VALUE1&gt;] plan_uuid</computeroutput></screen>
<para>
Change an existing plan.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>plan_uuid</command></term>
<listitem>
<para>
UUID of the Plan to modify.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-A &lt;KEY1=VALUE1&gt;, --attribute &lt;KEY1=VALUE1&gt;</command></term>
<listitem>
<para>
This can be specified multiple times. This argument is
deprecated, use -P and --parameter instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-P &lt;KEY1=VALUE1&gt;, --parameter &lt;KEY1=VALUE1&gt;</command></term>
<listitem>
<para>
This can be specified multiple times.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="tuskarclient_subcommand_role-list">
<title>tuskar role-list</title>
<screen><computeroutput>usage: tuskar role-list [-h]</computeroutput></screen>
<para>
Show a list of the Roles.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>

2
doc/common-rst/app_support.rst
View File

@ -179,6 +179,8 @@ The following Launchpad Bugs areas are available:
- `Bugs: Database service (trove) <https://bugs.launchpad.net/trove>`__
- `Bugs: Deployment service (tuskar) <https://bugs.launchpad.net/tuskar>`__
- `Bugs: Key Manager Service (barbican) <https://bugs.launchpad.net/barbican>`__
- `Bugs: Orchestration (heat) <https://bugs.launchpad.net/heat>`__

2
doc/common-rst/cli_install_openstack_command_line_clients.rst
View File

@ -173,6 +173,8 @@ for each client. The following values are valid:
- ``trove`` - Database service API
- ``tuskar`` - Deployment service API
- ``openstack`` - Common OpenStack client supporting multiple services
The following CLIs are deprecated in favor of ``openstack``, the

3
doc/common-rst/cli_overview.rst
View File

@ -51,6 +51,9 @@ service with its package name and description.
| | | |Hadoop clusters on |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+
|Deployment |tuskar |python-tuskarclient |Plan Deployments. |
|service | | | |
+----------------+----------+-----------------------+------------------------+
|Identity |keystone |python-keystoneclient |Create and manage |
| | | |users, tenants, roles, |
| | | |endpoints, and |

5
doc/common/app_support.xml
View File

@ -306,6 +306,11 @@
xlink:href="https://bugs.launchpad.net/trove"
>Bugs: Database service (trove)</link></para>
</listitem>
<listitem>
<para><link
xlink:href="https://bugs.launchpad.net/tuskar"
>Bugs: Deployment service (tuskar)</link></para>
</listitem>
<listitem>
<para><link
xlink:href="https://bugs.launchpad.net/trove"

4
doc/common/section_cli_install.xml
View File

@ -209,6 +209,10 @@
<para><literal>trove</literal> - Database service
API</para>
</listitem>
<listitem>
<para><literal>tuskar</literal> - Deployment service
API</para>
</listitem>
<listitem>
<para><literal>magnum</literal> - Containers service
API</para>

6
doc/common/section_cli_overview.xml
View File

@ -80,6 +80,12 @@
<td><package>python-saharaclient</package></td>
<td>Creates and manages Hadoop clusters on OpenStack.</td>
</tr>
<tr>
<td>Deployment service</td>
<td><command>tuskar</command></td>
<td><package>python-tuskarclient</package></td>
<td>Plan Deployments.</td>
</tr>
<tr>
<td>Identity</td>
<td><command>openstack</command></td>