From 2cc54ab9a2aaa1421ce2efd605399cb102208864 Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Wed, 9 Dec 2015 21:57:58 +0900 Subject: [PATCH] Add senlin to common and CLI reference Add senlin to Chapter 1 (for CLI Ref) Add senlin to Appendix (common part includes CLI Ref/Config Ref) Add senlin CLI Ref XML 0.1.8 (autogenerated) Change-Id: Iecaa8107b149983bc979e893ef19bcffbc0b2065 --- doc/cli-reference/bk-cli-reference.xml | 3 + .../generated/ch_cli_senlin_commands.xml | 2802 +++++++++++++++++ doc/common-rst/app_support.rst | 2 + ...install_openstack_command_line_clients.rst | 2 + doc/common-rst/cli_overview.rst | 3 + doc/common/app_support.xml | 5 + doc/common/section_cli_install.xml | 4 + doc/common/section_cli_overview.xml | 6 + 8 files changed, 2827 insertions(+) create mode 100644 doc/cli-reference/generated/ch_cli_senlin_commands.xml diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index 2bfee65986..97b06344d2 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -49,6 +49,9 @@ + + + diff --git a/doc/cli-reference/generated/ch_cli_senlin_commands.xml b/doc/cli-reference/generated/ch_cli_senlin_commands.xml new file mode 100644 index 0000000000..ed3d2aa9da --- /dev/null +++ b/doc/cli-reference/generated/ch_cli_senlin_commands.xml @@ -0,0 +1,2802 @@ + + + + + + + + Clustering service command-line client + + The senlin client is the command-line + interface (CLI) for the Clustering service API and its extensions. + + This chapter documents senlin version + 0.1.8. + + + For help on a specific senlin + command, enter: + + $ senlin COMMAND + +
+ senlin usage + usage: senlin [--version] [-d] [-v] [--api-timeout API_TIMEOUT] + [--senlin-api-version SENLIN_API_VERSION] + [--os-auth-plugin AUTH_PLUGIN] [--os-auth-url AUTH_URL] + [--os-project-id PROJECT_ID] [--os-project-name PROJECT_NAME] + [--os-tenant-id TENANT_ID] [--os-tenant-name TENANT_NAME] + [--os-domain-id DOMAIN_ID] [--os-domain-name DOMAIN_NAME] + [--os-project-domain-id PROJECT_DOMAIN_ID] + [--os-project-domain-name PROJECT_DOMAIN_NAME] + [--os-user-domain-id USER_DOMAIN_ID] + [--os-user-domain-name USER_DOMAIN_NAME] + [--os-username USERNAME] [--os-user-id USER_ID] + [--os-password PASSWORD] [--os-trust-id TRUST_ID] + [--os-cacert CA_BUNDLE_FILE | --verify | --insecure] + [--os-token TOKEN] [--os-access-info ACCESS_INFO] + [--os-api-name <service>=<name>] + [--os-api-region <service>=<region>] + [--os-api-version <service>=<version>] + [--os-api-interface <service>=<interface>] + <subcommand> ... + + Subcommands + + action-list + + + List actions. + + + + + action-show + + + Show detailed info about the specified action. + + + + + build-info + + + Retrieve build information. + + + + + cluster-create + + + Create the cluster. + + + + + cluster-delete + + + Delete the cluster(s). + + + + + cluster-list + + + List the user's clusters. + + + + + cluster-node-add + + + Add specified nodes to cluster. + + + + + cluster-node-del + + + Delete specified nodes from cluster. + + + + + cluster-node-list + + + List nodes from cluster. + + + + + cluster-policy-attach + + + Attach policy to cluster. + + + + + cluster-policy-detach + + + Detach policy from cluster. + + + + + cluster-policy-disable + + + Disable a policy on a cluster. + + + + + cluster-policy-enable + + + Enable a policy on cluster. + + + + + cluster-policy-list + + + List policies from cluster. + + + + + cluster-policy-show + + + Show a specific policy that is bound to the specified + cluster. + + + + + cluster-policy-update + + + Update a policy on cluster. + + + + + cluster-resize + + + Resize a cluster. + + + + + cluster-scale-in + + + Scale in a cluster by the specified number of nodes. + + + + + cluster-scale-out + + + Scale out a cluster by the specified number of nodes. + + + + + cluster-show + + + Show details of the cluster. + + + + + cluster-update + + + Update the cluster. + + + + + event-list + + + List events. + + + + + event-show + + + Describe the event. + + + + + node-create + + + Create the node. + + + + + node-delete + + + Delete the node(s). + + + + + node-join + + + Make node join the specified cluster. + + + + + node-leave + + + Make node leave its current cluster. + + + + + node-list + + + Show list of nodes. + + + + + node-show + + + Show detailed info about the specified node. + + + + + node-update + + + Update the node. + + + + + policy-create + + + Create a policy. + + + + + policy-delete + + + Delete policy(s). + + + + + policy-list + + + List policies that meet the criteria. + + + + + policy-show + + + Show the policy details. + + + + + policy-type-list + + + List the available policy types. + + + + + policy-type-schema + + + Get the spec of a policy type. + + + + + policy-type-show + + + Show the policy type. + + + + + policy-update + + + Update a policy. + + + + + profile-create + + + Create a profile. + + + + + profile-delete + + + Delete profile(s). + + + + + profile-list + + + List profiles that meet the criteria. + + + + + profile-show + + + Show the profile details. + + + + + profile-type-list + + + List the available profile types. + + + + + profile-type-schema + + + Get the spec of a profile type. + + + + + profile-update + + + Update a profile. + + + + + trigger-create + + + Create a trigger. + + + + + trigger-delete + + + Delete trigger(s). + + + + + trigger-list + + + List triggers that meet the criteria. + + + + + trigger-show + + + Show the trigger details. + + + + + webhook-create + + + Create a webhook. + + + + + webhook-delete + + + Delete webhook(s). + + + + + webhook-list + + + List webhooks that meet the criteria. + + + + + webhook-show + + + Show the webhook details. + + + + + bash-completion + + + Prints all of the commands and options to stdout. + + + + + help + + + Display help about this program or one of its + subcommands. + + + + +
+
+ senlin optional arguments + + + --version + + + Shows the client version and exits. + + + + + -d, --debug + + + Defaults to env[SENLINCLIENT_DEBUG]. + + + + + -v, --verbose + + + Print more verbose output. + + + + + --api-timeout API_TIMEOUT + + + Number of seconds to wait for an API response, + defaults to system socket timeout + + + + + --senlin-api-version SENLIN_API_VERSION + + + Version number for Senlin API to use, Default to "1". + + + + + --os-auth-plugin AUTH_PLUGIN + + + Authentication plugin, default to env[OS_AUTH_PLUGIN] + + + + + --os-auth-url AUTH_URL + + + Defaults to env[OS_AUTH_URL] + + + + + --os-project-id PROJECT_ID + + + Defaults to env[OS_PROJECT_ID]. + + + + + --os-project-name PROJECT_NAME + + + Defaults to env[OS_PROJECT_NAME]. + + + + + --os-tenant-id TENANT_ID + + + Defaults to env[OS_TENANT_ID]. + + + + + --os-tenant-name TENANT_NAME + + + Defaults to env[OS_TENANT_NAME]. + + + + + --os-domain-id DOMAIN_ID + + + Domain ID for scope of authorization, defaults to + env[OS_DOMAIN_ID]. + + + + + --os-domain-name DOMAIN_NAME + + + Domain name for scope of authorization, defaults to + env[OS_DOMAIN_NAME]. + + + + + --os-project-domain-id PROJECT_DOMAIN_ID + + + Project domain ID for scope of authorization, defaults + to env[OS_PROJECT_DOMAIN_ID]. + + + + + --os-project-domain-name PROJECT_DOMAIN_NAME + + + Project domain name for scope of authorization, + defaults to env[OS_PROJECT_DOMAIN_NAME]. + + + + + --os-user-domain-id USER_DOMAIN_ID + + + User domain ID for scope of authorization, defaults to + env[OS_USER_DOMAIN_ID]. + + + + + --os-user-domain-name USER_DOMAIN_NAME + + + User domain name for scope of authorization, defaults + to env[OS_USER_DOMAIN_NAME]. + + + + + --os-username USERNAME + + + Defaults to env[OS_USERNAME]. + + + + + --os-user-id USER_ID + + + Defaults to env[OS_USER_ID]. + + + + + --os-password PASSWORD + + + Defaults to env[OS_PASSWORD] + + + + + --os-trust-id TRUST_ID + + + Defaults to env[OS_TRUST_ID] + + + + + --os-cacert CA_BUNDLE_FILE + + + Path of CA TLS certificate(s) used to verify the + remote server's certificate. Without this option + senlin looks for the default system CA certificates. + + + + + --verify + + + Verify server certificate (default) + + + + + --insecure + + + Explicitly allow senlinclient to perform "insecure + SSL" (HTTPS) requests. The server's certificate will + not be verified against any certificate authorities. + This option should be used with caution. + + + + + --os-token TOKEN + + + A string token to bootstrap the Keystone database, + defaults to env[OS_TOKEN] + + + + + --os-access-info ACCESS_INFO + + + Access info, defaults to env[OS_ACCESS_INFO] + + + + + --os-api-name <service>=<name> + + + Desired API names, defaults to env[OS_API_NAME] + + + + + --os-api-region <service>=<region> + + + Desired API region, defaults to env[OS_API_REGION] + + + + + --os-api-version <service>=<version> + + + Desired API versions, defaults to env[OS_API_VERSION] + + + + + --os-api-interface <service>=<interface> + + + Desired API interface, defaults to env[OS_INTERFACE] + + + + +
+
+ senlin action-list + usage: senlin action-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-k <KEYS>] + [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-D] [-F] + +List actions. + + Optional arguments + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned actions. This + can be specified multiple times, or once with + parameters separated by a semicolon. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned events. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of nodes returned. + + + + + -m <ID>, --marker <ID> + + + Only return nodes that appear after the given node ID. + + + + + -D, --show-deleted + + + Include soft-deleted nodes if any. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin action-show + usage: senlin action-show <ACTION> + +Show detailed info about the specified action. + + Positional arguments + + <ACTION> + + + Name or ID of the action to show the details for. + + + + +
+
+ senlin build-info + usage: senlin build-info + +Retrieve build information. :param sc: Instance of senlinclient. :param args: +Additional command line arguments, if any. + +
+
+ senlin cluster-create + usage: senlin cluster-create -p <PROFILE> [-n <MIN-SIZE>] [-m <MAX-SIZE>] + [-c <DESIRED-CAPACITY>] [-o <PARENT_ID>] + [-t <TIMEOUT>] [-M <KEY1=VALUE1;KEY2=VALUE2...>] + <CLUSTER_NAME> + +Create the cluster. + + Positional arguments + + <CLUSTER_NAME> + + + Name of the cluster to create. + + + + + + Optional arguments + + -p <PROFILE>, --profile <PROFILE> + + + Profile Id used for this cluster. + + + + + -n <MIN-SIZE>, --min-size <MIN-SIZE> + + + Min size of the cluster. Default to 0. + + + + + -m <MAX-SIZE>, --max-size <MAX-SIZE> + + + Max size of the cluster. Default to -1, means + unlimited. + + + + + -c <DESIRED-CAPACITY>, --desired-capacity <DESIRED-CAPACITY> + + + Desired capacity of the cluster. Default to 0. + + + + + -o <PARENT_ID>, --parent <PARENT_ID> + + + ID of the parent cluster, if exists. + + + + + -t <TIMEOUT>, --timeout <TIMEOUT> + + + Cluster creation timeout in minutes. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the cluster. This + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + +
+
+ senlin cluster-delete + usage: senlin cluster-delete <CLUSTER> [<CLUSTER> ...] + +Delete the cluster(s). + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster(s) to delete. + + + + +
+
+ senlin cluster-list + usage: senlin cluster-list [-D] [-n] [-f <KEY1=VALUE1;KEY2=VALUE2...>] + [-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g] + [-F] + +List the user's clusters. + + Optional arguments + + -D, --show-deleted + + + Include soft-deleted clusters if any. + + + + + -n, --show-nested + + + Include nested clusters if any. + + + + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned triggers. This + can be specified multiple times, or once with + parameters separated by a semicolon. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned events. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of clusters returned. + + + + + -m <ID>, --marker <ID> + + + Only return clusters that appear after the given + cluster ID. + + + + + -g, --global-project + + + Indicate that the cluster list should include clusters + from all projects. This option is subject to access + policy checking. Default is False. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin cluster-node-add + usage: senlin cluster-node-add -n <NODES> <CLUSTER> + +Add specified nodes to cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -n <NODES>, --nodes <NODES> + + + ID of nodes to be added; multiple nodes can be + separated with "," + + + + +
+
+ senlin cluster-node-del + usage: senlin cluster-node-del -n <NODES> <CLUSTER> + +Delete specified nodes from cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -n <NODES>, --nodes <NODES> + + + ID of nodes to be deleted; multiple nodes can be + separatedwith ",". + + + + +
+
+ senlin cluster-node-list + usage: senlin cluster-node-list [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>] + [-l <LIMIT>] [-m <ID>] [-F] + <CLUSTER> + +List nodes from cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to nodes from. + + + + + + Optional arguments + + -D, --show-deleted + + + Include soft-deleted nodes if any. + + + + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned nodes. This can + be specified multiple times, or once with parameters + separated by a semicolon. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of nodes returned. + + + + + -m <ID>, --marker <ID> + + + Only return nodes that appear after the given node ID. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin cluster-policy-attach + usage: senlin cluster-policy-attach -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>] + [-c <SECONDS>] [-e] + <NAME or ID> + +Attach policy to cluster. + + Positional arguments + + <NAME or ID> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of policy to be attached. + + + + + -r <PRIORITY>, --priority <PRIORITY> + + + An integer specifying the relative priority among all + policies attached to a cluster. The lower the value, + the higher the priority. Default is 50. + + + + + -l <LEVEL>, --enforcement-level <LEVEL> + + + An integer between 0 and 100 representing the + enforcement level. Default to enforcement level of + policy. + + + + + -c <SECONDS>, --cooldown <SECONDS> + + + An integer indicating the cooldown seconds once the + policy is effected. Default to cooldown of policy. + + + + + -e, --enabled + + + Whether the policy should be enabled once attached. + Default to enabled. + + + + +
+
+ senlin cluster-policy-detach + usage: senlin cluster-policy-detach -p <POLICY> <NAME or ID> + +Detach policy from cluster. + + Positional arguments + + <NAME or ID> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of policy to be detached. + + + + +
+
+ senlin cluster-policy-disable + usage: senlin cluster-policy-disable -p <POLICY> <NAME or ID> + +Disable a policy on a cluster. + + Positional arguments + + <NAME or ID> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of policy to be disabled. + + + + +
+
+ senlin cluster-policy-enable + usage: senlin cluster-policy-enable -p <POLICY> <NAME or ID> + +Enable a policy on cluster. + + Positional arguments + + <NAME or ID> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of policy to be enabled. + + + + +
+
+ senlin cluster-policy-list + usage: senlin cluster-policy-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] + [-k <KEYS>] [-s <DIR>] + <CLUSTER> + +List policies from cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to query on. + + + + + + Optional arguments + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned results. This + can be specified multiple times, or once with + parameters separated by a semicolon. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned events. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + +
+
+ senlin cluster-policy-show + usage: senlin cluster-policy-show -p <POLICY> <CLUSTER> + +Show a specific policy that is bound to the specified cluster. + + Positional arguments + + <CLUSTER> + + + ID or name of the cluster to query on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of the policy to query on. + + + + +
+
+ senlin cluster-policy-update + usage: senlin cluster-policy-update -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>] + [-c <COOLDOWN>] [-e <BOOLEAN>] + <NAME or ID> + +Update a policy on cluster. + + Positional arguments + + <NAME or ID> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -p <POLICY>, --policy <POLICY> + + + ID or name of policy to be updated. + + + + + -r <PRIORITY>, --priority <PRIORITY> + + + An integer specifying the relative priority among all + policies attached to a cluster. The lower the value, + the higher the priority. Default is 50. + + + + + -l <LEVEL>, --enforcement-level <LEVEL> + + + New enforcement level. + + + + + -c <COOLDOWN>, --cooldown <COOLDOWN> + + + Cooldown interval in seconds. + + + + + -e <BOOLEAN>, --enabled <BOOLEAN> + + + Whether the policy should be enabled. + + + + +
+
+ senlin cluster-resize + usage: senlin cluster-resize [-c <CAPACITY>] [-a <ADJUSTMENT>] + [-p <PERCENTAGE>] [-t <MIN_STEP>] [-s] [-n MIN] + [-m MAX] + <CLUSTER> + +Resize a cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -c <CAPACITY>, --capacity <CAPACITY> + + + The desired number of nodes of the cluster. + + + + + -a <ADJUSTMENT>, --adjustment <ADJUSTMENT> + + + A positive integer meaning the number of nodes to add, + or a negative integer indicating the number of nodes + to remove. + + + + + -p <PERCENTAGE>, --percentage <PERCENTAGE> + + + A value that is interpreted as the percentage of size + adjustment. This value can be positive or negative. + + + + + -t <MIN_STEP>, --min-step <MIN_STEP> + + + An integer specifying the number of nodes for + adjustment when <PERCENTAGE> is specified. + + + + + -s, --strict A + + + boolean specifying whether the resize should be + performed on a best-effort basis when the new capacity + may go beyond size constraints. + + + + + -n MIN, --min-size MIN + + + New lower bound of cluster size. + + + + + -m MAX, --max-size MAX + + + New upper bound of cluster size. A value of -1 + indicates no upper limit on cluster size. + + + + +
+
+ senlin cluster-scale-in + usage: senlin cluster-scale-in [-c <COUNT>] <CLUSTER> + +Scale in a cluster by the specified number of nodes. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -c <COUNT>, --count <COUNT> + + + Number of nodes to be deleted from the specified + cluster. + + + + +
+
+ senlin cluster-scale-out + usage: senlin cluster-scale-out [-c <COUNT>] <CLUSTER> + +Scale out a cluster by the specified number of nodes. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to operate on. + + + + + + Optional arguments + + -c <COUNT>, --count <COUNT> + + + Number of nodes to be added to the specified cluster. + + + + +
+
+ senlin cluster-show + usage: senlin cluster-show <CLUSTER> + +Show details of the cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to show. + + + + +
+
+ senlin cluster-update + usage: senlin cluster-update [-p <PROFILE>] [-t <TIMEOUT>] [-r <PARENT>] + [-M <KEY1=VALUE1;KEY2=VALUE2...>] [-n <NAME>] + <CLUSTER> + +Update the cluster. + + Positional arguments + + <CLUSTER> + + + Name or ID of cluster to be updated. + + + + + + Optional arguments + + -p <PROFILE>, --profile <PROFILE> + + + ID of new profile to use. + + + + + -t <TIMEOUT>, --timeout <TIMEOUT> + + + New timeout (in minutes) value for the cluster. + + + + + -r <PARENT>, --parent <PARENT> + + + ID of parent cluster for the cluster. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the cluster. This + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + + -n <NAME>, --name <NAME> + + + New name for the cluster to update. + + + + +
+
+ senlin event-list + usage: senlin event-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] + [-m <ID>] [-k <KEYS>] [-s <DIR>] [-g] [-D] [-F] + +List events. + + Optional arguments + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned events. This + can be specified multiple times, or once with + parameters separated by a semicolon. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of events returned. + + + + + -m <ID>, --marker <ID> + + + Only return events that appear after the given event + ID. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned events. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + + -g, --global-project + + + Whether events from all projects should be listed. + Default to False. Setting this to True may demand for + an admin privilege. + + + + + -D, --show-deleted + + + Whether deleted events should be listed as well. + Default to False. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin event-show + usage: senlin event-show <EVENT> + +Describe the event. + + Positional arguments + + <EVENT> + + + ID of event to display details for. + + + + +
+
+ senlin node-create + usage: senlin node-create -p <PROFILE> [-c <CLUSTER>] [-r <ROLE>] + [-M <KEY1=VALUE1;KEY2=VALUE2...>] + <NODE_NAME> + +Create the node. + + Positional arguments + + <NODE_NAME> + + + Name of the node to create. + + + + + + Optional arguments + + -p <PROFILE>, --profile <PROFILE> + + + Profile Id used for this node. + + + + + -c <CLUSTER>, --cluster <CLUSTER> + + + Cluster Id for this node. + + + + + -r <ROLE>, --role <ROLE> + + + Role for this node in the specific cluster. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the cluster. This + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + +
+
+ senlin node-delete + usage: senlin node-delete <NODE> [<NODE> ...] + +Delete the node(s). + + Positional arguments + + <NODE> + + + Name or ID of node(s) to delete. + + + + +
+
+ senlin node-join + usage: senlin node-join -c CLUSTER <NODE> + +Make node join the specified cluster. + + Positional arguments + + <NODE> + + + Name or ID of node to operate on. + + + + + + Optional arguments + + -c CLUSTER, --cluster CLUSTER + + + ID or name of cluster for node to join. + + + + +
+
+ senlin node-leave + usage: senlin node-leave <NODE> + +Make node leave its current cluster. + + Positional arguments + + <NODE> + + + Name or ID of node to operate on. + + + + +
+
+ senlin node-list + usage: senlin node-list [-c <CLUSTER>] [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>] + [-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g] + [-F] + +Show list of nodes. + + Optional arguments + + -c <CLUSTER>, --cluster <CLUSTER> + + + ID or name of cluster from which nodes are to be + listed. + + + + + -D, --show-deleted + + + Include soft-deleted nodes if any. + + + + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned nodes. This can + be specified multiple times, or once with parameters + separated by a semicolon. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned nodes. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of nodes returned. + + + + + -m <ID>, --marker <ID> + + + Only return nodes that appear after the given node ID. + + + + + -g, --global-project + + + Indicate that this node list should include nodes from + all projects. This option is subject to access policy + checking. Default is False. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin node-show + usage: senlin node-show [-D] <NODE> + +Show detailed info about the specified node. + + Positional arguments + + <NODE> + + + Name or ID of the node to show the details for. + + + + + + Optional arguments + + -D, --details + + + Include physical object details. + + + + +
+
+ senlin node-update + usage: senlin node-update [-n <NAME>] [-p <PROFILE ID>] [-r <ROLE>] + [-M <KEY1=VALUE1;KEY2=VALUE2...>] + <NODE> + +Update the node. + + Positional arguments + + <NODE> + + + Name or ID of node to update. + + + + + + Optional arguments + + -n <NAME>, --name <NAME> + + + New name for the node. + + + + + -p <PROFILE ID>, --profile <PROFILE ID> + + + ID of new profile to use. + + + + + -r <ROLE>, --role <ROLE> + + + Role for this node in the specific cluster. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the node. Metadata + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + +
+
+ senlin policy-create + usage: senlin policy-create -s <SPEC_FILE> [-c <SECONDS>] [-l <LEVEL>] <NAME> + +Create a policy. + + Positional arguments + + <NAME> + + + Name of the policy to create. + + + + + + Optional arguments + + -s <SPEC_FILE>, --spec-file <SPEC_FILE> + + + The spec file used to create the policy. + + + + + -c <SECONDS>, --cooldown <SECONDS> + + + An integer indicating the cooldown seconds once the + policy is effected. Default to 0. + + + + + -l <LEVEL>, --enforcement-level <LEVEL> + + + An integer between 0 and 100 representing the + enforcement level. Default to 0. + + + + +
+
+ senlin policy-delete + usage: senlin policy-delete <POLICY> [<POLICY> ...] + +Delete policy(s). + + Positional arguments + + <POLICY> + + + Name or ID of policy(s) to delete. + + + + +
+
+ senlin policy-list + usage: senlin policy-list [-D] [-l <LIMIT>] [-m <ID>] [-F] + +List policies that meet the criteria. + + Optional arguments + + -D, --show-deleted + + + Include soft-deleted policies if any. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of policies returned. + + + + + -m <ID>, --marker <ID> + + + Only return policies that appear after the given ID. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin policy-show + usage: senlin policy-show <POLICY> + +Show the policy details. + + Positional arguments + + <POLICY> + + + Name of the policy to be updated. + + + + +
+
+ senlin policy-type-list + usage: senlin policy-type-list + +List the available policy types. + +
+
+ senlin policy-type-schema + usage: senlin policy-type-schema [-F <FORMAT>] <POLICY_TYPE> + +Get the spec of a policy type. + + Positional arguments + + <POLICY_TYPE> + + + Policy type to generate a template for. + + + + + + Optional arguments + + -F <FORMAT>, --format <FORMAT> + + + The template output format, one of: yaml, json. + + + + +
+
+ senlin policy-type-show + usage: senlin policy-type-show <POLICY_TYPE> + +Show the policy type. + + Positional arguments + + <POLICY_TYPE> + + + Policy type to get the details for. + + + + +
+
+ senlin policy-update + usage: senlin policy-update [-c <SECONDS>] [-l <LEVEL>] [-n <NAME>] <POLICY> + +Update a policy. + + Positional arguments + + <POLICY> + + + Name of the policy to be updated. + + + + + + Optional arguments + + -c <SECONDS>, --cooldown <SECONDS> + + + An integer indicating the cooldown seconds once the + policy is effected. Default to 0. + + + + + -l <LEVEL>, --enforcement-level <LEVEL> + + + An integer between 0 and 100 representing the + enforcement level. Default to 0. + + + + + -n <NAME>, --name <NAME> + + + New name of the policy to be updated. + + + + +
+
+ senlin profile-create + usage: senlin profile-create -s <SPEC FILE> [-p <PERMISSION>] + [-M <KEY1=VALUE1;KEY2=VALUE2...>] + <PROFILE_NAME> + +Create a profile. + + Positional arguments + + <PROFILE_NAME> + + + Name of the profile to create. + + + + + + Optional arguments + + -s <SPEC FILE>, --spec-file <SPEC FILE> + + + The spec file used to create the profile. + + + + + -p <PERMISSION>, --permission <PERMISSION> + + + A string format permission for this profile. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the profile. This + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + +
+
+ senlin profile-delete + usage: senlin profile-delete <PROFILE> [<PROFILE> ...] + +Delete profile(s). + + Positional arguments + + <PROFILE> + + + Name or ID of profile(s) to delete. + + + + +
+
+ senlin profile-list + usage: senlin profile-list [-D] [-l <LIMIT>] [-m <ID>] [-F] + +List profiles that meet the criteria. + + Optional arguments + + -D, --show-deleted + + + Include soft-deleted profiles if any. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of profiles returned. + + + + + -m <ID>, --marker <ID> + + + Only return profiles that appear after the given ID. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin profile-show + usage: senlin profile-show <PROFILE> + +Show the profile details. + + Positional arguments + + <PROFILE> + + + Name or ID of profile to show. + + + + +
+
+ senlin profile-type-list + usage: senlin profile-type-list + +List the available profile types. :param sc: Instance of senlinclient. :param +args: Additional command line arguments, if any. + +
+
+ senlin profile-type-schema + usage: senlin profile-type-schema [-F <FORMAT>] <PROFILE_TYPE> + +Get the spec of a profile type. + + Positional arguments + + <PROFILE_TYPE> + + + Profile type to generate a template for. + + + + + + Optional arguments + + -F <FORMAT>, --format <FORMAT> + + + The template output format, one of: yaml, json. + + + + +
+
+ senlin profile-update + usage: senlin profile-update [-n <NAME>] [-p <PERMISSION>] + [-M <KEY1=VALUE1;KEY2=VALUE2...>] + <PROFILE_ID> + +Update a profile. + + Positional arguments + + <PROFILE_ID> + + + Name or ID of the profile to update. + + + + + + Optional arguments + + -n <NAME>, --name <NAME> + + + The new name for the profile. + + + + + -p <PERMISSION>, --permission <PERMISSION> + + + A string format permission for this profile. + + + + + -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> + + + Metadata values to be attached to the profile. This + can be specified multiple times, or once with key- + value pairs separated by a semicolon. + + + + +
+
+ senlin trigger-create + usage: senlin trigger-create -s <SPEC FILE> [--desc <DESCRIPTION>] [-e] + [-v SEVERITY] [--state STATE] + <TRIGGER_NAME> + +Create a trigger. + + Positional arguments + + <TRIGGER_NAME> + + + Name of the trigger to create. + + + + + + Optional arguments + + -s <SPEC FILE>, --spec-file <SPEC FILE> + + + The spec file used to create the trigger. + + + + + --desc <DESCRIPTION> + + + A string for describing of the trigger to be created. + + + + + -e, --enabled + + + Whether the trigger should be enabled when created. + + + + + -v SEVERITY, --severity SEVERITY + + + Severity level of the target trigger to be created. + + + + + --state STATE + + + Initial state of the target trigger. + + + + +
+
+ senlin trigger-delete + usage: senlin trigger-delete <TRIGGER> [<TRIGGER> ...] + +Delete trigger(s). + + Positional arguments + + <TRIGGER> + + + Name or ID of trigger(s) to delete. + + + + +
+
+ senlin trigger-list + usage: senlin trigger-list [-D] [-l <LIMIT>] [-m <ID>] [-k <KEYS>] [-s <DIR>] + [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-g] [-F] + +List triggers that meet the criteria. + + Optional arguments + + -D, --show-deleted + + + Include soft-deleted triggers if any. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of triggers returned. + + + + + -m <ID>, --marker <ID> + + + Only return triggers that appear after the given ID. + + + + + -k <KEYS>, --sort-keys <KEYS> + + + Name of keys used for sorting the returned triggers. + + + + + -s <DIR>, --sort-dir <DIR> + + + Direction for sorting, where DIR can be "asc" or + "desc". + + + + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned clusters. This + can be specified multiple times, or once with + parameters separated by a semicolon. + + + + + -g, --global-project + + + Indicate that the list should include triggers from + all projects. This option is subject to access policy + checking. Default is False. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin trigger-show + usage: senlin trigger-show <TRIGGER> + +Show the trigger details. + + Positional arguments + + <TRIGGER> + + + Name or ID of trigger to show. + + + + +
+
+ senlin webhook-create + usage: senlin webhook-create [-c <CLUSTER>] [-n <NODE>] -a <ACTION> + [-C <KEY1=VALUE1;KEY2=VALUE2...>] + [-P <KEY1=VALUE1;KEY2=VALUE2...>] + <NAME> + +Create a webhook. + + Positional arguments + + <NAME> + + + Name of the webhook to create. + + + + + + Optional arguments + + -c <CLUSTER>, --cluster <CLUSTER> + + + Targeted cluster for this webhook. + + + + + -n <NODE>, --node <NODE> + + + Targeted node for this webhook. + + + + + -a <ACTION>, --action <ACTION> + + + Name of action to be triggered for this webhook. + + + + + -C <KEY1=VALUE1;KEY2=VALUE2...>, --credential <KEY1=VALUE1;KEY2=VALUE2...> + + + The credential to be used when the webhook is + triggered. + + + + + -P <KEY1=VALUE1;KEY2=VALUE2...>, --params <KEY1=VALUE1;KEY2=VALUE2...> + + + A dictionary of parameters that will be passed to + target action when the webhook is triggered. + + + + +
+
+ senlin webhook-delete + usage: senlin webhook-delete <WEBHOOK> [<WEBHOOK> ...] + +Delete webhook(s). + + Positional arguments + + <WEBHOOK> + + + Name or ID of webhook(s) to delete. + + + + +
+
+ senlin webhook-list + usage: senlin webhook-list [-D] [-l <LIMIT>] [-m <ID>] [-F] + +List webhooks that meet the criteria. + + Optional arguments + + -D, --show-deleted + + + Include deleted webhooks if any. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of webhooks returned. + + + + + -m <ID>, --marker <ID> + + + Only return webhooks that appear after the given ID. + + + + + -F, --full-id + + + Print full IDs in list. + + + + +
+
+ senlin webhook-show + usage: senlin webhook-show <WEBHOOK> + +Show the webhook details. + + Positional arguments + + <WEBHOOK> + + + Name or ID of the webhook to show. + + + + +
+ diff --git a/doc/common-rst/app_support.rst b/doc/common-rst/app_support.rst index 02034fd751..dcf73e7557 100644 --- a/doc/common-rst/app_support.rst +++ b/doc/common-rst/app_support.rst @@ -170,6 +170,8 @@ The following Launchpad Bugs areas are available: - `Bugs: Bare metal service (ironic) `__ +- `Bugs: Clustering service (senlin) `__ + - `Bugs: Containers service (magnum) `__ - `Bugs: Data processing service 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 837aa6d044..d8f7bba9db 100644 --- a/doc/common-rst/cli_install_openstack_command_line_clients.rst +++ b/doc/common-rst/cli_install_openstack_command_line_clients.rst @@ -175,6 +175,8 @@ for each client. The following values are valid: - ``sahara`` - Data Processing API +- ``senlin`` - Clustering service API + - ``swift`` - Object Storage API - ``trove`` - Database service API diff --git a/doc/common-rst/cli_overview.rst b/doc/common-rst/cli_overview.rst index 65e12677eb..23fa8c69ca 100644 --- a/doc/common-rst/cli_overview.rst +++ b/doc/common-rst/cli_overview.rst @@ -39,6 +39,9 @@ service with its package name and description. |Block Storage |cinder |python-cinderclient |Creates and manages | | | | |volumes. | +----------------+----------+-----------------------+------------------------+ +|Clustering |senlin |python-senlinclient |Creates and manages | +|service | | |clustering services. | ++----------------+----------+-----------------------+------------------------+ |Compute |nova |python-novaclient |Creates and manages | | | | |images, instances, and | | | | |flavors. | diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml index d0646b6ab0..050bee131c 100644 --- a/doc/common/app_support.xml +++ b/doc/common/app_support.xml @@ -289,6 +289,11 @@ xlink:href="https://bugs.launchpad.net/ironic" >Bugs: Bare metal service (ironic) + + Bugs: Clustering service (senlin) + sahara - Data Processing API + + senlin - Clustering service + API + swift - Object Storage API diff --git a/doc/common/section_cli_overview.xml b/doc/common/section_cli_overview.xml index ecc8037009..64e3cff221 100644 --- a/doc/common/section_cli_overview.xml +++ b/doc/common/section_cli_overview.xml @@ -56,6 +56,12 @@ python-cinderclient Creates and manages volumes. + + Clustering service + senlin + python-senlinclient + Creates and manages clustering services. + Compute nova