From 7736389e86eb04a93e458d1d0d5745f87746113f Mon Sep 17 00:00:00 2001 From: ravindk89 Date: Wed, 5 May 2021 18:50:37 -0400 Subject: [PATCH] Fixing envvars --- source/index.rst | 8 ++-- .../reference/minio-server/minio-server.rst | 20 +++++----- source/security/IAM/iam-users.rst | 4 +- source/tutorials/minio-installation.rst | 40 +++++++++---------- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/source/index.rst b/source/index.rst index a18b5d5c..0acc75b1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -66,8 +66,8 @@ such as versioning and replication. .. code-block:: shell :class: copyable - export MINIO_ROOT_USER_FILE=myminioaccesskey - export MINIO_ROOT_PASSWORD_FILE=myminiosecretkey + export MINIO_ROOT_USER=myminioaccesskey + export MINIO_ROOT_PASSWORD=myminiosecretkey export MINIO_KMS_SECRET_KEY=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo= minio server /mnt/data @@ -77,11 +77,11 @@ such as versioning and replication. :widths: 30 60 :width: 100% - * - :envvar:`MINIO_ROOT_USER_FILE` + * - :envvar:`MINIO_ROOT_USER` - The :ref:`root user ` access key. Replace the sample value with a long, random, and unique string. - * - :envvar:`MINIO_ROOT_PASSWORD_FILE` + * - :envvar:`MINIO_ROOT_PASSWORD` - The :ref:`root user ` secret key. Replace the sample value with a long, random, and unique string. diff --git a/source/reference/minio-server/minio-server.rst b/source/reference/minio-server/minio-server.rst index d5565dca..3a7915d0 100644 --- a/source/reference/minio-server/minio-server.rst +++ b/source/reference/minio-server/minio-server.rst @@ -175,31 +175,31 @@ environment variables during startup to set configuration settings. Root Credentials ~~~~~~~~~~~~~~~~ -.. envvar:: MINIO_ROOT_USER_FILE +.. envvar:: MINIO_ROOT_USER The access key for the :ref:`root ` user. .. warning:: - If :envvar:`MINIO_ROOT_USER_FILE` is unset, + If :envvar:`MINIO_ROOT_USER` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random - :envvar:`MINIO_ROOT_USER_FILE` value for all environments. + :envvar:`MINIO_ROOT_USER` value for all environments. -.. envvar:: MINIO_ROOT_PASSWORD_FILE +.. envvar:: MINIO_ROOT_PASSWORD The access key for the :ref:`root ` user. .. warning:: - If :envvar:`MINIO_ROOT_PASSWORD_FILE` is unset, + If :envvar:`MINIO_ROOT_PASSWORD` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random - :envvar:`MINIO_ROOT_PASSWORD_FILE` value for all environments. + :envvar:`MINIO_ROOT_PASSWORD` value for all environments. .. envvar:: MINIO_ACCESS_KEY @@ -208,7 +208,7 @@ Root Credentials The access key for the :ref:`root ` user. This environment variable is *deprecated* in favor of the - :envvar:`MINIO_ROOT_USER_FILE` environment variable. + :envvar:`MINIO_ROOT_USER` environment variable. .. warning:: @@ -226,7 +226,7 @@ Root Credentials The secret key for the :ref:`root ` user. This environment variable is *deprecated* in favor of the - :envvar:`MINIO_ROOT_PASSWORD_FILE` environment variable. + :envvar:`MINIO_ROOT_PASSWORD` environment variable. .. warning:: @@ -242,7 +242,7 @@ Root Credentials .. deprecated:: RELEASE.2021-04-22T15-44-28Z To perform root credential rotation, modify the - :envvar:`MINIO_ROOT_USER_FILE` and `MINIO_ROOT_PASSWORD_FILE` environment + :envvar:`MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` environment variables. .. envvar:: MINIO_SECRET_KEY_OLD @@ -250,7 +250,7 @@ Root Credentials .. deprecated:: RELEASE.2021-04-22T15-44-28Z To perform root credential rotation, modify the - :envvar:`MINIO_ROOT_USER_FILE` and `MINIO_ROOT_PASSWORD_FILE` environment + :envvar:`MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` environment variables. Key Management Service and Encryption diff --git a/source/security/IAM/iam-users.rst b/source/security/IAM/iam-users.rst index 0ec7491c..c1c65c98 100644 --- a/source/security/IAM/iam-users.rst +++ b/source/security/IAM/iam-users.rst @@ -86,8 +86,8 @@ MinIO deployments have a ``root`` user with access to all actions and resources on the deployment. When a :mc:`minio` server first starts, it sets the ``root`` user credentials by checking the value of the following environment variables: -- :envvar:`MINIO_ROOT_USER_FILE` -- :envvar:`MINIO_ROOT_PASSWORD_FILE` +- :envvar:`MINIO_ROOT_USER` +- :envvar:`MINIO_ROOT_PASSWORD` Rotating the root user credentials requires updating either or both variables for all MinIO servers in the deployment. diff --git a/source/tutorials/minio-installation.rst b/source/tutorials/minio-installation.rst index aa7584ef..d1cfccc2 100644 --- a/source/tutorials/minio-installation.rst +++ b/source/tutorials/minio-installation.rst @@ -71,8 +71,8 @@ procedure. .. code-block:: shell :class: copyable - export MINIO_ROOT_USER_FILE=minio-admin - export MINIO_ROOT_PASSWORD_FILE=minio-secret-key-CHANGE-ME + export MINIO_ROOT_USER=minio-admin + export MINIO_ROOT_PASSWORD=minio-secret-key-CHANGE-ME export MINIO_KMS_SECRET_KEY=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo= minio server https://minio{1...4}.example.com/mnt/disk{1...4}/data @@ -83,12 +83,12 @@ procedure. :widths: 40 60 :width: 100% - * - :envvar:`MINIO_ROOT_USER_FILE` + * - :envvar:`MINIO_ROOT_USER` - The access key for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_ROOT_PASSWORD_FILE` + * - :envvar:`MINIO_ROOT_PASSWORD` - The corresponding secret key to use for the :ref:`root ` user. @@ -171,7 +171,7 @@ version of the ``minio`` server process: docker run -p 9000:9000 \ -e "MINIO_ROOT_USER_FILE=ROOT_ACCESS_KEY" \ -e "MINIO_ROOT_PASSWORD_FILE=SECRET_ACCESS_KEY_CHANGE_ME" \ - -e "MINIO_KMS_SECRET_KEY=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo=" \ + -e "MINIO_KMS_SECRET_KEY_FILE=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo=" \ -v /mnt/disk1:/disk1 \ -v /mnt/disk2:/disk2 \ -v /mnt/disk3:/disk3 \ @@ -184,20 +184,20 @@ The command uses the following options: :widths: 40 60 :width: 100% - * - :envvar:`MINIO_ROOT_USER_FILE` + * - :envvar:`MINIO_ROOT_USER_FILE ` - The access key for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_ROOT_PASSWORD_FILE` + * - :envvar:`MINIO_ROOT_PASSWORD_FILE ` - The corresponding secret key to use for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_KMS_SECRET_KEY` - - The key to use for encrypting the MinIO backend (S3 objects, users, groups, - policies, and server configuration). + * - :envvar:`MINIO_KMS_SECRET_KEY_FILE ` + - The key to use for encrypting the MinIO backend (S3 objects, users, + groups, policies, and server configuration). Use the following format when specifying the encryption key: @@ -232,7 +232,7 @@ bleeding-edge version of the ``minio`` server process: docker run -p 9000:9000 \ -e "MINIO_ROOT_USER_FILE=ROOT_ACCESS_KEY" \ -e "MINIO_ROOT_PASSWORD_FILE=SECRET_ACCESS_KEY_CHANGE_ME" \ - -e "MINIO_KMS_SECRET_KEY=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo=" \ + -e "MINIO_KMS_SECRET_KEY_FILE=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo=" \ -v /mnt/disk1:/disk1 \ -v /mnt/disk2:/disk2 \ -v /mnt/disk3:/disk3 \ @@ -245,20 +245,20 @@ The command uses the following options: :widths: 40 60 :width: 100% - * - :envvar:`MINIO_ROOT_USER_FILE` + * - :envvar:`MINIO_ROOT_USER_FILE ` - The access key for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_ROOT_PASSWORD_FILE` + * - :envvar:`MINIO_ROOT_PASSWORD_FILE ` - The corresponding secret key to use for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_KMS_SECRET_KEY` - - The key to use for encrypting the MinIO backend (users, groups, - policies, and server configuration). + * - :envvar:`MINIO_KMS_SECRET_KEY_FILE ` + - The key to use for encrypting the MinIO backend (S3 objects, users, + groups, policies, and server configuration). Replace this value with a 32-bit base64-encrypted string: @@ -325,8 +325,8 @@ environments. .. code-block:: shell :class: copyable - export MINIO_ROOT_USER_FILE=minio-admin - export MINIO_ROOT_PASSWORD_FILE=minio-secret-key-CHANGE-ME + export MINIO_ROOT_USER=minio-admin + export MINIO_ROOT_PASSWORD=minio-secret-key-CHANGE-ME export MINIO_KMS_SECRET_KEY=my-minio-encryption-key:bXltaW5pb2VuY3J5cHRpb25rZXljaGFuZ2VtZTEyMwo= minio server /mnt/disk{1...4}/data @@ -337,12 +337,12 @@ environments. :widths: 40 60 :width: 100% - * - :envvar:`MINIO_ROOT_USER_FILE` + * - :envvar:`MINIO_ROOT_USER` - The access key for the :ref:`root ` user. Replace this value with a unique, random, and long string. - * - :envvar:`MINIO_ROOT_PASSWORD_FILE` + * - :envvar:`MINIO_ROOT_PASSWORD` - The corresponding secret key to use for the :ref:`root ` user.