diff options
| author | Steve Martinelli <stevemar@ca.ibm.com> | 2015-03-28 03:39:07 -0400 |
|---|---|---|
| committer | Steve Martinelli <stevemar@ca.ibm.com> | 2015-04-15 05:09:48 +0000 |
| commit | caf91e69bace8f1f8201d6719b338ce3d78f42e4 (patch) | |
| tree | 5e481b1464a3ec786acd85569e6150c6050743bb | |
| parent | ba7ad20942061eface8a0f11f302147744b59418 (diff) | |
| download | python-openstackclient-caf91e69bace8f1f8201d6719b338ce3d78f42e4.tar.gz | |
Add docs for service provider CRUD
This patch adds service providers to command-objects, and makes
a few changes to the help text, to align it more with the
already established identity provider resource.
Change-Id: Ibf3d2bc04bf5588d1fc9c37b8ca28c007496c021
| -rw-r--r-- | doc/source/command-objects/service-provider.rst | 125 | ||||
| -rw-r--r-- | doc/source/commands.rst | 1 | ||||
| -rw-r--r-- | openstackclient/identity/v3/service_provider.py | 34 |
3 files changed, 144 insertions, 16 deletions
diff --git a/doc/source/command-objects/service-provider.rst b/doc/source/command-objects/service-provider.rst new file mode 100644 index 00000000..963493b4 --- /dev/null +++ b/doc/source/command-objects/service-provider.rst @@ -0,0 +1,125 @@ +================ +service provider +================ + +Identity v3 + +`Requires: OS-FEDERATION extension` + +service provider create +----------------------- + +Create new service provider + +.. program:: service provider create +.. code:: bash + + os service provider create + [--description <description>] + [--enable | --disable] + --auth-url <auth-url> + --service-provider-url <sp-url> + <name> + +.. option:: --auth-url + + Authentication URL of remote federated service provider (required) + +.. option:: --service-provider-url + + A service URL where SAML assertions are being sent (required) + +.. option:: --description + + New service provider description + +.. option:: --enable + + Enable the service provider (default) + +.. option:: --disable + + Disable the service provider + +.. describe:: <name> + + New service provider name (must be unique) + +service provider delete +----------------------- + +Delete service provider + +.. program:: service provider delete +.. code:: bash + + os service provider delete + <service-provider> + +.. describe:: <service-provider> + + Service provider to delete + +service provider list +--------------------- + +List service providers + +.. program:: service provider list +.. code:: bash + + os service provider list + +service provider set +-------------------- + +Set service provider properties + +.. program:: service provider set +.. code:: bash + + os service provider set + [--enable | --disable] + [--description <description>] + [--auth-url <auth-url>] + [--service-provider-url <sp-url>] + <service-provider> + +.. option:: --service-provider-url + + New service provider URL, where SAML assertions are sent + +.. option:: --auth-url + + New Authentication URL of remote federated service provider + +.. option:: --description + + New service provider description + +.. option:: --enable + + Enable the service provider + +.. option:: --disable + + Disable the service provider + +.. describe:: <service-provider> + + Service provider to modify + +service provider show +--------------------- + +Display service provider details + +.. program:: service provider show +.. code:: bash + + os service provider show + <service-provider> + +.. describe:: <service-provider> + + Service provider to display diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 42d041af..b52d9459 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -111,6 +111,7 @@ referring to both Compute and Volume quotas. * ``server``: (**Compute**) virtual machine instance * ``server image``: (**Compute**) saved server disk image * ``service``: (**Identity**) a cloud service +* ``service provider``: (**Identity**) a resource that consumes assertions from an ``identity provider`` * ``snapshot``: (**Volume**) a point-in-time copy of a volume * ``token``: (**Identity**) a bearer token managed by Identity service * ``usage``: (**Compute**) display host resources being consumed diff --git a/openstackclient/identity/v3/service_provider.py b/openstackclient/identity/v3/service_provider.py index 31e96a83..78f96b6c 100644 --- a/openstackclient/identity/v3/service_provider.py +++ b/openstackclient/identity/v3/service_provider.py @@ -33,14 +33,15 @@ class CreateServiceProvider(show.ShowOne): parser = super(CreateServiceProvider, self).get_parser(prog_name) parser.add_argument( 'service_provider_id', - metavar='<service-provider-id>', - help='New service provider ID (must be unique)' + metavar='<name>', + help='New service provider name (must be unique)' ) parser.add_argument( '--auth-url', metavar='<auth-url>', required=True, - help='Authentication URL of remote federated service provider', + help='Authentication URL of remote federated service provider ' + '(required)', ) parser.add_argument( '--description', @@ -51,7 +52,8 @@ class CreateServiceProvider(show.ShowOne): '--service-provider-url', metavar='<sp-url>', required=True, - help='A service URL where SAML assertions are being sent', + help='A service URL where SAML assertions are being sent ' + '(required)', ) enable_service_provider = parser.add_mutually_exclusive_group() @@ -60,13 +62,13 @@ class CreateServiceProvider(show.ShowOne): dest='enabled', action='store_true', default=True, - help='Enable service provider (default)', + help='Enable the service provider (default)', ) enable_service_provider.add_argument( '--disable', dest='enabled', action='store_false', - help='Disable service provider', + help='Disable the service provider', ) return parser @@ -94,8 +96,8 @@ class DeleteServiceProvider(command.Command): parser = super(DeleteServiceProvider, self).get_parser(prog_name) parser.add_argument( 'service_provider', - metavar='<service-provider-id>', - help='Service provider ID to delete (ID)', + metavar='<service-provider>', + help='Service provider to delete', ) return parser @@ -134,13 +136,13 @@ class SetServiceProvider(command.Command): parser = super(SetServiceProvider, self).get_parser(prog_name) parser.add_argument( 'service_provider', - metavar='<service-provider-id>', - help='Service provider ID to change (ID)', + metavar='<service-provider>', + help='Service provider to modify', ) parser.add_argument( '--auth-url', metavar='<auth-url>', - help='Authentication URL of remote federated Service Provider', + help='New Authentication URL of remote federated service provider', ) parser.add_argument( @@ -151,18 +153,18 @@ class SetServiceProvider(command.Command): parser.add_argument( '--service-provider-url', metavar='<sp-url>', - help='A service URL where SAML assertions are being sent', + help='New service provider URL, where SAML assertions are sent', ) enable_service_provider = parser.add_mutually_exclusive_group() enable_service_provider.add_argument( '--enable', action='store_true', - help='Enable service provider', + help='Enable the service provider', ) enable_service_provider.add_argument( '--disable', action='store_true', - help='Disable service provider', + help='Disable the service provider', ) return parser @@ -200,8 +202,8 @@ class ShowServiceProvider(show.ShowOne): parser = super(ShowServiceProvider, self).get_parser(prog_name) parser.add_argument( 'service_provider', - metavar='<service-provider-id>', - help='Service provider ID to display (ID)', + metavar='<service-provider>', + help='Service provider to display', ) return parser |
