Skip to content

Commit 79cf400

Browse files
djwfyidjwfyi
authored
Updates for the 2024-09-09 releases of the server and mc (#1331)
- adds new config options for webhook events - adds new subcommands to mc idp ldap accesskey - adds info about new output during iam import Closes #1316
1 parent 9171ccc commit 79cf400

File tree

6 files changed

+445
-6
lines changed

6 files changed

+445
-6
lines changed

‎source/reference/minio-mc-admin/mc-admin-cluster-iam-import.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ The :mc:`mc admin cluster iam import` command imports :ref:`IAM <minio-authentic
2121
2222
You can use this command to manually restore IAM metadata settings for a MinIO deployment.
2323

24+
.. versionadded:: mc RELEASE.2024-09-09T07-53-10Z
25+
26+
The command outputs the results of the import, including the following:
27+
28+
- count of individual entities imported by entity type
29+
30+
- list of policies imported by entity type they imported to
31+
32+
- list of entities that failed to import
33+
2434
.. tab-set::
2535

2636
.. tab-item:: EXAMPLE

‎source/reference/minio-mc/mc-idp-ldap-accesskey-disable.rst

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
.. _minio-mc-idp-ldap-accesskey-disable:
2+
3+
=================================
4+
``mc idp ldap accesskey disable``
5+
=================================
6+
7+
.. default-domain:: minio
8+
9+
.. contents:: Table of Contents
10+
:local:
11+
:depth: 2
12+
13+
14+
.. mc:: mc idp ldap accesskey disable
15+
16+
17+
Description
18+
-----------
19+
20+
.. start-mc-idp-ldap-accesskey-disable-desc
21+
22+
:mc:`mc idp ldap accesskey disable` disables the specified :ref:`access key <minio-id-access-keys>` on the MinIO deployment.
23+
24+
.. end-mc-idp-ldap-accesskey-disable-desc
25+
26+
.. tab-set::
27+
28+
.. tab-item:: EXAMPLE
29+
30+
The following example disables the access key ``mykey`` on the ``minio`` deployment:
31+
32+
.. code-block:: shell
33+
:class: copyable
34+
35+
mc idp ldap accesskey disable minio mykey
36+
37+
.. tab-item:: SYNTAX
38+
39+
The command has the following syntax:
40+
41+
.. code-block:: shell
42+
:class: copyable
43+
44+
mc [GLOBALFLAGS] idp ldap accesskey disable \
45+
ALIAS \
46+
KEY
47+
48+
49+
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment configured for AD/LDAP integration.
50+
- Replace ``KEY`` with the access key to disable.
51+
52+
.. include:: /includes/common-minio-mc.rst
53+
:start-after: start-minio-syntax
54+
:end-before: end-minio-syntax
55+
56+
57+
Parameters
58+
~~~~~~~~~~
59+
60+
.. mc-cmd:: ALIAS
61+
:required:
62+
63+
The :ref:`alias <alias>` of the MinIO deployment configured for AD/LDAP.
64+
65+
For example:
66+
67+
.. code-block:: none
68+
69+
mc idp ldap accesskey disable minio
70+
71+
.. mc-cmd:: KEY
72+
:required:
73+
74+
The configured access key to disable.
75+
76+
Example
77+
~~~~~~~
78+
79+
Disable the access key ``mykey`` from the ``minio`` deployment.
80+
81+
.. code-block:: shell
82+
:class: copyable
83+
84+
mc idp ldap accesskey disable minio/ mykey
85+
86+
Global Flags
87+
~~~~~~~~~~~~
88+
89+
.. include:: /includes/common-minio-mc.rst
90+
:start-after: start-minio-mc-globals
91+
:end-before: end-minio-mc-globals
92+
93+
94+
Behavior
95+
--------
96+
97+
S3 Compatibility
98+
~~~~~~~~~~~~~~~~
99+
100+
.. include:: /includes/common-minio-mc.rst
101+
:start-after: start-minio-mc-s3-compatibility
102+
:end-before: end-minio-mc-s3-compatibility

‎source/reference/minio-mc/mc-idp-ldap-accesskey-edit.rst

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
.. _minio-mc-idp-ldap-accesskey-edit:
2+
3+
==============================
4+
``mc idp ldap accesskey edit``
5+
==============================
6+
7+
.. default-domain:: minio
8+
9+
.. contents:: Table of Contents
10+
:local:
11+
:depth: 2
12+
13+
14+
.. mc:: mc idp ldap accesskey edit
15+
16+
17+
Description
18+
-----------
19+
20+
.. start-mc-idp-ldap-accesskey-edit-desc
21+
22+
:mc:`mc idp ldap accesskey edit` modifies the specified :ref:`access key <minio-id-access-keys>` on the local server.
23+
24+
.. end-mc-idp-ldap-accesskey-rm-desc
25+
26+
.. tab-set::
27+
28+
.. tab-item:: EXAMPLE
29+
30+
The following example modifies the secret for the access key ``mykey`` on the ``minio`` deployment:
31+
32+
.. code-block:: shell
33+
:class: copyable
34+
35+
mc idp ldap accesskey edit myminio/ mykey --secret-key 'xxxxxxx'
36+
37+
.. tab-item:: SYNTAX
38+
39+
The command has the following syntax:
40+
41+
.. code-block:: shell
42+
:class: copyable
43+
44+
mc [GLOBALFLAGS] idp ldap accesskey rm \
45+
ALIAS \
46+
KEY \
47+
[--secret-key <string>] \
48+
[--policy <string>] \
49+
[--name <string>] \
50+
[--description <string>] \
51+
[--expiry-duration <string>] \
52+
[--expiry <string>]
53+
54+
55+
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment configured for AD/LDAP integration.
56+
- Replace ``KEY`` with the access key to delete.
57+
58+
.. include:: /includes/common-minio-mc.rst
59+
:start-after: start-minio-syntax
60+
:end-before: end-minio-syntax
61+
62+
63+
Parameters
64+
~~~~~~~~~~
65+
66+
.. mc-cmd:: ALIAS
67+
:required:
68+
69+
The :ref:`alias <alias>` of the MinIO deployment configured for AD/LDAP.
70+
71+
For example:
72+
73+
.. code-block:: none
74+
75+
mc idp ldap accesskey ls minio
76+
77+
.. mc-cmd:: KEY
78+
:required:
79+
80+
The configured access key to delete.
81+
82+
.. mc-cmd:: --description
83+
:optional:
84+
85+
Add a description for the service account.
86+
For example, you might specify the reason the access key exists.
87+
88+
.. mc-cmd:: --expiry
89+
:optional:
90+
91+
The date after which the access key expires.
92+
Enter the date in YYYY-MM-DD format.
93+
94+
For example, to expire the credentials after December 31, 2024, enter ``2024-12-31``.
95+
96+
Mutually exclusive with :mc-cmd:`~mc idp ldap accesskey edit --expiry-duration`.
97+
98+
.. mc-cmd:: --expiry-duration
99+
:optional:
100+
101+
Length of time the access key pair should remain valid for use in ``#d#h#s`` format.
102+
103+
For example, ``7d``, ``24h``, ``5d12h30s`` are valid strings.
104+
105+
Mutually exclusive with :mc-cmd:`~mc idp ldap accesskey edit --expiry`.
106+
107+
.. mc-cmd:: --name
108+
:optional:
109+
110+
A human-readable name to use for the account.
111+
112+
.. mc-cmd:: --policy
113+
:optional:
114+
115+
File path to the JSON-formatted policy to use for the account.
116+
117+
If not specified, the account uses the same policy as the authenticated user.
118+
119+
.. mc-cmd:: --secret-key
120+
:optional:
121+
122+
A secret to use for the account.
123+
124+
125+
Example
126+
~~~~~~~
127+
128+
Modify a secret for an access key
129+
+++++++++++++++++++++++++++++++++
130+
131+
Modify the secret for the access key ``mykey`` on the ``minio`` deployment.
132+
133+
.. code-block:: shell
134+
:class: copyable
135+
136+
mc idp ldap accesskey edit myminio/ mykey --secret-key 'xxxxxxx'
137+
138+
Modify the expiration duration for an accesskey
139+
+++++++++++++++++++++++++++++++++++++++++++++++
140+
141+
Modify the expiration duration for the access key ``mykey`` on the ``minio`` deployment.
142+
143+
.. code-block:: shell
144+
:class: copyable
145+
146+
mc idp ldap accesskey edit myminio/ mykey ---expiry-duration 24h
147+
148+
149+
Global Flags
150+
~~~~~~~~~~~~
151+
152+
.. include:: /includes/common-minio-mc.rst
153+
:start-after: start-minio-mc-globals
154+
:end-before: end-minio-mc-globals
155+
156+
157+
Behavior
158+
--------
159+
160+
S3 Compatibility
161+
~~~~~~~~~~~~~~~~
162+
163+
.. include:: /includes/common-minio-mc.rst
164+
:start-after: start-minio-mc-s3-compatibility
165+
:end-before: end-minio-mc-s3-compatibility

‎source/reference/minio-mc/mc-idp-ldap-accesskey-enable.rst

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
.. _minio-mc-idp-ldap-accesskey-enable:
2+
3+
================================
4+
``mc idp ldap accesskey enable``
5+
================================
6+
7+
.. default-domain:: minio
8+
9+
.. contents:: Table of Contents
10+
:local:
11+
:depth: 2
12+
13+
14+
.. mc:: mc idp ldap accesskey enable
15+
16+
17+
Description
18+
-----------
19+
20+
.. start-mc-idp-ldap-accesskey-enable-desc
21+
22+
The :mc:`mc idp ldap accesskey enable` enables the specified :ref:`access key <minio-id-access-keys>` on the local server.
23+
24+
.. end-mc-idp-ldap-accesskey-enable-desc
25+
26+
.. tab-set::
27+
28+
.. tab-item:: EXAMPLE
29+
30+
The following example enables the access key ``mykey`` from the ``minio`` deployment:
31+
32+
.. code-block:: shell
33+
:class: copyable
34+
35+
mc idp ldap accesskey enable minio/ mykey
36+
37+
.. tab-item:: SYNTAX
38+
39+
The command has the following syntax:
40+
41+
.. code-block:: shell
42+
:class: copyable
43+
44+
mc [GLOBALFLAGS] idp ldap accesskey enable \
45+
ALIAS \
46+
KEY
47+
48+
49+
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment configured for AD/LDAP integration.
50+
- Replace ``KEY`` with the access key to enable.
51+
52+
.. include:: /includes/common-minio-mc.rst
53+
:start-after: start-minio-syntax
54+
:end-before: end-minio-syntax
55+
56+
57+
Parameters
58+
~~~~~~~~~~
59+
60+
.. mc-cmd:: ALIAS
61+
:required:
62+
63+
The :ref:`alias <alias>` of the MinIO deployment configured for AD/LDAP.
64+
65+
For example:
66+
67+
.. code-block:: none
68+
69+
mc idp ldap accesskey enable minio mykey
70+
71+
.. mc-cmd:: KEY
72+
:required:
73+
74+
The configured access key to enable.
75+
76+
Example
77+
~~~~~~~
78+
79+
Enable the access key ``mykey`` from the ``minio`` deployment.
80+
81+
.. code-block:: shell
82+
:class: copyable
83+
84+
mc idp ldap accesskey enable minio/ mykey
85+
86+
Global Flags
87+
~~~~~~~~~~~~
88+
89+
.. include:: /includes/common-minio-mc.rst
90+
:start-after: start-minio-mc-globals
91+
:end-before: end-minio-mc-globals
92+
93+
94+
Behavior
95+
--------
96+
97+
S3 Compatibility
98+
~~~~~~~~~~~~~~~~
99+
100+
.. include:: /includes/common-minio-mc.rst
101+
:start-after: start-minio-mc-s3-compatibility
102+
:end-before: end-minio-mc-s3-compatibility

0 commit comments

Comments
 (0)