openstack/python-vitrageclient
Code Issues Proposed changes

add keycloak use documentation

Browse Source 
Change-Id: I4bb437398b8165cfe485fb31dfeabc1790ada585
This commit is contained in:
Eyal 2017-08-29 14:04:43 +03:00
parent 0baf51aba5
commit 2ed738db9b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/contributor/cli.rst
View File

@ -44,6 +44,12 @@ When using Keystone to obtain the token and endpoint::
When OS_USER_DOMAIN_NAME is not set, then 'Default' is assumed. Alternatively IDs can be used instead of names. When OS_USER_DOMAIN_NAME is not set, then 'Default' is assumed. Alternatively IDs can be used instead of names.
When using Keycloak instead of Keystone use the os-auth-type ``vitrage-keycloak``
and supply username, password, realm_name, endpoint, auth_url, openid_client_id.
The parameters can be supplied in command line e.g --username,--realm-name
or as environment variables with the prefix ``VITRAGE_`` e.g ``VITRAGE_REALM_NAME``
You'll find complete documentation on the shell by running You'll find complete documentation on the shell by running
``vitrage help``:: ``vitrage help``::
@ -707,3 +713,6 @@ Example::
myclient = client.Client('1',session=session) myclient = client.Client('1',session=session)
myclient.topology.get() myclient.topology.get()
If using Keycloak then for auth parameter use ``VitrageKeycloakPlugin`` class
instead of ``Password`` and supply the relevant parameters.