diff --git a/source/administration/minio-console.rst b/source/administration/minio-console.rst index eb1b3a2f..0021f092 100644 --- a/source/administration/minio-console.rst +++ b/source/administration/minio-console.rst @@ -233,7 +233,7 @@ Some subsections may not be visible if the authenticated user does not have the :alt: MinIO Console Service Accounts :align: center - The :guilabel:`Accounts` section displays all :ref:`minio-idp-service-account` associated to the authenticated user. + The :guilabel:`Service Accounts` section displays all :ref:`minio-idp-service-account` associated to the authenticated user. Service accounts support providing applications authentication credentials which inherit permissions from the "parent" user. @@ -256,31 +256,32 @@ Some subsections may not be visible if the authenticated user does not have the application, create a new service account and delete the old one once the application updates to using the new credentials. -Access ------- + .. tab-item:: Policies -.. image:: /images/minio-console/console-iam.png - :width: 600px - :alt: MinIO Console Manage IAM Policies - :align: center + The :guilabel:`Policies` section displays all :ref:`policies ` on the MinIO deployment. + The Policies section allows you to create, modify, or delete policies. -The :guilabel:`IAM Policies` section displays all :ref:`policies ` on the MinIO deployment. + :ref:`Policies ` define the authorized actions and resources to which an authenticated user has access. + Each policy describes one or more actions a user, group of users, or service account can perform or conditions they must meet. -This tab or its contents may not be visible if the authenticated user does not have the :ref:`required administrative permissions `. + The policies are JSON formatted text files compatible with Amazon AWS Identity and Access Management policy syntax, structure, and behavior. + Refer to :ref:`Policy Based Action Control ` for details on managing access in MinIO with policies. -- Select :guilabel:`+ Create Policy` to create a new MinIO Policy. + This section or its contents may not be visible if the authenticated user does not have the :ref:`required administrative permissions `. -- Select the policy row to manage the policy details. + - Select :guilabel:`+ Create Policy` to create a new MinIO Policy. - The :guilabel:`Summary` view displays a summary of the policy. + - Select the policy row to manage the policy details. - The :guilabel:`Users` view displays all users assigned to the policy. + The :guilabel:`Summary` view displays a summary of the policy. - The :guilabel:`Groups` view displays all groups assigned to the policy. + The :guilabel:`Users` view displays all users assigned to the policy. - The :guilabel:`Raw Policy` view displays the raw JSON policy. + The :guilabel:`Groups` view displays all groups assigned to the policy. -Use the :guilabel:`Identity: Users` and :guilabel:`Identity: Groups` views to assign a created policy to users and groups, respectively. + The :guilabel:`Raw Policy` view displays the raw JSON policy. + + Use the :guilabel:`Users` and :guilabel:`Groups` views to assign a created policy to users and groups, respectively. Monitoring ---------- @@ -311,6 +312,7 @@ Some subsections may not be visible if the authenticated user does not have the :align: center This view requires configuring a Prometheus service to scrape the deployment metrics. + You can download these metrics as a ``.png`` image or ``.csv`` file. See :ref:`minio-metrics-collect-using-prometheus` for complete instructions. .. tab-item:: Logs @@ -375,6 +377,66 @@ Some subsections may not be visible if the authenticated user does not have the MinIO does not recommend performing manual healing unless explicitly directed by support. +Notifications +------------- + +The :guilabel:`Notifications` section provides an interface to view, add, or remove :ref:`Bucket Notification ` targets. + +You can use this screen configure MinIO to push notification events to the one or more target destinations, including Redis, MySQL, Kafka, PostgreSQL, AMQP, MQTT, Elastic Search, NATS, NSQ, or a Webhook. + +Select the :guilabel:`Add Notification Target +` button to add a new target to the deployment. + +You can select an existing notification target from the list to view its details or delete the target. + +.. image:: /images/minio-console/console-add-notification-target.png + :width: 600px + :alt: The MinIO Console's Notification screen after selecting add new target that shows the types of destination targets users can add. + :align: center + +Tiers +----- + +.. image:: /images/minio-console/console-settings-tiers.png + :width: 600px + :alt: MinIO Console Settings - Tiering + :align: center + +The :guilabel:`Tiers` section provides an interface for adding and managing :ref:`remote tiers ` to support lifecycle management transition rules. + +Select the :guilabel:`Create Tier +` button to add a new tier to the deployment. +Choose to add a MinIO, Google Cloud Storage, AWS S3, or Azure tier type. + +You can select an existing tier from the list to view its details. + +Site Replication +---------------- + +.. image:: /images/minio-console/console-settings-site-replication.png + :width: 600px + :alt: MinIO Console Settings - Site Replication + :align: center + +The :guilabel:`Site Replication` section provides an interface for adding and managing the site replication configuration for the deployment. + +Configuring site replication requires that only a single site have existing buckets or objects (if any). + +Configuration +------------- +This section contains the following subsections. +Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions `. + +.. image:: /images/minio-console/console-settings-configuration.png + :width: 600px + :alt: MinIO Console Settings - Configuration View + :align: center + +The :guilabel:`Configuration` section provides an interface for viewing and retrieving :ref:`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`. +Refer to those commands for details on how to define the many options. + +Some configuration settings may require restarting the MinIO deployment to apply changes. + Support ------- @@ -448,7 +510,6 @@ Some subsections may not be visible if the authenticated user does not have the Independent or third-party use of the output for diagnostics or remediation is done at your own risk. You can optionally encrypt the object such that it can only be read if the generated encryption key is included as part of the debugging toolchain. - License ------- @@ -466,62 +527,7 @@ Applications using MinIO should follow local laws and regulations around licensi Proprietary application stacks can register for either the SUBNET :guilabel:`Standard` or :guilabel:`Enterprise` License and Support plan to use MinIO under a commercial license. -Settings --------- +Documentation +------------- -The :guilabel:`Configuration` section displays information on MinIO server configuration settings. - -This section contains the following subsections. -Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions `. - -.. tab-set:: - - .. tab-item:: Configuration - - .. image:: /images/minio-console/console-settings-configuration.png - :width: 600px - :alt: MinIO Console Settings - Configuration View - :align: center - - The :guilabel:`Configuration` subsection provides an interface for viewing and retrieving :ref:`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` - - Some configuration settings may require restarting the MinIO deployment to apply changes. - - .. tab-item:: Notifications - - .. image:: /images/minio-console/console-settings-notifications.png - :width: 600px - :alt: MinIO Console Settings - Notifications View - :align: center - - The :guilabel:`Notifications` subsection provides an interface for adding and managing :ref:`bucket notification targets `. - - Select the :guilabel:`Add Notification Target +` button to add a new target to the deployment. - - You can select an existing notification target from the list to view its details. - - .. tab-item:: Tiers - - .. image:: /images/minio-console/console-settings-tiers.png - :width: 600px - :alt: MinIO Console Settings - Tiering - :align: center - - The :guilabel:`Tiers` subsection provides an interface for adding and managing :ref:`remote tiers ` to support lifecycle management transition rules. - - Select the :guilabel:`Create Tier +` button to add a new tier to the deployment. - - You can select an existing tier from the list to view its details. - - .. tab-item:: Site Replication - - .. image:: /images/minio-console/console-settings-site-replication.png - :width: 600px - :alt: MinIO Console Settings - Site Replication - :align: center - - The :guilabel:`Site Replication` subsection provides an interface for adding and managing the site replication configuration for the deployment. - - Configuring site replication requires that only a single site have existing buckets or objects (if any). +The :guilabel:`Documentation` tab opens this documentation site in a separate browser window or tab. diff --git a/source/administration/monitoring/publish-events-to-mysql.rst b/source/administration/monitoring/publish-events-to-mysql.rst index 8ed09cdd..2c36517a 100644 --- a/source/administration/monitoring/publish-events-to-mysql.rst +++ b/source/administration/monitoring/publish-events-to-mysql.rst @@ -13,7 +13,7 @@ Publish Events to MySQL :depth: 1 MinIO supports publishing :ref:`bucket notification -` events to a My`MySQL `__ +` events to a `MySQL `__ service endpoint. MinIO supports MySQL 5.7.8 and later *only*. Add a MySQL Endpoint to a MinIO Deployment diff --git a/source/images/minio-console/console-add-notification-target.png b/source/images/minio-console/console-add-notification-target.png new file mode 100644 index 00000000..dfd6a2f1 Binary files /dev/null and b/source/images/minio-console/console-add-notification-target.png differ diff --git a/source/images/minio-console/console-settings-configuration.png b/source/images/minio-console/console-settings-configuration.png index 667b333c..b4bc2d7a 100644 Binary files a/source/images/minio-console/console-settings-configuration.png and b/source/images/minio-console/console-settings-configuration.png differ diff --git a/source/images/minio-console/console-settings-site-replication.png b/source/images/minio-console/console-settings-site-replication.png index 6c831b70..0d3db275 100644 Binary files a/source/images/minio-console/console-settings-site-replication.png and b/source/images/minio-console/console-settings-site-replication.png differ diff --git a/source/images/minio-console/console-settings-tiers.png b/source/images/minio-console/console-settings-tiers.png index 6ed54690..dfd06d46 100644 Binary files a/source/images/minio-console/console-settings-tiers.png and b/source/images/minio-console/console-settings-tiers.png differ diff --git a/source/operations/monitoring.rst b/source/operations/monitoring.rst index 0e210efa..139baf22 100644 --- a/source/operations/monitoring.rst +++ b/source/operations/monitoring.rst @@ -11,26 +11,23 @@ Prometheus Monitoring Metrics and Alerts ------------------ -MinIO leverages `Prometheus `__ for metrics and alerts. -Prometheus is an Open-Source systems and service monitoring system which -supports analyzing and alerting based on collected metrics. The Prometheus -ecosystem includes multiple :prometheus-docs:`integrations -`, allowing wide latitude in processing and storing -collected metrics. +MinIO provides point-in-time metrics on cluster status and operations. +MinIO publishes collected metrics data using Prometheus-compatible data structures. -- MinIO publishes Prometheus-compatible scraping endpoints for cluster and - node-level metrics. See :ref:`minio-metrics-and-alerts-endpoints` for - more information. +For alerts, time-series metric data, or additional metrics, MinIO can leverage `Prometheus `__. +Prometheus is an Open Source systems and service monitoring system which supports analyzing and alerting based on collected metrics. +The Prometheus ecosystem includes multiple :prometheus-docs:`integrations `, allowing wide latitude in processing and storing collected metrics. -- For alerts, use Prometheus :prometheus-docs:`Alerting Rules - ` and the - :prometheus-docs:`Alert Manager ` to - trigger alerts based on collected metrics. See - :ref:`minio-metrics-and-alerts-alerting` for more information. +- MinIO publishes Prometheus-compatible scraping endpoints for cluster and node-level metrics. + Any Prometheus-compatible scraping software can ingest and process MinIO metrics for analysis, visualization, and alerting. + See :ref:`minio-metrics-and-alerts-endpoints` for more information. -MinIO publishes collected metrics data using Prometheus-compatible data -structures. Any Prometheus-compatible scraping software can ingest and -process MinIO metrics for analysis, visualization, and alerting. +- For alerts, use Prometheus :prometheus-docs:`Alerting Rules ` and the + :prometheus-docs:`Alert Manager ` to trigger alerts based on collected metrics. + See :ref:`minio-metrics-and-alerts-alerting` for more information. + +When configured, the :ref:`MinIO Console ` shows some metrics in the :guilabel:`Monitoring > Metrics` page. +You can download these metrics as either ``.png`` images or ``.csv`` files. Logging ------- @@ -38,29 +35,24 @@ Logging MinIO publishes all :mc:`minio server` operations to the system console. MinIO also supports publishing server logs and audit logs to an HTTP webhook. -- :ref:`Server logs ` contain the same - :mc:`minio server` operations logged to the system console. Server logs - support general monitoring and troubleshooting of operations. +- :ref:`Server logs ` contain the same :mc:`minio server` operations logged to the system console. + Server logs support general monitoring and troubleshooting of operations. -- :ref:`Audit logs ` are more granular - descriptions of each operation on the MinIO deployment. Audit logging - supports security standards and regulations which require detailed tracking - of operations. +- :ref:`Audit logs ` are more granular descriptions of each operation on the MinIO deployment. + Audit logging supports security standards and regulations which require detailed tracking of operations. -MinIO publishes logs as a JSON document as a ``PUT`` request to each configured -endpoint. The endpoint server is responsible for processing each JSON document. -MinIO requires explicit configuration of each webhook endpoint and does *not* -publish logs to a webhook by default. +MinIO publishes logs as a JSON document as a ``PUT`` request to each configured endpoint. +The endpoint server is responsible for processing each JSON document. +MinIO requires explicit configuration of each webhook endpoint and does *not* publish logs to a webhook by default. See :ref:`minio-logging` for more complete documentation. Healthchecks ------------ -MinIO exposes unauthenticated endpoints for probing node uptime and -cluster :ref:`high availability ` for simple healthchecks. -These endpoints return only an HTTP status code. See -:ref:`minio-healthcheck-api` for more information. +MinIO exposes unauthenticated endpoints for probing node uptime and cluster :ref:`high availability ` for simple healthchecks. +These endpoints return only an HTTP status code. +See :ref:`minio-healthcheck-api` for more information. .. toctree:: :titlesonly: diff --git a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst index bfa08a97..c68122b3 100644 --- a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst +++ b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst @@ -50,7 +50,7 @@ Procedure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ MinIO by default requires authentication for requests made to the metrics -endpoints. While step is not required for MinIO deployments started with +endpoints. While this step is not required for MinIO deployments started with :envvar:`MINIO_PROMETHEUS_AUTH_TYPE` set to ``"public"``, you can still use the command output for retrieving a Prometheus ``scrape_configs`` entry. @@ -142,42 +142,35 @@ The following query examples return metrics collected by Prometheus: See :ref:`minio-metrics-and-alerts-available-metrics` for a complete list of published metrics. +.. _minio-console-metrics: + 4) Visualize Collected Metrics ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The :minio-git:`MinIO Console ` supports visualizing collected metrics -from Prometheus. Specify the URL of the Prometheus service to the -:envvar:`MINIO_PROMETHEUS_URL` environment variable to each MinIO server -in the deployment: +The :minio-git:`MinIO Console ` supports visualizing collected metrics from Prometheus. +Specify the URL of the Prometheus service to the :envvar:`MINIO_PROMETHEUS_URL` environment variable to each MinIO server in the deployment: .. code-block:: shell :class: copyable export MINIO_PROMETHEUS_URL="https://prometheus.example.net" -If you set a custom ``job_name`` for the Prometheus scraping job, you must also -set :envvar:`MINIO_PROMETHEUS_JOB_ID` to match that job name. +If you set a custom ``job_name`` for the Prometheus scraping job, you must also set :envvar:`MINIO_PROMETHEUS_JOB_ID` to match that job name. -Restart the deployment using :mc-cmd:`mc admin service restart` to apply the -changes. +Restart the deployment using :mc-cmd:`mc admin service restart` to apply the changes. -The MinIO Console uses the metrics collected by the ``minio-job`` scraping -job to populate the Dashboard metrics: +The MinIO Console uses the metrics collected by the ``minio-job`` scraping job to populate the Dashboard metrics available from :guilabel:`Monitoring > Metrics`. +You can download the metrics from the MinIO Console as either a ``.png`` image or a ``.csv`` file. .. image:: /images/minio-console/console-metrics.png :width: 600px :alt: MinIO Console Dashboard displaying Monitoring Data :align: center -MinIO also publishes a `Grafana Dashboard -`_ for visualizing collected -metrics. For more complete documentation on configuring a Prometheus data source -for Grafana, see :prometheus-docs:`Grafana Support for Prometheus -`. +MinIO also publishes a `Grafana Dashboard `_ for visualizing collected metrics. +For more complete documentation on configuring a Prometheus data source for Grafana, see :prometheus-docs:`Grafana Support for Prometheus `. -Prometheus includes a :prometheus-docs:`graphing interface -` for -visualizing collected metrics. +Prometheus includes a :prometheus-docs:`graphing interface ` for visualizing collected metrics. .. _minio-metrics-and-alerts-endpoints: diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index 2e4a0666..eb59a79b 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -49,7 +49,11 @@ Registering Your MinIO Deployment with SUBNET #. Go to your MinIO cluster's URL, then sign in #. Select the :guilabel:`Support` option #. Select :guilabel:`Register` - #. Enter your :guilabel:`Email` address and a unique :guilabel:`Password`, then select :guilabel:`Register` + #. Select the tab with the method to use to register: + + - :guilabel:`Credentials` tab to use your MinIO SUBNET username and password + - :guilabel:`API Key` tab to input an API key you already have or obtain one directly from SUBNET + - :guilabel:`Airgap` tab for a token and instructions to register a deployment that does not have direct connection to the Internet and/or SUBNET .. tab-item:: Console Airgapped