From 626e4e4f328f9e678e7f48bdccdc265177dba0d4 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Fri, 2 Jun 2023 14:00:08 -0600 Subject: [PATCH] svcacct doc updates from RELEASE.2023-05-18T16-59-00Z (#868) Doc updates for `mc admin user svcacct add` and `edit`. * `--comment` replaced with `--user` and `--description` for `add` and `edit`. * Add detail on length of autogenerated keys. Autogeneration was already documented, the included change is a bug fix. Partly addresses https://github.com/minio/docs/issues/859 --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com> --- .../mc-admin-user-svcacct-add.rst | 29 ++++++++++++++++--- .../mc-admin-user-svcacct-edit.rst | 15 ++++++++++ 2 files changed, 40 insertions(+), 4 deletions(-) diff --git a/source/reference/minio-mc-admin/mc-admin-user-svcacct-add.rst b/source/reference/minio-mc-admin/mc-admin-user-svcacct-add.rst index fc834d70..580a5ab1 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-svcacct-add.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-svcacct-add.rst @@ -84,18 +84,38 @@ Parameters .. mc-cmd:: --access-key :optional: - A string to use as the access key for this account. Omit to let MinIO autogenerate a random value. + A string to use as the access key for this account. + Omit to let MinIO autogenerate a random 20 character value. Access Key names *must* be unique across all users. .. mc-cmd:: --comment :optional: - .. versionadded:: RELEASE.2023-01-28T20-29-38Z + .. versionchanged:: RELEASE.2023-05-18T16-59-00Z + Replaced by :mc-cmd:`~mc admin user svcacct add --description` and :mc-cmd:`~mc admin user svcacct add --name`. + + Originally added in version RELEASE.2023-01-28T20-29-38Z. - Add a note to the service account. + + This option has been removed. + Use ``--description`` or ``--name`` instead. + +.. mc-cmd:: --description + :optional: + + .. versionadded:: RELEASE.2023-05-18T16-59-00Z + + Add a description for the service account. For example, you might specify the reason the service account exists. +.. mc-cmd:: --name + :optional: + + .. versionadded:: RELEASE.2023-05-18T16-59-00Z + + Add a human-readable name for the service account. + .. mc-cmd:: --policy :optional: @@ -105,7 +125,8 @@ Parameters .. mc-cmd:: --secret-key :optional: - The secret key to associate with the new account. Omit to let MinIO autogenerate a random value. + The secret key to associate with the new account. + Omit to let MinIO autogenerate a random 40-character value. Global Flags diff --git a/source/reference/minio-mc-admin/mc-admin-user-svcacct-edit.rst b/source/reference/minio-mc-admin/mc-admin-user-svcacct-edit.rst index 373f5055..5bca1b6c 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-svcacct-edit.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-svcacct-edit.rst @@ -67,6 +67,21 @@ Parameters The service account to modify. +.. mc-cmd:: --description + :optional: + + .. versionadded:: RELEASE.2023-05-18T16-59-00Z + + Add a description for the service account. + For example, you might specify the reason the service account exists. + +.. mc-cmd:: --name + :optional: + + .. versionadded:: RELEASE.2023-05-18T16-59-00Z + + Add a human-readable name for the service account. + .. mc-cmd:: --policy :optional: