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

Updates for Console release v0.20.1 (#654)

- Adds info on multiple IDPs and logging in to the MinIO Console
- Updates Configuration section of MinIO Console to Settings
- Adds info about validation check when creating a bucket
- Adds info about adding certificates when creating a tenant in the
operator

Closes #545
This commit is contained in:
Daryl White
2022-12-02 14:07:36 -06:00
committed by GitHub
parent f4c2da51c2
commit 146cc8afa5
4 changed files with 38 additions and 23 deletions

View File

@ -11,34 +11,40 @@ MinIO Console
:depth: 2 :depth: 2
The MinIO Console is a rich graphical user interface that provides similar The MinIO Console is a rich graphical user interface that provides similar functionality to the :mc:`mc` command line tool.
functionality to the :mc:`mc` command line tool.
.. image:: /images/minio-console/minio-console.png .. image:: /images/minio-console/minio-console.png
:width: 600px :width: 600px
:alt: MinIO Console Landing Page provides a view of Buckets on the deployment :alt: MinIO Console Landing Page provides a view of Buckets on the deployment
:align: center :align: center
You can use the MinIO Console for administration tasks like Identity and You can use the MinIO Console for administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Access Management, Metrics and Log Monitoring, or Server Configuration.
The MinIO Console is embedded as part of the MinIO Server binary starting The MinIO Console is embedded as part of the MinIO Server.
with :minio-release:`RELEASE.2021-07-08T01-15-01Z`. You can also deploy a You can also deploy a standalone MinIO Console using the instructions in the :minio-git:`github repository <console>`.
standalone MinIO Console using the instructions in the
:minio-git:`github repository <console>`.
You can explore the Console using https://play.min.io:9443. Log in with Logging into the MinIO Console depends on how you configured identity management for the deployment.
the following credentials:
- When using the built-in MinIO identity management solution, the sign-in screen displays a standard login screen.
Enter your Username and Password to log in to the MinIO Console.
- If loggin in with a third party application and :ref:`MinIO's Security Token Service (STS) <minio-security-token-service>`, select :guilabel:`Use STS` and enter the Username, Secret, and Token.
- If the deployment uses a single OpenID or Active Directory/LDAP identity provider solution, select the provider's button to proceed to the login screen.
- If the deployment has multiple OpenID and/or Active Directory/LDAP identify management providers configured, the MinIO Console's sign-in screen provides a dropdown list of providers.
Select the provider you wish to use to log in to the MinIO Console, then enter the credentials.
.. admonition:: Try out the Console using MinIO's Play testing environment
:class: note
You can explore the Console using https://play.min.io:9443.
Log in with the following credentials:
- Username: ``Q3AM3UQ867SPQQA43P2F`` - Username: ``Q3AM3UQ867SPQQA43P2F``
- Password: ``zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG`` - Password: ``zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG``
The Play Console connects to the MinIO Play deployment at https://play.min.io. The Play Console connects to the MinIO Play deployment at https://play.min.io.
You can also access this deployment using :mc:`mc` and using the ``play`` You can also access this deployment using :mc:`mc` and using the ``play`` alias.
alias.
This page documents the high level configuration settings and features of the This page documents the high level configuration settings and features of the MinIO Console.
MinIO Console.
Configuration Configuration
------------- -------------
@ -147,6 +153,11 @@ Use the :guilabel:`Search` bar to search for specific buckets or objects.
Select the row for the bucket or object to browse. Select the row for the bucket or object to browse.
Select :guilabel:`Create Bucket` to create a new bucket on the deployment. Select :guilabel:`Create Bucket` to create a new bucket on the deployment.
MinIO validates bucket names.
To see the rules for bucket names, select :guilabel:`View Bucket Naming Rules`.
While creating a bucket, you can enable :ref:`versioning <minio-bucket-versioning>`, :ref:`object locking <minio-object-locking>`, bucket size (quota) limits, and :ref:`retention rules <minio-object-locking-retention-modes>` (which require versioning).
MinIO recommends no more than 500,000 buckets per deployment. MinIO recommends no more than 500,000 buckets per deployment.
Each bucket has :guilabel:`Manage` and :guilabel:`Browse` buttons. Each bucket has :guilabel:`Manage` and :guilabel:`Browse` buttons.
@ -433,8 +444,8 @@ The :guilabel:`Site Replication` section provides an interface for adding and ma
Configuring site replication requires that only a single site have existing buckets or objects (if any). Configuring site replication requires that only a single site have existing buckets or objects (if any).
Configuration Settings
------------- --------
This section contains the following subsections. This section contains the following subsections.
Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions <minio-policy-mc-admin-actions>`. Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions <minio-policy-mc-admin-actions>`.
@ -443,7 +454,7 @@ Some subsections may not be visible if the authenticated user does not have the
:alt: MinIO Console Settings - Configuration View :alt: MinIO Console Settings - Configuration View
:align: center :align: center
The :guilabel:`Configuration` section provides an interface for viewing and retrieving :ref:`configuration settings <minio-server-configuration-settings>` for all MinIO Servers in the deployment. The :guilabel:`Settings` section provides an interface for viewing and retrieving :ref:`configuration settings <minio-server-configuration-settings>` for all MinIO Servers in the deployment.
The interface functionality mimics that of using :mc-cmd:`mc admin config get` or :mc-cmd:`mc admin config set`. The interface functionality mimics that of using :mc-cmd:`mc admin config get` or :mc-cmd:`mc admin config set`.
Refer to those commands for details on how to define the many options. Refer to those commands for details on how to define the many options.

View File

@ -443,15 +443,15 @@ The :guilabel:`Security` section displays TLS certificate settings for the MinIO
The MinIO Tenant uses the generated certificates for enabling and establishing TLS connections. The MinIO Tenant uses the generated certificates for enabling and establishing TLS connections.
* - :guilabel:`Custom Certificates` * - :guilabel:`Custom Certificates`
- Specify one or more custom TLS certificates for use by the MinIO Tenant. - When enabled, you can upload custom TLS certificates for MinIO to use for server and client credentials.
MinIO supports Server Name Indication (SNI) such that the Tenant can select the appropriate TLS certificate based on the request hostname and the certificate Subject Alternative Name. MinIO supports Server Name Indication (SNI) such that the Tenant can select the appropriate TLS certificate based on the request hostname and the certificate Subject Alternative Name.
MinIO also supports specifying Certificate Authority certificates for validating client certificates minted by that CA. MinIO also supports uploading Certificate Authority certificates for validating client certificates minted by that CA.
.. _create-tenant-encryption-section: .. _create-tenant-encryption-section:
8) The :guilabel:`Encryption` Section 1) The :guilabel:`Encryption` Section
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :guilabel:`Encryption` section displays the :ref:`Server-Side Encryption (SSE) <minio-sse>` settings for the MinIO Tenant. The :guilabel:`Encryption` section displays the :ref:`Server-Side Encryption (SSE) <minio-sse>` settings for the MinIO Tenant.

View File

@ -73,6 +73,8 @@ Syntax
Create a new set of configurations for an AD/LDAP provider. Create a new set of configurations for an AD/LDAP provider.
You can run the command multiple times to set up multiple Active Directory or LDAP providers.
.. tab-set:: .. tab-set::
.. tab-item:: EXAMPLE .. tab-item:: EXAMPLE

View File

@ -69,6 +69,8 @@ Syntax
Create a new set of configurations for an OpenID provider. Create a new set of configurations for an OpenID provider.
You can run the command multiple times to set up multiple OpenID providers.
.. tab-set:: .. tab-set::
.. tab-item:: EXAMPLE .. tab-item:: EXAMPLE