diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index 54588a94a3..35b1451524 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -129,6 +129,9 @@ + + + diff --git a/doc/cli-reference/generated/ch_cli_tuskar_commands.xml b/doc/cli-reference/generated/ch_cli_tuskar_commands.xml new file mode 100644 index 0000000000..38ad363016 --- /dev/null +++ b/doc/cli-reference/generated/ch_cli_tuskar_commands.xml @@ -0,0 +1,585 @@ + + + + + + + + Deployment command-line client + + The tuskar client is the command-line + interface (CLI) for the Deployment API and its extensions. + + This chapter documents tuskar version + 0.1.18. + + + For help on a specific tuskar + command, enter: + + $ tuskar COMMAND + +
+ tuskar usage + 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] + <subcommand> ... + <subcommand> + 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. +
+
+ tuskar optional arguments + + + -h, --help + + + Print this help message and exit. + + + + + --version + + + Shows the client version and exits. + + + + + -d, --debug + + + Defaults to env[TUSKARCLIENT_DEBUG]. + + + + + --os-username OS_USERNAME + + + Defaults to env[OS_USERNAME] + + + + + --os-password OS_PASSWORD + + + Defaults to env[OS_PASSWORD] + + + + + --os-tenant-id OS_TENANT_ID + + + Defaults to env[OS_TENANT_ID] + + + + + --os-tenant-name OS_TENANT_NAME + + + Defaults to env[OS_TENANT_NAME] + + + + + --os-auth-url OS_AUTH_URL + + + Defaults to env[OS_AUTH_URL] + + + + + --os-auth-token OS_AUTH_TOKEN + + + Defaults to env[OS_AUTH_TOKEN] + + + + + --tuskar-url TUSKAR_URL + + + Defaults to env[TUSKAR_URL] + + + + + --tuskar-api-version TUSKAR_API_VERSION + + + Defaults to env[TUSKAR_API_VERSION] or 2 + + + + +
+
+ tuskar plan-add-role + usage: tuskar plan-add-role [-h] -r <ROLE UUID> plan_uuid + +Associate role to a plan. + + Positional arguments + + plan_uuid + + + UUID of the Plan to assign role to. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -r <ROLE UUID>, --role-uuid <ROLE UUID> + + + UUID of the Role to be assigned. + + + + +
+
+ tuskar plan-create + usage: tuskar plan-create [-h] [-d <DESCRIPTION>] name + +Create a new plan. + + Positional arguments + + name + + + Name of the Plan to create. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -d <DESCRIPTION>, --description <DESCRIPTION> + + + User-readable text describing the Plan. + + + + +
+
+ tuskar plan-delete + usage: tuskar plan-delete [-h] <PLAN> + +Delete an plan by its UUID. + + Positional arguments + + <PLAN> + + + UUID of the plan to delete. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ tuskar plan-flavor + usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid + +Change flavor of role in the plan. + + Positional arguments + + role_name + + + Name of role which you want to flavor. + + + + + plan_uuid + + + UUID of the Plan to modify. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -F FLAVOR, --flavor FLAVOR + + + Flavor which shall be assigned to role. + + + + +
+
+ tuskar plan-list + usage: tuskar plan-list [-h] + +Show a list of the Plans. + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ tuskar plan-remove-role + usage: tuskar plan-remove-role [-h] -r <ROLE UUID> plan_uuid + +Remove role from a plan. + + Positional arguments + + plan_uuid + + + UUID of the Plan to remove role from. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -r <ROLE UUID>, --role-uuid <ROLE UUID> + + + UUID of the Role to be removed. + + + + +
+
+ tuskar plan-scale + usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid + +Scale plan by changing count of roles. + + Positional arguments + + role_name + + + Name of role which you want scale. + + + + + plan_uuid + + + UUID of the Plan to modify. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -C COUNT, --count COUNT + + + Count of nodes to be set. + + + + +
+
+ tuskar plan-show + usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] <PLAN> + +Show an individual Plan by its UUID. + + Positional arguments + + <PLAN> + + + UUID of the Plan to show. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --verbose + + + Display full plan details + + + + + --only-empty-parameters + + + Display only parameters with empty or None value + + + + +
+
+ tuskar plan-show-flavors + usage: tuskar plan-show-flavors [-h] <PLAN> + +Show flavors assigned to roles of Plan. + + Positional arguments + + <PLAN> + + + UUID of the Plan to show a scale. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ tuskar plan-show-scale + usage: tuskar plan-show-scale [-h] <PLAN> + +Show scale counts of Plan. + + Positional arguments + + <PLAN> + + + UUID of the Plan to show a scale. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ tuskar plan-templates + usage: tuskar plan-templates [-h] -O <OUTPUT DIR> plan_uuid + +Download the Heat templates for a Plan. + + Positional arguments + + plan_uuid + + + UUID of the Plan whose Templates will be retrieved. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -O <OUTPUT DIR>, --output-dir <OUTPUT DIR> + + + Directory to write template files into. It will be + created if it does not exist. + + + + +
+
+ tuskar plan-update + usage: tuskar plan-update [-h] [-A <KEY1=VALUE1>] [-P <KEY1=VALUE1>] plan_uuid + +Change an existing plan. + + Positional arguments + + plan_uuid + + + UUID of the Plan to modify. + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + -A <KEY1=VALUE1>, --attribute <KEY1=VALUE1> + + + This can be specified multiple times. This argument is + deprecated, use -P and --parameter instead. + + + + + -P <KEY1=VALUE1>, --parameter <KEY1=VALUE1> + + + This can be specified multiple times. + + + + +
+
+ tuskar role-list + usage: tuskar role-list [-h] + +Show a list of the Roles. + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+ diff --git a/doc/common-rst/app_support.rst b/doc/common-rst/app_support.rst index b04db8e033..f946271bcf 100644 --- a/doc/common-rst/app_support.rst +++ b/doc/common-rst/app_support.rst @@ -179,6 +179,8 @@ The following Launchpad Bugs areas are available: - `Bugs: Database service (trove) `__ +- `Bugs: Deployment service (tuskar) `__ + - `Bugs: Key Manager Service (barbican) `__ - `Bugs: Orchestration (heat) `__ diff --git a/doc/common-rst/cli_install_openstack_command_line_clients.rst b/doc/common-rst/cli_install_openstack_command_line_clients.rst index 8265974196..3bf74af41e 100644 --- a/doc/common-rst/cli_install_openstack_command_line_clients.rst +++ b/doc/common-rst/cli_install_openstack_command_line_clients.rst @@ -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 diff --git a/doc/common-rst/cli_overview.rst b/doc/common-rst/cli_overview.rst index 9964f5c230..47d6e51096 100644 --- a/doc/common-rst/cli_overview.rst +++ b/doc/common-rst/cli_overview.rst @@ -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 | diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml index f5d7b664d5..6d50ff2e0c 100644 --- a/doc/common/app_support.xml +++ b/doc/common/app_support.xml @@ -306,6 +306,11 @@ xlink:href="https://bugs.launchpad.net/trove" >Bugs: Database service (trove) + + Bugs: Deployment service (tuskar) + trove - Database service API + + tuskar - Deployment service + API + magnum - Containers service API diff --git a/doc/common/section_cli_overview.xml b/doc/common/section_cli_overview.xml index c2b30f2c33..1611425579 100644 --- a/doc/common/section_cli_overview.xml +++ b/doc/common/section_cli_overview.xml @@ -80,6 +80,12 @@ python-saharaclient Creates and manages Hadoop clusters on OpenStack. + + Deployment service + tuskar + python-tuskarclient + Plan Deployments. + Identity openstack