[DOC] Replace references to policy.json
The override file now supports yaml format. While JSON formatting is absolutely fine, the file suffix ".json" will confuse our tooling. Change-Id: I01ce4ab3e879a8dbbc7377997f7e497f15c9b15e Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
This commit is contained in:
parent
5866dadd4b
commit
95b44453b5
@ -22,7 +22,7 @@ Use this API to bring a share under the management of the Shared File
|
|||||||
Systems service. In the service, the share will be represented as a resource
|
Systems service. In the service, the share will be represented as a resource
|
||||||
in the database. It can have a user defined name and description.
|
in the database. It can have a user defined name and description.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.yaml`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -113,7 +113,7 @@ Unmanage share (DEPRECATED)
|
|||||||
Use this API to remove a share from the management of the Shared File
|
Use this API to remove a share from the management of the Shared File
|
||||||
Systems service without deleting the share.
|
Systems service without deleting the share.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.yaml`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
|
|
||||||
|
@ -1091,7 +1091,7 @@ export_location_share_instance_id:
|
|||||||
description: |
|
description: |
|
||||||
The UUID of the share instance that this
|
The UUID of the share instance that this
|
||||||
export location belongs to. This parameter is only available to users
|
export location belongs to. This parameter is only available to users
|
||||||
with an "administrator" role, and cannot be controlled via policy.json.
|
with an "administrator" role, and cannot be controlled via policy.yaml.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
@ -10,7 +10,7 @@ available access rules for a share, explicitly updating the state of a
|
|||||||
share, resizing a share and un-managing a share.
|
share, resizing a share and un-managing a share.
|
||||||
|
|
||||||
As administrator, you can reset the state of a share and force-
|
As administrator, you can reset the state of a share and force-
|
||||||
delete a share in any state. Use the ``policy.json`` file to grant
|
delete a share in any state. Use the ``policy.yaml`` file to grant
|
||||||
permissions for this action to other roles.
|
permissions for this action to other roles.
|
||||||
|
|
||||||
You can set the state of a share to one of these supported states:
|
You can set the state of a share to one of these supported states:
|
||||||
@ -245,7 +245,7 @@ Reset share state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share.
|
Administrator only. Explicitly updates the state of a share.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -287,7 +287,7 @@ Force-delete share
|
|||||||
|
|
||||||
Administrator only. Force-deletes a share in any state.
|
Administrator only. Force-deletes a share in any state.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -409,7 +409,7 @@ Unmanage share (since API v2.7)
|
|||||||
Use this API to remove a share from the management of the Shared File
|
Use this API to remove a share from the management of the Shared File
|
||||||
Systems service without deleting the share.
|
Systems service without deleting the share.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.yaml`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ You can update a share group snapshot to rename it, change its
|
|||||||
description, or update its state.
|
description, or update its state.
|
||||||
|
|
||||||
As administrator, you can also reset the state of a group snapshot. Use
|
As administrator, you can also reset the state of a group snapshot. Use
|
||||||
the ``policy.json`` file to grant permissions for these actions to other
|
the ``policy.yaml`` file to grant permissions for these actions to other
|
||||||
roles.
|
roles.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@ -307,7 +307,7 @@ Reset share group snapshot state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share group snapshot.
|
Administrator only. Explicitly updates the state of a share group snapshot.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -297,7 +297,7 @@ Reset share group state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share group.
|
Administrator only. Explicitly updates the state of a share group.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -5,7 +5,7 @@ Share instance export locations (since API v2.9)
|
|||||||
|
|
||||||
Set of APIs used to view export locations of share instances.
|
Set of APIs used to view export locations of share instances.
|
||||||
|
|
||||||
By default, these APIs are admin-only. Use the ``policy.json`` file
|
By default, these APIs are admin-only. Use the ``policy.yaml`` file
|
||||||
to grant permissions for these actions to other roles.
|
to grant permissions for these actions to other roles.
|
||||||
|
|
||||||
Lists all export locations for a share instance.
|
Lists all export locations for a share instance.
|
||||||
|
@ -9,7 +9,7 @@ multiple locations. Each of these individual locations is called an "instance"
|
|||||||
within the Shared File Systems service. End users need not be concerned with
|
within the Shared File Systems service. End users need not be concerned with
|
||||||
this internal representation. As an administrator, you can list, show
|
this internal representation. As an administrator, you can list, show
|
||||||
information for, explicitly set the state of, and force-delete share instances.
|
information for, explicitly set the state of, and force-delete share instances.
|
||||||
Use the ``policy.json`` file to grant permissions for these actions to other
|
Use the ``policy.yaml`` file to grant permissions for these actions to other
|
||||||
roles.
|
roles.
|
||||||
|
|
||||||
|
|
||||||
@ -142,7 +142,7 @@ Reset share instance state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share instance.
|
Administrator only. Explicitly updates the state of a share instance.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -184,7 +184,7 @@ Force-delete share instance
|
|||||||
|
|
||||||
Administrator only. Force-deletes a share instance.
|
Administrator only. Force-deletes a share instance.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -366,7 +366,7 @@ Reset status of the share replica
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the ``status`` of a share replica.
|
Administrator only. Explicitly updates the ``status`` of a share replica.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -409,7 +409,7 @@ Reset replica_state of the share replica
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the ``replica state`` of a share replica.
|
Administrator only. Explicitly updates the ``replica state`` of a share replica.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -489,7 +489,7 @@ Force-delete share replica
|
|||||||
|
|
||||||
Administrator only. Force-deletes a share replica in any state.
|
Administrator only. Force-deletes a share replica in any state.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -13,7 +13,7 @@ it contains no dependent shares. If an administrator deletes the
|
|||||||
share server, the Shared File Systems service creates a share
|
share server, the Shared File Systems service creates a share
|
||||||
server in response to a subsequent create share request.
|
server in response to a subsequent create share request.
|
||||||
|
|
||||||
An administrator can use the ``policy.json`` file to grant
|
An administrator can use the ``policy.yaml`` file to grant
|
||||||
permissions for share server actions to other roles.
|
permissions for share server actions to other roles.
|
||||||
|
|
||||||
The status of a share server indicates its current state. After you
|
The status of a share server indicates its current state. After you
|
||||||
@ -353,7 +353,7 @@ Resets a share server status
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share server.
|
Administrator only. Explicitly updates the state of a share server.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action to other
|
Use the ``policy.yaml`` file to grant permissions for this action to other
|
||||||
roles.
|
roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -84,7 +84,7 @@ capabilities_and_extra_specs.html>`_.
|
|||||||
Each driver implementation determines which extra specification
|
Each driver implementation determines which extra specification
|
||||||
keys it uses. For details, see the documentation for the driver.
|
keys it uses. For details, see the documentation for the driver.
|
||||||
|
|
||||||
An administrator can use the ``policy.json`` file to grant
|
An administrator can use the ``policy.yaml`` file to grant
|
||||||
permissions for share type creation with extra specifications to
|
permissions for share type creation with extra specifications to
|
||||||
other roles.
|
other roles.
|
||||||
|
|
||||||
|
@ -345,7 +345,7 @@ replicated or is in the process of being migrated is physically stored in
|
|||||||
multiple locations. Each of these individual locations is called an "instance"
|
multiple locations. Each of these individual locations is called an "instance"
|
||||||
within the Shared File Systems service. End users need not be concerned with
|
within the Shared File Systems service. End users need not be concerned with
|
||||||
this internal representation. As an administrator, you can list all instances
|
this internal representation. As an administrator, you can list all instances
|
||||||
of a share through this endpoint resource. Use the ``policy.json`` file to
|
of a share through this endpoint resource. Use the ``policy.yaml`` file to
|
||||||
grant permissions for this action to other roles.
|
grant permissions for this action to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -505,7 +505,7 @@ Manage share (since API v2.7)
|
|||||||
Use this API to bring a share under the management of the Shared File
|
Use this API to bring a share under the management of the Shared File
|
||||||
Systems service.
|
Systems service.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.yaml`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ and each individual location is called an "instance", internally within
|
|||||||
the Shared File Systems service.
|
the Shared File Systems service.
|
||||||
|
|
||||||
By default administrators can list, show information for and explicitly
|
By default administrators can list, show information for and explicitly
|
||||||
set the state of share snapshot instances. Use the ``policy.json`` file
|
set the state of share snapshot instances. Use the ``policy.yaml`` file
|
||||||
to grant permissions for these actions to other roles.
|
to grant permissions for these actions to other roles.
|
||||||
|
|
||||||
|
|
||||||
@ -175,7 +175,7 @@ Reset share snapshot instance state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share snapshot instance.
|
Administrator only. Explicitly updates the state of a share snapshot instance.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -38,7 +38,7 @@ description, or update its state to one of these supported states:
|
|||||||
- ``restoring``
|
- ``restoring``
|
||||||
|
|
||||||
As administrator, you can also reset the state of a snapshot and
|
As administrator, you can also reset the state of a snapshot and
|
||||||
force-delete a share snapshot in any state. Use the ``policy.json``
|
force-delete a share snapshot in any state. Use the ``policy.yaml``
|
||||||
file to grant permissions for these actions to other roles.
|
file to grant permissions for these actions to other roles.
|
||||||
|
|
||||||
|
|
||||||
@ -390,7 +390,7 @@ Reset share snapshot state
|
|||||||
|
|
||||||
Administrator only. Explicitly updates the state of a share snapshot.
|
Administrator only. Explicitly updates the state of a share snapshot.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
@ -430,7 +430,7 @@ Force-delete share snapshot
|
|||||||
|
|
||||||
Administrator only. Force-deletes a share snapshot in any state.
|
Administrator only. Force-deletes a share snapshot in any state.
|
||||||
|
|
||||||
Use the ``policy.json`` file to grant permissions for this action
|
Use the ``policy.yaml`` file to grant permissions for this action
|
||||||
to other roles.
|
to other roles.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
|
@ -60,7 +60,7 @@ specifications used to filter back ends.
|
|||||||
|
|
||||||
Administrators can create share group types with these extra specifications for
|
Administrators can create share group types with these extra specifications for
|
||||||
the back ends filtering.
|
the back ends filtering.
|
||||||
An administrator can use the ``policy.json`` file to grant permissions for
|
An administrator can use the ``policy.yaml`` file to grant permissions for
|
||||||
share group type creation with extra specifications to other roles.
|
share group type creation with extra specifications to other roles.
|
||||||
|
|
||||||
You set a share group type to private or public and
|
You set a share group type to private or public and
|
||||||
|
Loading…
Reference in New Issue
Block a user