From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/network-rbac.rst | 138 ++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 doc/source/cli/command-objects/network-rbac.rst (limited to 'doc/source/cli/command-objects/network-rbac.rst') diff --git a/doc/source/cli/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst new file mode 100644 index 00000000..c49f29bb --- /dev/null +++ b/doc/source/cli/command-objects/network-rbac.rst @@ -0,0 +1,138 @@ +============ +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 + --action + --target-project [--target-project-domain ] + [--project [--project-domain ]] + + +.. option:: --type + + Type of the object that RBAC policy affects ("qos_policy" or "network") (required) + +.. option:: --action + + Action for the RBAC policy ("access_as_external" or "access_as_shared") (required) + +.. option:: --target-project + + The project to which the RBAC policy will be enforced (name or ID) (required) + +.. option:: --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 + + The owner project (name or ID) + +.. option:: --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:: + + 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 + [ ...] + +.. _network_rbac_delete-rbac-policy: +.. describe:: + + 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 ] + [--action ] + [--long] + +.. option:: --type + + List network RBAC policies according to given object type ("qos_policy" or "network") + +.. option:: --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-domain ]] + + +.. option:: --target-project + + The project to which the RBAC policy will be enforced (name or ID) + +.. option:: --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 to be modified (ID only) + +network rbac show +----------------- + +Display network RBAC policy details + +.. program:: network rbac show +.. code:: bash + + openstack network rbac show + + +.. _network_rbac_show-rbac-policy: +.. describe:: + + RBAC policy (ID only) -- cgit v1.2.1