diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index c1f5b0a80d..25325a0ccc 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -120,6 +120,7 @@ + diff --git a/doc/cli-reference/generated/ch_cli_magnum_commands.xml b/doc/cli-reference/generated/ch_cli_magnum_commands.xml new file mode 100644 index 0000000000..96d1cd763b --- /dev/null +++ b/doc/cli-reference/generated/ch_cli_magnum_commands.xml @@ -0,0 +1,1343 @@ + + + + + + + + Containers service command-line client + + The magnum client is the command-line + interface (CLI) for the Containers service API and its extensions. + + This chapter documents magnum version + 0.2.1. + + + For help on a specific magnum + command, enter: + + $ magnum COMMAND + +
+ magnum usage + usage: magnum [--version] [--debug] [--os-cache] + [--os-region-name <region-name>] + [--os-tenant-id <auth-tenant-id>] + [--service-type <service-type>] + [--endpoint-type <endpoint-type>] + [--magnum-api-version <magnum-api-ver>] + [--os-cacert <ca-certificate>] [--bypass-url <bypass-url>] + [--os-auth-system <auth-system>] [--os-username <username>] + [--os-password <password>] [--os-tenant-name <tenant-name>] + [--os-token <token>] [--os-auth-url <auth-url>] + <subcommand> ... + + Subcommands + + bay-create + + + Create a bay. + + + + + bay-delete + + + Delete specified bay. + + + + + bay-list + + + Print a list of available bays. + + + + + bay-show + + + Show details about the given bay. + + + + + bay-update + + + Update information about the given bay. + + + + + baymodel-create + + + Create a baymodel. + + + + + baymodel-delete + + + Delete specified baymodel. + + + + + baymodel-list + + + Print a list of bay models. + + + + + baymodel-show + + + Show details about the given baymodel. + + + + + container-create + + + Create a container. + + + + + container-delete + + + Delete specified containers. + + + + + container-execute + + + Execute command in a container. + + + + + container-list + + + Print a list of available containers. + + + + + container-logs + + + Get logs of a container. + + + + + container-pause + + + Pause specified containers. + + + + + container-reboot + + + Reboot specified containers. + + + + + container-show + + + Show details of a container. + + + + + container-start + + + Start specified containers. + + + + + container-stop + + + Stop specified containers. + + + + + container-unpause + + + Unpause specified containers. + + + + + node-create + + + Create a node. + + + + + node-list + + + Print a list of configured nodes. + + + + + pod-create + + + Create a pod. + + + + + pod-delete + + + Delete specified pod. + + + + + pod-list + + + Print a list of registered pods. + + + + + pod-show + + + Show details about the given pod. + + + + + pod-update + + + Update information about the given pod. + + + + + rc-create + + + Create a replication controller. + + + + + rc-delete + + + Delete specified replication controller. + + + + + rc-list + + + Print a list of registered replication controllers. + + + + + rc-show + + + Show details about the given replication controller. + + + + + rc-update + + + Update information about the given replication + controller. + + + + + service-create + + + Create a service. + + + + + service-delete + + + Delete specified service. + + + + + service-list + + + Print a list of services. + + + + + service-show + + + Show details about the given service. + + + + + service-update + + + Update information about the given service. + + + + + bash-completion + + + Prints arguments for bash-completion. Prints all of + the commands and options to stdout so that the + magnum.bash_completion script doesn't have to hard + code them. + + + + + help + + + Display help about this program or one of its + subcommands. + + + + +
+
+ magnum optional arguments + + + --version + + + show program's version number and exit + + + + + --debug + + + Print debugging output. + + + + + --os-cache + + + Use the auth token cache. Defaults to False if + env[OS_CACHE] is not set. + + + + + --os-region-name <region-name> + + + Region name. Default=env[OS_REGION_NAME]. + + + + + --os-tenant-id <auth-tenant-id> + + + Defaults to env[OS_TENANT_ID]. + + + + + --service-type <service-type> + + + Defaults to container for all actions. + + + + + --endpoint-type <endpoint-type> + + + Defaults to env[MAGNUM_ENDPOINT_TYPE] or publicURL. + + + + + --magnum-api-version <magnum-api-ver> + + + Accepts "api", defaults to env[MAGNUM_API_VERSION]. + + + + + --os-cacert <ca-certificate> + + + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + env[OS_CACERT]. + + + + + --bypass-url <bypass-url> + + + Use this API endpoint instead of the Service Catalog. + + + + +
+
+ magnum common authentication arguments + + + --os-auth-system <auth-system> + + + Defaults to env[OS_AUTH_SYSTEM]. + + + + + --os-username <username> + + + Defaults to env[OS_USERNAME]. + + + + + --os-password <password> + + + Defaults to env[OS_PASSWORD]. + + + + + --os-tenant-name <tenant-name> + + + Defaults to env[OS_TENANT_NAME]. + + + + + --os-token <token> + + + Defaults to env[OS_TOKEN]. + + + + + --os-auth-url <auth-url> + + + Defaults to env[OS_AUTH_URL]. + + + + +
+
+ magnum bay-create + usage: magnum bay-create [--name <name>] --baymodel <baymodel> + [--node-count <node-count>] + [--discovery-url <discovery-url>] + [--timeout <timeout>] + +Create a bay. + + Optional arguments + + --name <name> + + + Name of the bay to create. + + + + + --baymodel <baymodel> + + + ID or name of the baymodel. + + + + + --node-count <node-count> + + + The bay node count. + + + + + --discovery-url <discovery-url> + + + Specifies custom discovery url for node discovery. + + + + + --timeout <timeout> + + + The timeout for bay creation in minutes. Set to 0 for + no timeout. The default is no timeout. + + + + +
+
+ magnum bay-delete + usage: magnum bay-delete <bay> [<bay> ...] + +Delete specified bay. + + Positional arguments + + <bay> + + + ID or name of the (bay)s to delete. + + + + +
+
+ magnum bay-list + usage: magnum bay-list + +Print a list of available bays. + +
+
+ magnum bay-show + usage: magnum bay-show <bay> + +Show details about the given bay. + + Positional arguments + + <bay> + + + ID or name of the bay to show. + + + + +
+
+ magnum bay-update + usage: magnum bay-update <bay> <op> <path=value> [<path=value> ...] + +Update information about the given bay. + + Positional arguments + + <bay> + + + UUID or name of bay + + + + + <op> + + + Operations: 'add', 'replace' or 'remove' + + + + + <path=value> + + + Attributes to add/replace or remove (only PATH is necessary on + remove) + + + + +
+
+ magnum baymodel-create + usage: magnum baymodel-create [--name <name>] --image-id <image-id> + --keypair-id <keypair-id> --external-network-id + <external-network-id> --coe <coe> + [--fixed-network <fixed-network>] + [--ssh-authorized-key <ssh-authorized-key>] + [--dns-nameserver <dns-nameserver>] + [--flavor-id <flavor-id>] + [--master-flavor-id <master-flavor-id>] + [--docker-volume-size <docker-volume-size>] + +Create a baymodel. + + Optional arguments + + --name <name> + + + Name of the bay to create. + + + + + --image-id <image-id> + + + The name or UUID of the base image to customize for + the bay. + + + + + --keypair-id <keypair-id> + + + The name or UUID of the SSH keypair to load into the + Bay nodes. + + + + + --external-network-id <external-network-id> + + + The external Neutron network ID to connect to this bay + model. + + + + + --coe <coe> + + + Specify the Container Orchestration Engine to use. + + + + + --fixed-network <fixed-network> + + + The private Neutron network name to connect to this + bay model. + + + + + --ssh-authorized-key <ssh-authorized-key> + + + The SSH authorized key to use + + + + + --dns-nameserver <dns-nameserver> + + + The DNS nameserver to use for this Bay. + + + + + --flavor-id <flavor-id> + + + The nova flavor id to use when launching the bay. + + + + + --master-flavor-id <master-flavor-id> + + + The nova flavor id to use when launching the master + nodeof the bay. + + + + + --docker-volume-size <docker-volume-size> + + + Specify the size of the docker volume to use. + + + + +
+
+ magnum baymodel-delete + usage: magnum baymodel-delete <baymodels> [<baymodels> ...] + +Delete specified baymodel. + + Positional arguments + + <baymodels> + + + ID or name of the (baymodel)s to delete. + + + + +
+
+ magnum baymodel-list + usage: magnum baymodel-list + +Print a list of bay models. + +
+
+ magnum baymodel-show + usage: magnum baymodel-show <baymodel> + +Show details about the given baymodel. + + Positional arguments + + <baymodel> + + + ID of the baymodel to show. + + + + +
+
+ magnum container-create + usage: magnum container-create [--json JSON] + +Create a container. + + Optional arguments + + --json JSON JSON + + + representation of container. + + + + +
+
+ magnum container-delete + usage: magnum container-delete <container> [<container> ...] + +Delete specified containers. + + Positional arguments + + <container> + + + ID or name of the (container)s to delete. + + + + +
+
+ magnum container-execute + usage: magnum container-execute --command <command> <container> + +Execute command in a container. + + Positional arguments + + <container> + + + ID or name of the container to start. + + + + + + Optional arguments + + --command <command> + + + The command to execute + + + + +
+
+ magnum container-list + usage: magnum container-list + +Print a list of available containers. + +
+
+ magnum container-logs + usage: magnum container-logs <container> + +Get logs of a container. + + Positional arguments + + <container> + + + ID or name of the container to start. + + + + +
+
+ magnum container-pause + usage: magnum container-pause <container> [<container> ...] + +Pause specified containers. + + Positional arguments + + <container> + + + ID or name of the (container)s to start. + + + + +
+
+ magnum container-reboot + usage: magnum container-reboot <container> [<container> ...] + +Reboot specified containers. + + Positional arguments + + <container> + + + ID or name of the (container)s to start. + + + + +
+
+ magnum container-show + usage: magnum container-show [--json] <container> + +Show details of a container. + + Positional arguments + + <container> + + + ID or name of the container to show. + + + + + + Optional arguments + + --json + + + Print JSON representation of the container. + + + + +
+
+ magnum container-start + usage: magnum container-start <container> [<container> ...] + +Start specified containers. + + Positional arguments + + <container> + + + ID of the (container)s to start. + + + + +
+
+ magnum container-stop + usage: magnum container-stop <container> [<container> ...] + +Stop specified containers. + + Positional arguments + + <container> + + + ID or name of the (container)s to start. + + + + +
+
+ magnum container-unpause + usage: magnum container-unpause <container> [<container> ...] + +Unpause specified containers. + + Positional arguments + + <container> + + + ID or name of the (container)s to start. + + + + +
+
+ magnum node-create + usage: magnum node-create [--type <type>] [--image-id <image-id>] + +Create a node. + + Optional arguments + + --type <type> + + + Type of node to create (virt or bare). + + + + + --image-id <image-id> + + + The name or UUID of the base image to use for the + node. + + + + +
+
+ magnum node-list + usage: magnum node-list + +Print a list of configured nodes. + +
+
+ magnum pod-create + usage: magnum pod-create [--manifest-url <manifest-url>] + [--manifest <manifest>] --bay <bay> + +Create a pod. + + Optional arguments + + --manifest-url <manifest-url> + + + Name/URL of the pod file to use for creating PODs. + + + + + --manifest <manifest> + + + File path of the pod file to use for creating PODs. + + + + + --bay <bay> ID + + + or name of the bay. + + + + +
+
+ magnum pod-delete + usage: magnum pod-delete <pods> [<pods> ...] + +Delete specified pod. + + Positional arguments + + <pods> + + + ID or name of the (pod)s to delete. + + + + +
+
+ magnum pod-list + usage: magnum pod-list + +Print a list of registered pods. + +
+
+ magnum pod-show + usage: magnum pod-show <pod> + +Show details about the given pod. + + Positional arguments + + <pod> + + + ID or name of the pod to show. + + + + +
+
+ magnum pod-update + usage: magnum pod-update <pod-id> <op> <path=value> [<path=value> ...] + +Update information about the given pod. + + Positional arguments + + <pod-id> + + + UUID or name of pod + + + + + <op> + + + Operations: 'add', 'replace' or 'remove' + + + + + <path=value> + + + Attributes to add/replace or remove (only PATH is necessary on + remove) + + + + +
+
+ magnum rc-create + usage: magnum rc-create [--manifest-url <manifest-url>] + [--manifest <manifest>] --bay <bay> + +Create a replication controller. + + Optional arguments + + --manifest-url <manifest-url> + + + Name/URL of the replication controller file to use for + creating replication controllers. + + + + + --manifest <manifest> + + + File path of the replication controller file to use + for creating replication controllers. + + + + + --bay <bay> ID + + + or name of the bay. + + + + +
+
+ magnum rc-delete + usage: magnum rc-delete <rcs> [<rcs> ...] + +Delete specified replication controller. + + Positional arguments + + <rcs> + + + ID or name of the replication (controller)s to delete. + + + + +
+
+ magnum rc-list + usage: magnum rc-list + +Print a list of registered replication controllers. + +
+
+ magnum rc-show + usage: magnum rc-show <rc> + +Show details about the given replication controller. + + Positional arguments + + <rc> + + + ID or name of the replication controller to show. + + + + +
+
+ magnum rc-update + usage: magnum rc-update <rc> <op> <path=value> [<path=value> ...] + +Update information about the given replication controller. + + Positional arguments + + <rc> + + + UUID or name of replication controller + + + + + <op> + + + Operations: 'add', 'replace' or 'remove' + + + + + <path=value> + + + Attributes to add/replace or remove (only PATH is necessary on + remove) + + + + +
+
+ magnum service-create + usage: magnum service-create [--manifest-url <manifest-url>] + [--manifest <manifest>] --bay <bay> + +Create a service. + + Optional arguments + + --manifest-url <manifest-url> + + + Name/URL of the serivce file to use for creating + services. + + + + + --manifest <manifest> + + + File path of the service file to use for creating + services. + + + + + --bay <bay> + + + Id or name of the bay. + + + + +
+
+ magnum service-delete + usage: magnum service-delete <services> [<services> ...] + +Delete specified service. + + Positional arguments + + <services> + + + ID or name of the (service)s to delete. + + + + +
+
+ magnum service-list + usage: magnum service-list + +Print a list of services. + +
+
+ magnum service-show + usage: magnum service-show <service> + +Show details about the given service. + + Positional arguments + + <service> + + + ID or name of the service to show. + + + + +
+
+ magnum service-update + usage: magnum service-update <service> <op> <path=value> [<path=value> ...] + +Update information about the given service. + + Positional arguments + + <service> + + + UUID or name of service + + + + + <op> + + + Operations: 'add', 'replace' or 'remove' + + + + + <path=value> + + + Attributes to add/replace or remove (only PATH is necessary on + remove) + + + + +
+