minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

svcacct doc updates from RELEASE.2023-05-18T16-59-00Z (#868)

Browse Source 
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>
This commit is contained in:
Andrea Longo
2023-06-02 14:00:08 -06:00
committed by GitHub
parent 4345552d7f
commit 626e4e4f32
2 changed files with 40 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
source/reference/minio-mc-admin/mc-admin-user-svcacct-add.rst
View File

@ -84,18 +84,38 @@ Parameters
.. mc-cmd:: --access-key .. mc-cmd:: --access-key
:optional: :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. Access Key names *must* be unique across all users.
.. mc-cmd:: --comment .. mc-cmd:: --comment
:optional: :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. 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 .. mc-cmd:: --policy
:optional: :optional:
@ -105,7 +125,8 @@ Parameters
.. mc-cmd:: --secret-key .. mc-cmd:: --secret-key
:optional: :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 Global Flags

15
source/reference/minio-mc-admin/mc-admin-user-svcacct-edit.rst
View File

@ -67,6 +67,21 @@ Parameters
The service account to modify. 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 .. mc-cmd:: --policy
:optional: :optional: