From 4e391920ba15e328866812455aa435c638e5258e Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Tue, 4 Oct 2022 12:13:37 -0700 Subject: [PATCH] rename 'mc policy' -> 'mc anonymous' deprecated command (#597) Co-authored-by: Ravind Kumar --- source/reference/minio-mc.rst | 26 +++++++------- ...get-json.rst => mc-anonymous-get-json.rst} | 20 +++++------ ...mc-policy-get.rst => mc-anonymous-get.rst} | 22 ++++++------ ...olicy-links.rst => mc-anonymous-links.rst} | 20 +++++------ ...-policy-list.rst => mc-anonymous-list.rst} | 20 +++++------ ...set-json.rst => mc-anonymous-set-json.rst} | 34 +++++++++---------- ...mc-policy-set.rst => mc-anonymous-set.rst} | 34 +++++++++---------- 7 files changed, 88 insertions(+), 88 deletions(-) rename source/reference/minio-mc/{mc-policy-get-json.rst => mc-anonymous-get-json.rst} (79%) rename source/reference/minio-mc/{mc-policy-get.rst => mc-anonymous-get.rst} (80%) rename source/reference/minio-mc/{mc-policy-links.rst => mc-anonymous-links.rst} (81%) rename source/reference/minio-mc/{mc-policy-list.rst => mc-anonymous-list.rst} (80%) rename source/reference/minio-mc/{mc-policy-set-json.rst => mc-anonymous-set-json.rst} (70%) rename source/reference/minio-mc/{mc-policy-set.rst => mc-anonymous-set.rst} (77%) diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 7ae7d5a7..821b5e20 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -254,14 +254,14 @@ The following table lists :mc-cmd:`mc` commands: :start-after: start-mc-pipe-desc :end-before: end-mc-pipe-desc - * - | :mc:`mc policy set` - | :mc:`mc policy set-json` - | :mc:`mc policy get` - | :mc:`mc policy get-json` - | :mc:`mc policy list` - | :mc:`mc policy links` + * - | :mc:`mc anonymous set` + | :mc:`mc anonymous set-json` + | :mc:`mc anonymous get` + | :mc:`mc anonymous get-json` + | :mc:`mc anonymous list` + | :mc:`mc anonymous links` - - The :mc:`mc policy` command supports setting or removing anonymous + - The :mc:`mc anonymous` command supports setting or removing anonymous :ref:`policies ` to a bucket and its contents. Buckets with anonymous policies allow public access where clients can perform any action granted by the policy without :ref:`authentication @@ -459,6 +459,12 @@ All :ref:`commands ` support the following global options: /reference/minio-mc/mc-alias-set /reference/minio-mc/mc-alias-list /reference/minio-mc/mc-alias-remove + /reference/minio-mc/mc-anonymous-set + /reference/minio-mc/mc-anonymous-get + /reference/minio-mc/mc-anonymous-list + /reference/minio-mc/mc-anonymous-links + /reference/minio-mc/mc-anonymous-get-json + /reference/minio-mc/mc-anonymous-set-json /reference/minio-mc/mc-cat /reference/minio-mc/mc-cp /reference/minio-mc/mc-diff @@ -488,12 +494,6 @@ All :ref:`commands ` support the following global options: /reference/minio-mc/mc-mirror /reference/minio-mc/mc-mv /reference/minio-mc/mc-pipe - /reference/minio-mc/mc-policy-set - /reference/minio-mc/mc-policy-get - /reference/minio-mc/mc-policy-list - /reference/minio-mc/mc-policy-links - /reference/minio-mc/mc-policy-get-json - /reference/minio-mc/mc-policy-set-json /reference/minio-mc/mc-rb /reference/minio-mc/mc-replicate-add /reference/minio-mc/mc-replicate-edit diff --git a/source/reference/minio-mc/mc-policy-get-json.rst b/source/reference/minio-mc/mc-anonymous-get-json.rst similarity index 79% rename from source/reference/minio-mc/mc-policy-get-json.rst rename to source/reference/minio-mc/mc-anonymous-get-json.rst index 199f0837..aaea51c7 100644 --- a/source/reference/minio-mc/mc-policy-get-json.rst +++ b/source/reference/minio-mc/mc-anonymous-get-json.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-get-json: -====================== -``mc policy get-json`` -====================== +========================= +``mc anonymous get-json`` +========================= .. default-domain:: minio @@ -10,14 +10,14 @@ :local: :depth: 2 -.. mc:: mc policy get-json +.. mc:: mc anonymous get-json Syntax ------ .. start-mc-policy-get-json-desc -The :mc:`mc policy get-json` command gets anonymous (i.e. unauthenticated or +The :mc:`mc anonymous get-json` command gets anonymous (i.e. unauthenticated or public) access :ref:`policies ` for a bucket. .. end-mc-policy-get-json-desc @@ -36,7 +36,7 @@ and perform actions consistent with the specified policy without .. code-block:: shell :class: copyable - mc policy get-json myminio/mydata + mc anonymous get-json myminio/mydata .. tab-item:: SYNTAX @@ -80,18 +80,18 @@ Examples Get Anonymous Policy for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc-cmd:`mc policy get-json` to get the anonymous policy for a +Use :mc-cmd:`mc anonymous get-json` to get the anonymous policy for a bucket: .. code-block:: shell :class: copyable - mc policy get-json ALIAS/PATH + mc anonymous get-json ALIAS/PATH -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior -------- diff --git a/source/reference/minio-mc/mc-policy-get.rst b/source/reference/minio-mc/mc-anonymous-get.rst similarity index 80% rename from source/reference/minio-mc/mc-policy-get.rst rename to source/reference/minio-mc/mc-anonymous-get.rst index caa3fbd6..0a453278 100644 --- a/source/reference/minio-mc/mc-policy-get.rst +++ b/source/reference/minio-mc/mc-anonymous-get.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-get: -================= -``mc policy get`` -================= +==================== +``mc anonymous get`` +==================== .. default-domain:: minio @@ -10,14 +10,14 @@ :local: :depth: 2 -.. mc:: mc policy get +.. mc:: mc anonymous get Syntax ------ .. start-mc-policy-get-desc -The :mc:`mc policy get` command gets the anonymous (i.e. unauthenticated or +The :mc:`mc anonymous get` command gets the anonymous (i.e. unauthenticated or public) access :ref:`policies ` for a bucket. .. end-mc-policy-get-desc @@ -27,7 +27,7 @@ and perform actions consistent with the specified policy without :ref:`authentication `. To get the :s3-docs:`JSON policy ` assigned to the bucket, -use the :mc-cmd:`mc policy get-json` command. +use the :mc-cmd:`mc anonymous get-json` command. .. tab-set:: @@ -39,7 +39,7 @@ use the :mc-cmd:`mc policy get-json` command. .. code-block:: shell :class: copyable - mc policy get myminio/mydata + mc anonymous get myminio/mydata .. tab-item:: SYNTAX @@ -84,18 +84,18 @@ Examples Get Anonymous Policy for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc:`mc policy get` to get the anonymous policy for a +Use :mc:`mc anonymous get` to get the anonymous policy for a bucket: .. code-block:: shell :class: copyable - mc policy get ALIAS/PATH + mc anonymous get ALIAS/PATH -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior -------- diff --git a/source/reference/minio-mc/mc-policy-links.rst b/source/reference/minio-mc/mc-anonymous-links.rst similarity index 81% rename from source/reference/minio-mc/mc-policy-links.rst rename to source/reference/minio-mc/mc-anonymous-links.rst index c2216c07..f4e25bb4 100644 --- a/source/reference/minio-mc/mc-policy-links.rst +++ b/source/reference/minio-mc/mc-anonymous-links.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-links: -=================== -``mc policy links`` -=================== +====================== +``mc anonymous links`` +====================== .. default-domain:: minio @@ -10,14 +10,14 @@ :local: :depth: 2 -.. mc:: mc policy links +.. mc:: mc anonymous links Syntax ------ .. start-mc-policy-links-desc -The :mc:`mc policy links` retrieves the HTTP URL for anonymous (i.e. +The :mc:`mc anonymous links` retrieves the HTTP URL for anonymous (i.e. unauthenticated or public) access to a bucket. .. end-mc-policy-links-desc @@ -36,7 +36,7 @@ and perform actions consistent with the specified policy without .. code-block:: shell :class: copyable - mc policy links --recursive myminio/mydata + mc anonymous links --recursive myminio/mydata .. tab-item:: SYNTAX @@ -87,18 +87,18 @@ Examples List Anonymous Policies for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc:`mc policy links` to links the anonymous policies for a +Use :mc:`mc anonymous links` to links the anonymous policies for a bucket: .. code-block:: shell :class: copyable - mc policy links ALIAS/PATH + mc anonymous links ALIAS/PATH -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior -------- diff --git a/source/reference/minio-mc/mc-policy-list.rst b/source/reference/minio-mc/mc-anonymous-list.rst similarity index 80% rename from source/reference/minio-mc/mc-policy-list.rst rename to source/reference/minio-mc/mc-anonymous-list.rst index c133e269..db5ea16e 100644 --- a/source/reference/minio-mc/mc-policy-list.rst +++ b/source/reference/minio-mc/mc-anonymous-list.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-list: -================== -``mc policy list`` -================== +===================== +``mc anonymous list`` +===================== .. default-domain:: minio @@ -10,14 +10,14 @@ :local: :depth: 2 -.. mc:: mc policy list +.. mc:: mc anonymous list Syntax ------ .. start-mc-policy-list-desc -The :mc:`mc policy list` retrieves all anonymous (i.e. unauthenticated or +The :mc:`mc anonymous list` retrieves all anonymous (i.e. unauthenticated or public) access policies for a bucket. .. end-mc-policy-list-desc @@ -36,7 +36,7 @@ and perform actions consistent with the specified policy without .. code-block:: shell :class: copyable - mc policy list myminio/mydata + mc anonymous list myminio/mydata .. tab-item:: SYNTAX @@ -81,18 +81,18 @@ Examples List Anonymous Policies for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc:`mc policy list` to list the anonymous policies for a +Use :mc:`mc anonymous list` to list the anonymous policies for a bucket: .. code-block:: shell :class: copyable - mc policy list ALIAS/PATH + mc anonymous list ALIAS/PATH -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior -------- diff --git a/source/reference/minio-mc/mc-policy-set-json.rst b/source/reference/minio-mc/mc-anonymous-set-json.rst similarity index 70% rename from source/reference/minio-mc/mc-policy-set-json.rst rename to source/reference/minio-mc/mc-anonymous-set-json.rst index f55a7d45..4933850a 100644 --- a/source/reference/minio-mc/mc-policy-set-json.rst +++ b/source/reference/minio-mc/mc-anonymous-set-json.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-set-json: -====================== -``mc policy set-json`` -====================== +========================= +``mc anonymous set-json`` +========================= .. default-domain:: minio @@ -10,14 +10,14 @@ :local: :depth: 2 -.. mc:: mc policy set-json +.. mc:: mc anonymous set-json Syntax ------ .. start-mc-policy-set-json-desc -The :mc:`mc policy set-json` command sets anonymous (i.e. unauthenticated or +The :mc:`mc anonymous set-json` command sets anonymous (i.e. unauthenticated or public) access :ref:`policies ` for a bucket using using an IAM :s3-docs:`JSON policy document `. @@ -37,7 +37,7 @@ and perform actions consistent with the specified policy without .. code-block:: shell :class: copyable - mc policy set-json ~/mydata-anonymous.json myminio/mydata + mc anonymous set-json ~/mydata-anonymous.json myminio/mydata .. tab-item:: SYNTAX @@ -64,7 +64,7 @@ Parameters .. mc-cmd:: ALIAS *Required* The full path to the bucket or bucket prefix to which the - command applies the specified :mc-cmd:`~mc policy set-json POLICY`. + command applies the specified :mc-cmd:`~mc anonymous set-json POLICY`. Specify the :ref:`alias ` of the MinIO or other S3-compatible service *and* the full path to the bucket or bucket @@ -87,37 +87,37 @@ Examples Set Anonymous Policy for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc-cmd:`mc policy set-json` to set the anonymous policy for a +Use :mc-cmd:`mc anonymous set-json` to set the anonymous policy for a bucket: .. code-block:: shell :class: copyable - mc policy set-json POLICY ALIAS/PATH + mc anonymous set-json POLICY ALIAS/PATH -- Replace :mc-cmd:`POLICY ` with a supported - :mc-cmd:`POLICY `. +- Replace :mc-cmd:`POLICY ` with a supported + :mc-cmd:`POLICY `. -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Remove Anonymous Policy for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc:`mc policy set` to clear the anonymous policy for a +Use :mc:`mc anonymous set` to clear the anonymous policy for a bucket: .. code-block:: shell :class: copyable - mc policy set none ALIAS/PATH + mc anonymous set none ALIAS/PATH -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior -------- diff --git a/source/reference/minio-mc/mc-policy-set.rst b/source/reference/minio-mc/mc-anonymous-set.rst similarity index 77% rename from source/reference/minio-mc/mc-policy-set.rst rename to source/reference/minio-mc/mc-anonymous-set.rst index 94a03b75..9079b8ac 100644 --- a/source/reference/minio-mc/mc-policy-set.rst +++ b/source/reference/minio-mc/mc-anonymous-set.rst @@ -1,8 +1,8 @@ .. _minio-mc-policy-set: -================= -``mc policy set`` -================= +==================== +``mc anonymous set`` +==================== .. default-domain:: minio @@ -10,15 +10,15 @@ :local: :depth: 2 -.. mc:: mc policy -.. mc:: mc policy set +.. mc:: mc anonymous +.. mc:: mc anonymous set Syntax ------ .. start-mc-policy-set-desc -The :mc:`mc policy set` command sets anonymous (i.e. unauthenticated or public) +The :mc:`mc anonymous set` command sets anonymous (i.e. unauthenticated or public) access :ref:`policies ` for a bucket. .. end-mc-policy-set-desc @@ -29,7 +29,7 @@ and perform actions consistent with the specified policy without To set anonymous bucket policies using an IAM :s3-docs:`JSON policy `, use the -:mc-cmd:`mc policy set-json` command. +:mc-cmd:`mc anonymous set-json` command. .. tab-set:: @@ -41,9 +41,9 @@ To set anonymous bucket policies using an IAM .. code-block:: shell :class: copyable - mc policy set upload myminio/uploads - mc policy set download myminio/downloads - mc policy set public myminio/public + mc anonymous set upload myminio/uploads + mc anonymous set download myminio/downloads + mc anonymous set public myminio/public Applications can perform the following operations without authentication: @@ -80,7 +80,7 @@ Parameters .. mc-cmd:: ALIAS *Required* The full path to the bucket or bucket prefix to which the - command applies the specified :mc-cmd:`~mc policy set PERMISSION`. + command applies the specified :mc-cmd:`~mc anonymous set PERMISSION`. Specify the :ref:`alias ` of the MinIO or other S3-compatible service *and* the full path to the bucket or bucket @@ -112,21 +112,21 @@ Examples Set Anonymous Policy for Bucket ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :mc:`mc policy set` to set the anonymous policy for a +Use :mc:`mc anonymous set` to set the anonymous policy for a bucket: .. code-block:: shell :class: copyable - mc policy set POLICY ALIAS/PATH + mc anonymous set POLICY ALIAS/PATH -- Replace :mc-cmd:`POLICY ` with a supported - :mc-cmd:`permission `. +- Replace :mc-cmd:`POLICY ` with a supported + :mc-cmd:`permission `. -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of a configured S3-compatible host. -- Replace :mc-cmd:`PATH ` with the destination bucket. +- Replace :mc-cmd:`PATH ` with the destination bucket. Behavior --------