From 95b44453b54cd7db431542c3f9c0596b1d3335f9 Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Wed, 22 Jun 2022 16:20:03 +0530 Subject: [PATCH] [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 --- api-ref/source/os-share-manage.inc | 4 ++-- api-ref/source/parameters.yaml | 2 +- api-ref/source/share-actions.inc | 8 ++++---- api-ref/source/share-group-snapshots.inc | 4 ++-- api-ref/source/share-groups.inc | 2 +- api-ref/source/share-instance-export-locations.inc | 2 +- api-ref/source/share-instances.inc | 6 +++--- api-ref/source/share-replicas.inc | 6 +++--- api-ref/source/share-servers.inc | 4 ++-- api-ref/source/share-types.inc | 2 +- api-ref/source/shares.inc | 4 ++-- api-ref/source/snapshot-instances.inc | 4 ++-- api-ref/source/snapshots.inc | 6 +++--- .../admin/shared-file-systems-share-group-types.rst | 2 +- 14 files changed, 28 insertions(+), 28 deletions(-) diff --git a/api-ref/source/os-share-manage.inc b/api-ref/source/os-share-manage.inc index db35ed3e4b..21db419d9a 100644 --- a/api-ref/source/os-share-manage.inc +++ b/api-ref/source/os-share-manage.inc @@ -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 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. Response codes @@ -113,7 +113,7 @@ Unmanage share (DEPRECATED) Use this API to remove a share from the management of the Shared File 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. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index dff5b04cdd..7313e3c28f 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1091,7 +1091,7 @@ export_location_share_instance_id: description: | The UUID of the share instance that this 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 required: true type: string diff --git a/api-ref/source/share-actions.inc b/api-ref/source/share-actions.inc index 51e35162d1..fc83e3f95d 100644 --- a/api-ref/source/share-actions.inc +++ b/api-ref/source/share-actions.inc @@ -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. 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. 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. -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. Response codes @@ -287,7 +287,7 @@ Force-delete share 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. 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 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. diff --git a/api-ref/source/share-group-snapshots.inc b/api-ref/source/share-group-snapshots.inc index 1af3a2394a..f98163ad24 100644 --- a/api-ref/source/share-group-snapshots.inc +++ b/api-ref/source/share-group-snapshots.inc @@ -13,7 +13,7 @@ You can update a share group snapshot to rename it, change its description, or update its state. 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. .. note:: @@ -307,7 +307,7 @@ Reset share group snapshot state 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. Response codes diff --git a/api-ref/source/share-groups.inc b/api-ref/source/share-groups.inc index 9b5cc8f38f..fffb9d75dc 100644 --- a/api-ref/source/share-groups.inc +++ b/api-ref/source/share-groups.inc @@ -297,7 +297,7 @@ Reset share group state 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. Response codes diff --git a/api-ref/source/share-instance-export-locations.inc b/api-ref/source/share-instance-export-locations.inc index 05b52acd57..0f682f3b5c 100644 --- a/api-ref/source/share-instance-export-locations.inc +++ b/api-ref/source/share-instance-export-locations.inc @@ -5,7 +5,7 @@ Share instance export locations (since API v2.9) 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. Lists all export locations for a share instance. diff --git a/api-ref/source/share-instances.inc b/api-ref/source/share-instances.inc index ac7befc0a5..720049b90a 100644 --- a/api-ref/source/share-instances.inc +++ b/api-ref/source/share-instances.inc @@ -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 this internal representation. As an administrator, you can list, show 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. @@ -142,7 +142,7 @@ Reset share instance state 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. Response codes @@ -184,7 +184,7 @@ Force-delete 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. Response codes diff --git a/api-ref/source/share-replicas.inc b/api-ref/source/share-replicas.inc index f55dc2ec05..2fede8b473 100644 --- a/api-ref/source/share-replicas.inc +++ b/api-ref/source/share-replicas.inc @@ -366,7 +366,7 @@ Reset status of the 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. Response codes @@ -409,7 +409,7 @@ Reset replica_state of the 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. Response codes @@ -489,7 +489,7 @@ Force-delete share replica 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. Response codes diff --git a/api-ref/source/share-servers.inc b/api-ref/source/share-servers.inc index 450bd2d4e0..6248c55b45 100644 --- a/api-ref/source/share-servers.inc +++ b/api-ref/source/share-servers.inc @@ -13,7 +13,7 @@ it contains no dependent shares. If an administrator deletes the share server, the Shared File Systems service creates a share 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. 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. -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. Response codes diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index 39d32296fa..531af9bfd2 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -84,7 +84,7 @@ capabilities_and_extra_specs.html>`_. Each driver implementation determines which extra specification 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 other roles. diff --git a/api-ref/source/shares.inc b/api-ref/source/shares.inc index a5fd3018f2..bde597cb40 100644 --- a/api-ref/source/shares.inc +++ b/api-ref/source/shares.inc @@ -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" within the Shared File Systems service. End users need not be concerned with 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. 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 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. diff --git a/api-ref/source/snapshot-instances.inc b/api-ref/source/snapshot-instances.inc index 4779e815f9..8947bfe9fd 100644 --- a/api-ref/source/snapshot-instances.inc +++ b/api-ref/source/snapshot-instances.inc @@ -11,7 +11,7 @@ and each individual location is called an "instance", internally within the Shared File Systems service. 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. @@ -175,7 +175,7 @@ Reset share snapshot instance state 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. Response codes diff --git a/api-ref/source/snapshots.inc b/api-ref/source/snapshots.inc index e620da84e6..c25ab229bc 100644 --- a/api-ref/source/snapshots.inc +++ b/api-ref/source/snapshots.inc @@ -38,7 +38,7 @@ description, or update its state to one of these supported states: - ``restoring`` 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. @@ -390,7 +390,7 @@ Reset share snapshot state 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. Response codes @@ -430,7 +430,7 @@ Force-delete share snapshot 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. Response codes diff --git a/doc/source/admin/shared-file-systems-share-group-types.rst b/doc/source/admin/shared-file-systems-share-group-types.rst index 39581a7aab..b7cc4b5a7b 100644 --- a/doc/source/admin/shared-file-systems-share-group-types.rst +++ b/doc/source/admin/shared-file-systems-share-group-types.rst @@ -60,7 +60,7 @@ specifications used to filter back ends. Administrators can create share group types with these extra specifications for 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. You set a share group type to private or public and