diff --git a/README.rst b/README.rst index 9b91d7c4b..ab790fe6b 100644 --- a/README.rst +++ b/README.rst @@ -58,7 +58,7 @@ To use a specific Ironic API endpoint:: $ export IRONIC_URL=http://ironic.example.com:6385 -An example of how to create a basic node with the pxe_ipmitool driver:: +An example of creating a basic node with the pxe_ipmitool driver:: $ ironic node-create -d pxe_ipmitool @@ -78,6 +78,30 @@ available, run:: $ ironic help +OpenStackClient Baremetal Plugin +-------------------------------- + +In order to use Baremetal Plugin the OpenStackClient should be installed:: + + # pip install python-openstackclient + +An example of creating a basic node with the agent_ipmitool driver:: + + $ openstack baremetal node create --driver agent_ipmitool + +An example of creating a port on a node:: + + $ openstack baremetal port create --node AA:BB:CC:DD:EE:FF + +An example of updating driver properties for a node:: + + $ openstack baremetal node set --driver-info ipmi_address= + +For more information about the ``openstack baremetal`` command and +the subcommands available, run:: + + $ openstack help baremetal + * License: Apache License, Version 2.0 * Documentation: http://docs.openstack.org/developer/python-ironicclient * Source: http://git.openstack.org/cgit/openstack/python-ironicclient diff --git a/doc/source/index.rst b/doc/source/index.rst index fcb90a71f..a7e7156d5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,6 +14,7 @@ Contents api_v1 cli + osc_plugin_cli create_command contributing testing diff --git a/doc/source/osc_plugin_cli.rst b/doc/source/osc_plugin_cli.rst new file mode 100644 index 000000000..119bc44f0 --- /dev/null +++ b/doc/source/osc_plugin_cli.rst @@ -0,0 +1,85 @@ +============================================================================ +:program:`openstack baremetal` OpenStack Client Command-Line Interface (CLI) +============================================================================ + +.. program:: openstack baremetal +.. highlight:: bash + +Synopsis +======== + +:program:`openstack [options] baremetal` [command-options] + +:program:`openstack help baremetal` + + +Description +=========== + +The OpenStack Client plugin interacts with the Bare Metal service +through the ``openstack baremetal`` command line interface (CLI). + +To use ``openstack`` CLI, the OpenStackClient should be installed:: + + # pip install python-openstackclient + +To use the CLI, you must provide your OpenStack username, password, +project, and auth endpoint. You can use configuration options +:option:`--os-username`, :option:`--os-password`, :option:`--os-project-id` +(or :option:`--os-project-name`), and :option:`--os-auth-url`, +or set the corresponding environment variables:: + + $ export OS_USERNAME=user + $ export OS_PASSWORD=password + $ export OS_PROJECT_NAME=project # or OS_PROJECT_ID + $ export OS_PROJECT_DOMAIN_ID=default + $ export OS_USER_DOMAIN_ID=default + $ export OS_IDENTITY_API_VERSION=3 + $ export OS_AUTH_URL=http://auth.example.com:5000/identity + +This CLI is provided by python-openstackclient and osc-lib projects: + +* https://git.openstack.org/openstack/python-openstackclient +* https://git.openstack.org/openstack/osc-lib + + +Getting help +============ + +To get a list of available (sub)commands and options, run:: + + $ openstack help baremetal + +To get usage and options of a command, run:: + + $ openstack help baremetal + + +Examples +======== + +Get information about the openstack baremetal node create command:: + + $ openstack help baremetal node create + +Get a list of available drivers:: + + $ openstack baremetal driver list + +Enroll a node with "agent_ipmitool" driver:: + + $ openstack baremetal node create --driver agent_ipmitool --driver-info ipmi_address=1.2.3.4 + +Get a list of nodes:: + + $ openstack baremetal node list + +The baremetal API version can be specified via: + +* environment variable OS_BAREMETAL_API_VERSION:: + + $ export OS_BAREMETAL_API_VERSION=1.25 + +* or optional command line argument --os-baremetal-api-version:: + + $ openstack baremetal port group list --os-baremetal-api-version 1.25