summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network-rbac.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/network-rbac.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/network-rbac.rst')
-rw-r--r--doc/source/command-objects/network-rbac.rst138
1 files changed, 0 insertions, 138 deletions
diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/command-objects/network-rbac.rst
deleted file mode 100644
index c49f29bb..00000000
--- a/doc/source/command-objects/network-rbac.rst
+++ /dev/null
@@ -1,138 +0,0 @@
-============
-network rbac
-============
-
-A **network rbac** is a Role-Based Access Control (RBAC) policy for
-network resources. It enables both operators and users to grant access
-to network resources for specific projects.
-
-Network v2
-
-network rbac create
--------------------
-
-Create network RBAC policy
-
-.. program:: network rbac create
-.. code:: bash
-
- openstack network rbac create
- --type <type>
- --action <action>
- --target-project <target-project> [--target-project-domain <target-project-domain>]
- [--project <project> [--project-domain <project-domain>]]
- <rbac-policy>
-
-.. option:: --type <type>
-
- Type of the object that RBAC policy affects ("qos_policy" or "network") (required)
-
-.. option:: --action <action>
-
- Action for the RBAC policy ("access_as_external" or "access_as_shared") (required)
-
-.. option:: --target-project <target-project>
-
- The project to which the RBAC policy will be enforced (name or ID) (required)
-
-.. option:: --target-project-domain <target-project-domain>
-
- Domain the target project belongs to (name or ID).
- This can be used in case collisions between project names exist.
-
-.. option:: --project <project>
-
- The owner project (name or ID)
-
-.. option:: --project-domain <project-domain>
-
- Domain the project belongs to (name or ID).
- This can be used in case collisions between project names exist.
-
-.. _network_rbac_create-rbac-policy:
-.. describe:: <rbac-object>
-
- The object to which this RBAC policy affects (name or ID)
-
-network rbac delete
--------------------
-
-Delete network RBAC policy(s)
-
-.. program:: network rbac delete
-.. code:: bash
-
- openstack network rbac delete
- <rbac-policy> [<rbac-policy> ...]
-
-.. _network_rbac_delete-rbac-policy:
-.. describe:: <rbac-policy>
-
- RBAC policy(s) to delete (ID only)
-
-network rbac list
------------------
-
-List network RBAC policies
-
-.. program:: network rbac list
-.. code:: bash
-
- openstack network rbac list
- [--type <type>]
- [--action <action>]
- [--long]
-
-.. option:: --type <type>
-
- List network RBAC policies according to given object type ("qos_policy" or "network")
-
-.. option:: --action <action>
-
- List network RBAC policies according to given action ("access_as_external" or "access_as_shared")
-
-.. option:: --long
-
- List additional fields in output
-
-network rbac set
-----------------
-
-Set network RBAC policy properties
-
-.. program:: network rbac set
-.. code:: bash
-
- openstack network rbac set
- [--target-project <target-project> [--target-project-domain <target-project-domain>]]
- <rbac-policy>
-
-.. option:: --target-project <target-project>
-
- The project to which the RBAC policy will be enforced (name or ID)
-
-.. option:: --target-project-domain <target-project-domain>
-
- Domain the target project belongs to (name or ID).
- This can be used in case collisions between project names exist.
-
-.. _network_rbac_set-rbac-policy:
-.. describe:: <rbac-policy>
-
- RBAC policy to be modified (ID only)
-
-network rbac show
------------------
-
-Display network RBAC policy details
-
-.. program:: network rbac show
-.. code:: bash
-
- openstack network rbac show
- <rbac-policy>
-
-.. _network_rbac_show-rbac-policy:
-.. describe:: <rbac-policy>
-
- RBAC policy (ID only)