Skip to content

Commit f08b2d6

Browse files
committed
Further removal of legacy console references
1 parent 6090d38 commit f08b2d6

30 files changed

Lines changed: 126 additions & 502 deletions

source/administration/console/managing-objects.rst

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Managing Objects
1111
:local:
1212
:depth: 2
1313

14-
You can use the MinIO Console to perform several of the bucket and object management and interaction functions available in MinIO.
14+
You can use the MinIO Console to perform several of the bucket and object interaction functions available in MinIO.
1515
Depending on the permissions and IAM policies for the authenticated user, you can:
1616

1717
- :ref:`Browse, upload, revert, manage, and interact with objects <minio-console-object-browser>`.
@@ -40,8 +40,6 @@ Example actions the user may be able to perform include:
4040
- Download objects
4141
- Share
4242
- Preview
43-
- Manage legal holds
44-
- Manage retention
4543
- Manage tags
4644
- Inspect
4745
- Display versions
@@ -65,10 +63,6 @@ Buckets
6563
-------
6664

6765
The Console's :guilabel:`Bucket` section displays all buckets to which the authenticated user has :ref:`access <minio-policy>`.
68-
Use this section to create or manage these buckets, depending on your user's access.
69-
70-
Creating Buckets
71-
~~~~~~~~~~~~~~~~
7266

7367
Select :guilabel:`Create Bucket` to create a new bucket on the deployment.
7468
MinIO validates bucket names.
@@ -85,27 +79,3 @@ While creating a bucket, you can enable :ref:`versioning <minio-bucket-versionin
8579

8680
You can configure locking and versioning options only when you create the bucket.
8781
You cannot change these settings for the bucket later.
88-
89-
Managing Buckets
90-
~~~~~~~~~~~~~~~~
91-
92-
Use the :guilabel:`Search` bar to filter for specific buckets.
93-
Select the row for the bucket to display summary information about the bucket.
94-
95-
Form the summary screen, select any of the available tabs to further manage the bucket.
96-
97-
.. note::
98-
99-
Some management features may not be available if the authenticated user does not have the :ref:`required administrative permissions <minio-policy-mc-admin-actions>`.
100-
101-
When managing a bucket, your access settings may allow you to view or change any of the following:
102-
103-
- The :guilabel:`Summary` section displays a summary of the bucket's configuration.
104-
105-
Use this section to view and modify the bucket's access policy, encryption, quota, and tags.
106-
107-
- Configure alerts in the :guilabel:`Events` section to trigger :ref:`notification events <minio-bucket-notifications>` when a user uploads, accesses, or deletes matching objects.
108-
109-
- Review security in the :guilabel:`Access` section by listing the :ref:`policies <minio-policy>` and :ref:`users <minio-users>` with access to that bucket.
110-
111-
- Properly secure unauthenticated access with the :guilabel:`Anonymous` section by managing rules for prefixes that unauthenticated users can use to read or write objects.

source/administration/identity-access-management/ad-ldap-access-management.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,8 @@ Access Keys are long-lived credentials which inherit their privileges from the p
5858
The parent user can further restrict those privileges while creating the access keys.
5959
Use either of the following methods to create a new access key:
6060

61-
- Log into the :ref:`MinIO Console <minio-console>` using the AD/LDAP-managed user credentials.
62-
In the :guilabel:`User` section, select :guilabel:`Access Keys` followed by :guilabel:`Create access keys +`.
63-
64-
- Use the :mc:`mc admin user svcacct add` command to create the access keys. Specify the user Distinguished Name as the username to which to associate the access keys.
61+
Use the :mc:`mc admin user svcacct add` command to create the access keys.
62+
Specify the user Distinguished Name as the username to which to associate the access keys.
6563

6664

6765
Mapping Policies to User DN

source/administration/identity-access-management/minio-identity-management.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ a valid access key (username) and the corresponding secret key (password) of
2020
an existing MinIO user.
2121

2222
Administrators use the :mc:`mc admin user` command to create and manage
23-
MinIO users. The :minio-git:`MinIO Console <console>` provides a graphical
24-
interface for creating users.
23+
MinIO users.
2524

2625
MinIO also supports creating :ref:`access keys
2726
<minio-idp-service-account>`. Access Keys are child identities of an

source/administration/identity-access-management/minio-user-management.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ A MinIO user can generate any number of access keys.
5656
This allows application owners to generate arbitrary access keys for their applications without requiring action from the MinIO administrators.
5757
Since the generated access keys have the same or fewer permissions as the parents, administrators can focus on managing the top-level parent users without micro-managing generated access keys.
5858

59-
You can create access keys using either the :ref:`MinIO Console <minio-console-user-access-keys>` *or* by using the :mc:`mc admin user svcacct add` command.
59+
You can create access keys by using the :mc:`mc admin user svcacct add` command.
6060
Identities created by these methods do not expire until you remove the access key or the parent account.
6161

6262
You can also create :ref:`security token service <minio-security-token-service>` accounts programmatically with the ``AssumeRole`` STS API endpoint.

source/administration/identity-access-management/oidc-access-management.rst

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,6 @@ credentials with a JSON Web Token Claim flow is as follows:
102102

103103
MinIO provides an example Go application :minio-git:`web-identity.go <minio/blob/master/docs/sts/web-identity.go>` that handles the full login flow.
104104

105-
OIDC users can alternatively create :ref:`access keys <minio-idp-service-account>`.
106-
Access Keys are long-lived credentials which inherit their privileges from the parent user.
107-
The parent user can further restrict those privileges while creating the access keys.
108-
To create a new access key, log into the :ref:`MinIO Console <minio-console>` using the OIDC-managed user credentials.
109-
From the :guilabel:`Identity` section of the left navigation, select :guilabel:`Access Keys` followed by the :guilabel:`Create access keys +` button.
110-
111105
Identifying the JWT Claim Value
112106
+++++++++++++++++++++++++++++++
113107

@@ -124,7 +118,7 @@ Defer to the documentation for your preferred OIDC provider for instructions on
124118
Creating Policies to Match Claims
125119
---------------------------------
126120

127-
Use either the MinIO Console *or* the :mc:`mc admin policy` command to create policies that match one or more claim values.
121+
Use the :mc:`mc admin policy` command to create policies that match one or more claim values.
128122

129123
OIDC Policy Variables
130124
---------------------

source/administration/identity-access-management/pluggable-authentication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ The ``"reason"`` field should include the reason for the 403.
108108
Creating Policies to Match Claims
109109
---------------------------------
110110

111-
Use either the :ref:`MinIO Console <minio-console-admin-policies>` *or* the :mc:`mc admin policy` command to create policies that match one or more claim values.
111+
Use the :mc:`mc admin policy` command to create policies that match one or more claim values.

source/administration/minio-console.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,6 @@ Logging In
124124
The MinIO Console displays a login screen for unauthenticated users.
125125
The Console defaults to providing a username and password prompt for a :ref:`MinIO-managed user <minio-internal-idp>`.
126126

127-
For deployments configured with multiple :ref:`identity managers <minio-authentication-and-identity-management>`, you can also log in using credentials generated using a :ref:`Security Token Service (STS) <minio-security-token-service>` API.
128-
129127
.. admonition:: Try out the Console using MinIO's Play testing environment
130128
:class: note
131129

source/administration/monitoring.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ Deployment Metrics
3737

3838
MinIO provides a Prometheus-compatible endpoint for supporting time-series querying of metrics.
3939

40-
MinIO deployments :ref:`configured to enable Prometheus scraping <minio-metrics-and-alerts>` provide a detailed metrics view through the MinIO Console.
41-
4240
Server Logs
4341
-----------
4442

source/administration/object-management/object-retention.rst

Lines changed: 29 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -192,164 +192,70 @@ Create Bucket with Object Locking Enabled
192192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193193

194194
You must enable object locking during bucket creation as per S3 behavior.
195-
You can create a bucket with object locking enabled using the MinIO Console,
196-
the MinIO :mc:`mc` CLI, or using an S3-compatible SDK.
195+
You can create a bucket with object locking enabled using the MinIO :mc:`mc` CLI or using an S3-compatible SDK.
197196

198-
.. tab-set::
197+
Use the :mc:`mc mb` command with the :mc-cmd:`~mc mb --with-lock`
198+
option to create a bucket with object locking enabled:
199199

200-
.. tab-item:: MinIO Console
201-
:sync: console
202-
203-
Select the :guilabel:`Buckets` section of the MinIO Console to access
204-
bucket creation and management functions. Select the bucket row from the
205-
list of buckets. You can use the :octicon:`search` :guilabel:`Search` bar
206-
to filter the list.
207-
208-
.. image:: /images/minio-console/console-bucket.png
209-
:width: 600px
210-
:alt: MinIO Console Bucket Management
211-
:align: center
212-
213-
Click the :guilabel:`Create Bucket` button to open the bucket creation
214-
modal. Toggle the :guilabel:`Object Locking` selector to enable object
215-
locking on the bucket.
216-
217-
.. image:: /images/minio-console/console-bucket-create-bucket-with-locking.png
218-
:width: 600px
219-
:alt: MinIO Console Bucket Management
220-
:align: center
221-
222-
.. tab-item:: MinIO CLI
223-
:sync: cli
224-
225-
Use the :mc:`mc mb` command with the :mc-cmd:`~mc mb --with-lock`
226-
option to create a bucket with object locking enabled:
227-
228-
.. code-block:: shell
229-
:class: copyable
200+
.. code-block:: shell
201+
:class: copyable
230202
231-
mc mb --with-lock ALIAS/BUCKET
203+
mc mb --with-lock ALIAS/BUCKET
232204
233-
- Replace ``ALIAS`` with the :mc:`alias <mc alias>` of a configured
234-
MinIO deployment.
205+
- Replace ``ALIAS`` with the :mc:`alias <mc alias>` of a configured
206+
MinIO deployment.
235207

236-
- Replace ``BUCKET`` with the
237-
:mc-cmd:`name <mc mb ALIAS>` of the bucket to create.
208+
- Replace ``BUCKET`` with the
209+
:mc-cmd:`name <mc mb ALIAS>` of the bucket to create.
238210

239211
Configure Bucket-Default Object Retention
240212
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241213

242-
You can configure object locking rules ("object retention") using the
243-
MinIO Console, the MinIO :mc:`mc` CLI, or using an S3-compatible SDK.
214+
You can configure object locking rules ("object retention") using the MinIO :mc:`mc` CLI, or using an S3-compatible SDK.
244215

245216
MinIO supports setting both bucket-default *and* per-object retention rules.
246217
The following examples set bucket-default retention. For per-object retention
247218
settings, defer to the documentation for the ``PUT`` operation used by your
248219
preferred SDK.
249220

250-
.. tab-set::
251-
252-
.. tab-item:: MinIO Console
253-
:sync: console
254-
255-
Select the :guilabel:`Buckets` section of the MinIO Console to access bucket creation and management functions. You can use the :octicon:`search` :guilabel:`Search` bar to filter the list.
256-
257-
.. image:: /images/minio-console/console-bucket.png
258-
:width: 600px
259-
:alt: MinIO Console Bucket Management
260-
:align: center
261-
262-
Each bucket row has a :guilabel:`Manage` button that opens the management view for that bucket.
263-
264-
.. image:: /images/minio-console/console-bucket-manage.png
265-
:width: 600px
266-
:alt: MinIO Console Bucket Management
267-
:align: center
268-
269-
From the :guilabel:`Retention` section, select :guilabel:`Enabled`.
270-
This section is only visible for buckets created with object locking enabled.
271221

272-
From the :guilabel:`Set Retention Configuration` modal, set the desired bucket default retention settings.
222+
Use the :mc:`mc retention set` command with the
223+
:mc-cmd:`--recursive <mc retention set --recursive>` and
224+
:mc-cmd:`--default <mc retention set --default>` options to set the
225+
default retention mode for a bucket:
273226

274-
- For :guilabel:`Retention Mode`, select either :ref:`COMPLIANCE <minio-object-locking-compliance>` or :ref:`GOVERNANCE <minio-object-locking-governance>`.
275-
276-
- For :guilabel:`Duration`, select the retention duration units of :guilabel:`Days` or :guilabel:`Years`.
277-
278-
- For :guilabel:`Retention Validity`, set the duration of time for which MinIO holds objects under the specified retention mode for the bucket.
279-
280-
.. tab-item:: MinIO CLI
281-
:sync: cli
282-
283-
Use the :mc:`mc retention set` command with the
284-
:mc-cmd:`--recursive <mc retention set --recursive>` and
285-
:mc-cmd:`--default <mc retention set --default>` options to set the
286-
default retention mode for a bucket:
287-
288-
.. code-block:: shell
289-
:class: copyable
227+
.. code-block:: shell
228+
:class: copyable
290229
291-
mc retention set --recursive --default MODE DURATION ALIAS/BUCKET
230+
mc retention set --recursive --default MODE DURATION ALIAS/BUCKET
292231
293-
- Replace :mc-cmd:`MODE <mc retention set MODE>` with either either
294-
:ref:`COMPLIANCE <minio-object-locking-compliance>` or
295-
:ref:`GOVERNANCE <minio-object-locking-governance>`.
232+
- Replace :mc-cmd:`MODE <mc retention set MODE>` with either either :ref:`COMPLIANCE <minio-object-locking-compliance>` or :ref:`GOVERNANCE <minio-object-locking-governance>`.
296233

297-
- Replace :mc-cmd:`DURATION <mc retention set VALIDITY>` with the
298-
duration for which the object lock remains in effect.
234+
- Replace :mc-cmd:`DURATION <mc retention set VALIDITY>` with the duration for which the object lock remains in effect.
299235

300-
- Replace :mc-cmd:`ALIAS <mc retention set ALIAS>` with the
301-
:mc:`alias <mc alias>` of a configured MinIO deployment.
236+
- Replace :mc-cmd:`ALIAS <mc retention set ALIAS>` with the :mc:`alias <mc alias>` of a configured MinIO deployment.
302237

303-
- Replace :mc-cmd:`BUCKET <mc retention set ALIAS>` with the
304-
name of the bucket on which to set the default retention rule.
238+
- Replace :mc-cmd:`BUCKET <mc retention set ALIAS>` with the name of the bucket on which to set the default retention rule.
305239

306240
Enable Legal Hold Retention
307241
~~~~~~~~~~~~~~~~~~~~~~~~~~~
308242

309-
You can enable or disable indefinite legal hold retention for an object using the MinIO Console, the MinIO :mc:`mc` CLI, or using an S3-compatible SDK.
243+
You can enable or disable indefinite legal hold retention for an object using the MinIO :mc:`mc` CLI or using an S3-compatible SDK.
310244

311245
You can place a legal hold on an object already held under a :ref:`COMPLIANCE <minio-object-locking-compliance>` or :ref:`GOVERNANCE <minio-object-locking-governance>` lock.
312246
The object remains WORM locked under the legal hold even when the retention lock expires.
313247
You or another user with the necessary permissions must explicitly lift the legal hold to remove the WORM lock.
314248

315-
.. tab-set::
316-
317-
.. tab-item:: MinIO Console
318-
:sync: console
319-
320-
Select the :guilabel:`Buckets` section of the MinIO Console to access bucket creation and management functions.
321-
You can use the :octicon:`search` :guilabel:`Search` bar to filter the list.
249+
Use the :guilabel:`mc legalhold set` command to toggle the legal hold status on an object.
322250

323-
.. image:: /images/minio-console/console-bucket.png
324-
:width: 600px
325-
:alt: MinIO Console Bucket Management
326-
:align: center
327-
328-
Each bucket row has a :guilabel:`Manage` button that opens the management view for that bucket.
329-
330-
.. image:: /images/minio-console/console-object-browser.png
331-
:width: 600px
332-
:alt: MinIO Console Bucket Object Browser
333-
:align: center
334-
335-
Browse to the object and select it to open the object details view.
336-
Select the :guilabel:`Legal Hold` button to toggle the legal hold status of the object.
337-
338-
.. tab-item:: MinIO CLI
339-
:sync: cli
340-
341-
Use the :guilabel:`mc legalhold set` command to toggle the legal hold status on an object.
342-
343-
.. code-block:: shell
344-
:class: copyable
251+
.. code-block:: shell
252+
:class: copyable
345253
346-
mc legalhold set ALIAS/PATH
254+
mc legalhold set ALIAS/PATH
347255
348-
- Replace :mc-cmd:`ALIAS <mc legalhold set ALIAS>` with the
349-
:mc:`alias <mc alias>` of a configured MinIO deployment.
256+
- Replace :mc-cmd:`ALIAS <mc legalhold set ALIAS>` with the :mc:`alias <mc alias>` of a configured MinIO deployment.
350257

351-
- Replace :mc-cmd:`PATH <mc legalhold set ALIAS>` with the
352-
path to the object for which to enable the legal hold.
258+
- Replace :mc-cmd:`PATH <mc legalhold set ALIAS>` with the path to the object for which to enable the legal hold.
353259

354260
.. _minio-object-locking-retention-modes:
355261

0 commit comments

Comments
 (0)