From 5521e4c504c6a3a06f17a9e4f80444743aa293c7 Mon Sep 17 00:00:00 2001 From: Roxana Gherle Date: Fri, 22 May 2015 16:22:35 -0700 Subject: Add --os-endpoint-type cli optional argument User should be able to specify the endpoint type through a CLI optional argument/ENV variable setting. We will name this new optional argument: --os-endpoint-type (Env: OS_ENDPOINT_TYPE) and based on the value given, the service API will use that specific endpoint type. Possible values: public, admin, internal. DocImpact Closes-Bug: #1454392 Change-Id: Ife3d4e46b44c0ddcd712b1130e27e362545a9a29 --- doc/source/configuration.rst | 8 +++++++- doc/source/man/openstack.rst | 5 +++++ 2 files changed, 12 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index e371e504..b603eee4 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -78,6 +78,7 @@ The keys match the :program:`openstack` global options but without the username: openstack password: xyzpdq!lazydog region_name: DFW,ORD,IAD + endpoint_type: internal In the above example, the ``auth_url`` for the ``rackspace`` cloud is taken from :file:`clouds-public.yaml` (see below). @@ -96,6 +97,7 @@ to the following options if the ``rackspace`` entry in :file:`clouds-public.yaml --os-username openstack --os-password xyzpdq!lazydog --os-region-name DFW + --os-endpoint-type internal and can be selected on the command line:: @@ -105,13 +107,17 @@ Note that multiple regions are listed in the ``rackspace`` entry. An otherwise identical configuration is created for each region. If ``-os-region-name`` is not specified on the command line, the first region in the list is used by default. +The selection of ``endpoint_type`` (as seen above in the ``rackspace`` entry) +is optional. For this configuration to work, every service for this cloud +instance must already be configured to support this type of endpoint. + clouds-public.yaml ~~~~~~~~~~~~~~~~~~ :file:`clouds-public.yaml` is a configuration file that is intended to contain public information about clouds that are common across a large number of users. The idea is that :file:`clouds-public.yaml` could easily be shared among users -to simplify public could configuration. +to simplify public cloud configuration. Similar to :file:`clouds.yaml`, OpenStackClient looks for :file:`clouds-public.yaml` in the following locations: diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst index 6d6dce44..9d711527 100644 --- a/doc/source/man/openstack.rst +++ b/doc/source/man/openstack.rst @@ -120,6 +120,8 @@ OPTIONS :option:`--os-XXXX-api-version` Additional API version options will be available depending on the installed API libraries. +:option:`--os-endpoint-type` + Endpoint type. Valid options are `public`, `admin` and `internal`. COMMANDS ======== @@ -344,6 +346,9 @@ The following environment variables can be set to alter the behaviour of :progra :envvar:`OS_XXXX_API_VERSION` Additional API version options will be available depending on the installed API libraries. +:envvar:`OS_ENDPOINT_TYPE` + Endpoint type. Valid options are `public`, `admin` and `internal`. + BUGS ==== -- cgit v1.2.1