summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-12-15 18:00:16 -0500
committerSteve Martinelli <stevemar@ca.ibm.com>2016-03-10 03:51:01 +0000
commitef13bd8cf6c6e46f4ce04fa3a21552913417b586 (patch)
tree80119db045b13244f9d13b87dc73913216d20c35 /doc
parent9b028b5cdd1b0ef7260fa530a5a5925d78f81646 (diff)
downloadpython-keystoneclient-ef13bd8cf6c6e46f4ce04fa3a21552913417b586.tar.gz
remove CLI from keystoneclient
the CLI has been deprecated for a long time, and many docs and install guides recommend using OSC instead of `keystone`. - removes CLI - removes man page from docs - removes CLI tests - removes `bootstrap` from contrib - removes entrypoint from setup.cfg implements bp: remove-cli Change-Id: Icbe15814bc4faf33f513f9654440068795eae807
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py5
-rw-r--r--doc/source/man/keystone.rst158
2 files changed, 1 insertions, 162 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 8a7a5ce..eb83a15 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -109,10 +109,7 @@ modindex_common_prefix = ['keystoneclient.']
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', 'title', 'Authors name', 'manual'
-man_pages = [
- ('man/keystone', 'keystone', 'Client for OpenStack Identity API',
- ['OpenStack Contributors'], 1),
-]
+#man_pages = []
# -- Options for HTML output --------------------------------------------------
diff --git a/doc/source/man/keystone.rst b/doc/source/man/keystone.rst
deleted file mode 100644
index 10d9d93..0000000
--- a/doc/source/man/keystone.rst
+++ /dev/null
@@ -1,158 +0,0 @@
-==============================================================
-:program:`keystone` command line utility (pending deprecation)
-==============================================================
-
-.. program:: keystone
-.. highlight:: bash
-
-SYNOPSIS
-========
-
-:program:`keystone` [options] <command> [command-options]
-
-:program:`keystone help`
-
-:program:`keystone help` <command>
-
-
-DESCRIPTION
-===========
-
-.. WARNING::
-
- The :program:`keystone` command line utility is pending deprecation. The
- `OpenStackClient unified command line utility
- <http://docs.openstack.org/developer/python-openstackclient/>`_ should be
- used instead. The :program:`keystone` command line utility only supports V2
- of the Identity API whereas the OSC program supports both V2 and V3.
-
-The :program:`keystone` command line utility interacts with services providing
-OpenStack Identity API (e.g. Keystone).
-
-To communicate with the API, you will need to be authenticated - and the
-:program:`keystone` provides multiple options for this.
-
-While bootstrapping Keystone the authentication is accomplished with a
-shared secret token and the location of the Identity API endpoint. The
-shared secret token is configured in keystone.conf as "admin_token".
-
-You can specify those values on the command line with :option:`--os-token`
-and :option:`--os-endpoint`, or set them in environment variables:
-
-.. envvar:: OS_SERVICE_TOKEN
-
- Your Keystone administrative token
-
-.. envvar:: OS_SERVICE_ENDPOINT
-
- Your Identity API endpoint
-
-The command line options will override any environment variables set.
-
-If you already have accounts, you can use your OpenStack username and
-password. You can do this with the :option:`--os-username`,
-:option:`--os-password`.
-
-Keystone allows a user to be associated with one or more projects which are
-historically called tenants. To specify the project for which you want to
-authorize against, you may optionally specify a :option:`--os-tenant-id` or
-:option:`--os-tenant-name`.
-
-Instead of using options, it is easier to just set them as environment
-variables:
-
-.. envvar:: OS_USERNAME
-
- Your Keystone username.
-
-.. envvar:: OS_PASSWORD
-
- Your Keystone password.
-
-.. envvar:: OS_TENANT_NAME
-
- Name of Keystone project.
-
-.. envvar:: OS_TENANT_ID
-
- ID of Keystone Tenant.
-
-.. envvar:: OS_AUTH_URL
-
- The OpenStack API server URL.
-
-.. envvar:: OS_IDENTITY_API_VERSION
-
- The OpenStack Identity API version.
-
-.. envvar:: OS_CACERT
-
- The location for the CA truststore (PEM formatted) for this client.
-
-.. envvar:: OS_CERT
-
- The location for the keystore (PEM formatted) containing the public
- key of this client. This keystore can also optionally contain the
- private key of this client.
-
-.. envvar:: OS_KEY
-
- The location for the keystore (PEM formatted) containing the private
- key of this client. This value can be empty if the private key is
- included in the OS_CERT file.
-
-For example, in Bash you'd use::
-
- export OS_USERNAME=yourname
- export OS_PASSWORD=yadayadayada
- export OS_TENANT_NAME=myproject
- export OS_AUTH_URL=http(s)://example.com:5000/v2.0/
- export OS_IDENTITY_API_VERSION=2.0
- export OS_CACERT=/etc/keystone/yourca.pem
- export OS_CERT=/etc/keystone/yourpublickey.pem
- export OS_KEY=/etc/keystone/yourprivatekey.pem
-
-
-OPTIONS
-=======
-
-To get a list of available commands and options run::
-
- keystone help
-
-To get usage and options of a command::
-
- keystone help <command>
-
-
-EXAMPLES
-========
-
-Get information about endpoint-create command::
-
- keystone help endpoint-create
-
-View endpoints of OpenStack services::
-
- keystone catalog
-
-Create a 'service' project::
-
- keystone tenant-create --name=service
-
-Create service user for nova::
-
- keystone user-create --name=nova \
- --tenant_id=<project ID> \
- --email=nova@nothing.com
-
-View roles::
-
- keystone role-list
-
-
-BUGS
-====
-
-Keystone client is hosted in Launchpad so you can view current bugs at
-https://bugs.launchpad.net/python-keystoneclient/.