diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 00000000..ce0300d4 --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,86 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +================ +Zun CLI man page +================ + + +SYNOPSIS +======== + +Zun operation use `zun` command, and also support use `openstack` command. + +:program:`zun` [options] [command-options] + +:program:`openstack` appcontainer [command-options] + + +DESCRIPTION +=========== + +The :program:`zun` command line utility interacts with OpenStack Containers +Service (Zun). + +In order to use the CLI, you must provide your OpenStack username, password, +project (historically called tenant), and auth endpoint. You can use +configuration options `--os-username`, `--os-password`, `--os-tenant-name` or +`--os-tenant-id`, and `--os-auth-url` or set corresponding environment +variables:: + + export OS_USERNAME=user + export OS_PASSWORD=pass + export OS_PROJECT_NAME=myproject + export OS_AUTH_URL=http://auth.example.com:5000/v3 + export OS_USER_DOMAIN_ID=default + export OS_PROJECT_DOMAIN_ID=default + +OPTIONS +======= + +To get a list of available commands and options run:: + + zun help + +To get usage and options of a command:: + + zun help + +EXAMPLES +======== + +List all the containers:: + + zun list + +Create new container:: + + zun run --name container01 IMAGE01 + +Describe a specific container:: + + zun show container01 + +You can also use openstack command as follow. + +List all the containers:: + + openstack appcontainer list + +Create new container:: + + openstack appcontainer run --name container01 IMAGE01 + +Describe a specific container:: + + openstack appcontainer show container01 diff --git a/doc/source/index.rst b/doc/source/index.rst index ded4c8b9..467fb11b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ Contents readme install/index contributor/index + cli/index Indices and tables ------------------