Merge "Modify the doc descriptions of pankoclient"
This commit is contained in:
commit
2eb5d31914
|
@ -4,12 +4,12 @@
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Python bindings to the Panko API
|
Python bindings to the Panko API
|
||||||
===============================
|
================================
|
||||||
|
|
||||||
This is a client for Panko API. There's :doc:`a Python API
|
This is a client for Panko API. There's :doc:`a Python API
|
||||||
<api>` (the :mod:`pankoclient` module), and a :doc:`command-line script
|
<api>` (the :mod:`pankoclient` module), and a set of event related commands
|
||||||
<shell>` (installed as :program:`panko`). Each implements the entire
|
which are integrated with the OSC CLI tool. Each implements the entire Panko
|
||||||
Panko API.
|
API.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ Contents:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
installation
|
installation
|
||||||
shell
|
osc_integrated_commands
|
||||||
api
|
api
|
||||||
contributing
|
contributing
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,42 @@
|
||||||
|
The OSC CLI plugins
|
||||||
|
===================
|
||||||
|
|
||||||
|
This program provides a set of event related commands which are performed by
|
||||||
|
OSC `openstack program`_. The `OpenStackClient`_ project provide a plugin
|
||||||
|
mechanism which supports loading other external projects' commands from
|
||||||
|
clients library entry points.
|
||||||
|
|
||||||
|
The event related commands begin with `openstack event` in `openstack`
|
||||||
|
command tool.
|
||||||
|
|
||||||
|
To configure the environment variables, see `openstack program`_.
|
||||||
|
|
||||||
|
.. _OpenStackClient: https://docs.openstack.org/developer/python-openstackclient
|
||||||
|
.. _openstack program: https://docs.openstack.org/developer/python-openstackclient/man/openstack.html
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
List the capabilities of event interfaces::
|
||||||
|
|
||||||
|
openstack event capabilities list
|
||||||
|
|
||||||
|
List the events::
|
||||||
|
|
||||||
|
openstack event list
|
||||||
|
|
||||||
|
Show an event::
|
||||||
|
|
||||||
|
openstack event show <MESSAGE_ID>
|
||||||
|
|
||||||
|
List event types::
|
||||||
|
|
||||||
|
openstack event type list
|
||||||
|
|
||||||
|
List trait values of a specified event type and a trait name::
|
||||||
|
|
||||||
|
openstack event traits list <EVENT_TYPE> <TRAIT_NAME>
|
||||||
|
|
||||||
|
List traits definitions for a specified event type::
|
||||||
|
|
||||||
|
openstack event trait description <EVENT_TYPE>
|
|
@ -1,67 +0,0 @@
|
||||||
The :program:`panko` shell utility
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. program:: panko
|
|
||||||
.. highlight:: bash
|
|
||||||
|
|
||||||
The :program:`panko` shell utility interacts with Panko API
|
|
||||||
from the command line.
|
|
||||||
|
|
||||||
You'll need to provide :program:`panko` with your OpenStack credentials.
|
|
||||||
You can do this with the :option:`--os-username`, :option:`--os-password`,
|
|
||||||
:option:`--os-tenant-id` and :option:`--os-auth-url` options, but it's easier to
|
|
||||||
just set them as environment variables:
|
|
||||||
|
|
||||||
.. envvar:: OS_USERNAME
|
|
||||||
|
|
||||||
Your OpenStack username.
|
|
||||||
|
|
||||||
.. envvar:: OS_PASSWORD
|
|
||||||
|
|
||||||
Your password.
|
|
||||||
|
|
||||||
.. envvar:: OS_TENANT_NAME
|
|
||||||
|
|
||||||
Project to work on.
|
|
||||||
|
|
||||||
.. envvar:: OS_AUTH_URL
|
|
||||||
|
|
||||||
The OpenStack auth server URL (keystone).
|
|
||||||
|
|
||||||
For example, in Bash you would use::
|
|
||||||
|
|
||||||
export OS_USERNAME=user
|
|
||||||
export OS_PASSWORD=pass
|
|
||||||
export OS_TENANT_NAME=myproject
|
|
||||||
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
|
|
||||||
|
|
||||||
The command line tool will attempt to reauthenticate using your provided credentials
|
|
||||||
for every request. You can override this behavior by manually supplying an auth
|
|
||||||
token using :option:`--panko-endpoint` and :option:`--os-auth-token`. You can alternatively
|
|
||||||
set these environment variables::
|
|
||||||
|
|
||||||
export PANKO_ENDPOINT=http://panko.example.org:8041
|
|
||||||
export OS_AUTH_PLUGIN=token
|
|
||||||
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
|
|
||||||
|
|
||||||
Also, if the server doesn't support authentication, you can provide
|
|
||||||
:option:`--os-auth-plugon` panko-noauth, :option:`--panko-endpoint`, :option:`--user-id`
|
|
||||||
and :option:`--project-id`. You can alternatively set these environment variables::
|
|
||||||
|
|
||||||
export OS_AUTH_PLUGIN=panko-noauth
|
|
||||||
export PANKO_ENDPOINT=http://panko.example.org:8041
|
|
||||||
export PANKO_USER_ID=99aae-4dc2-4fbc-b5b8-9688c470d9cc
|
|
||||||
export PANKO_PROJECT_ID=c8d27445-48af-457c-8e0d-1de7103eae1f
|
|
||||||
|
|
||||||
From there, all shell commands take the form::
|
|
||||||
|
|
||||||
panko <command> [arguments...]
|
|
||||||
|
|
||||||
Run :program:`panko help` to get a full list of all possible commands,
|
|
||||||
and run :program:`panko help <command>` to get detailed help for that
|
|
||||||
command.
|
|
||||||
|
|
||||||
Examples
|
|
||||||
--------
|
|
||||||
|
|
||||||
#TODO
|
|
Loading…
Reference in New Issue