mirror of
https://github.com/minio/docs.git
synced 2025-07-28 19:42:10 +03:00
DOCS-355: Update quickstart for Embedded Console
This commit is contained in:
ravindk89
committed by
Harshavardhana
Harshavardhana
parent
4fc6df9c92
commit
08a38c2a71
BIN
source/images/minio-console-dashboard.png
Normal file
BIN
source/images/minio-console-dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 188 KiB |
@ -95,53 +95,48 @@ such as versioning and replication.
|
||||
|
||||
cat /dev/urandom | head -c 32 | base64 -
|
||||
|
||||
MinIO by default listens on port ``9000``. Applications running on the
|
||||
same host can connect and perform S3 operations on the MinIO server
|
||||
using the ``http://localhost:9000`` url.
|
||||
The output resembles the following:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
API: http://127.0.0.1:9000
|
||||
RootUser: minioadmin
|
||||
RootPass: minioadmin
|
||||
Region: us-east-1
|
||||
Console: http://127.0.0.1:64518
|
||||
RootUser: minioadmin
|
||||
RootPass: minioadmin
|
||||
Command-line: https://docs.min.io/docs/minio-client-quickstart-guide
|
||||
$ mc alias set myminio http://127.0.0.1:9000 minioadmin minioadmin
|
||||
Documentation: https://docs.min.io
|
||||
|
||||
Applications should use one of the addresses listed in the :guilabel:`API`
|
||||
key for connecting to and performing operations on the MinIO Tenant.
|
||||
For early development and application, applications can authenticate
|
||||
using the :guilabel:`RootUser` and :guilabel:`RootPass` credentials.
|
||||
For long-term development and production, create dedicated users.
|
||||
See :doc:`/security/security-overview` for more information.
|
||||
|
||||
You can also use the :mc:`mc` commandline tool to perform operations on the
|
||||
MinIO server. Use :mc:`mc alias set` to update the ``myminio`` alias with
|
||||
the access key and secret key set on the MinIO server.
|
||||
|
||||
3\) Configure Console User for MinIO
|
||||
Create a a :ref:`policy <minio-policy>` and :ref:`user <minio-users>` for
|
||||
supporting the :minio-git:`MinIO Console <console>`. The Console provides a
|
||||
rich graphical user interface for interacting with the MinIO server.
|
||||
|
||||
The following command downloads the JSON policy file, creates the appropriate
|
||||
policy, and assigns that policy to a user:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
wget -O - https://docs.min.io/minio/baremetal/examples/ConsoleAdmin.json | \
|
||||
mc admin policy add myminio ConsoleAdminPolicy /dev/stdin
|
||||
mc admin user add myminio consoleAdmin LongRandomSecretKey
|
||||
mc admin policy set Alpha ConsoleAdminPolicy user=consoleAdmin
|
||||
|
||||
4\) Install and run the MinIO Console
|
||||
Download the :minio-git:`Latest Stable <console/releases/latest>` version
|
||||
of MinIO Console for the host operating system.
|
||||
3\) Open MinIO Console
|
||||
|
||||
Set the ``CONSOLE_MINIO_SERVER`` environment variable with the
|
||||
URL of the MinIO server:
|
||||
Open your browser and http://127.0.0.1:9000 to open the MinIO Console
|
||||
login page.
|
||||
|
||||
Log in with the :guilabel:`Root User` and :guilabel:`Root Pass` from the
|
||||
previous step.
|
||||
|
||||
.. image:: /images/minio-console-dashboard.png
|
||||
:width: 600px
|
||||
:alt: MinIO Console Dashboard displaying Monitoring Data
|
||||
:align: center
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
export CONSOLE_MINIO_SERVER=http://localhost:9000
|
||||
|
||||
Run the Console:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
./console server
|
||||
|
||||
5\) Open the MinIO Console
|
||||
Open your browser and navigate to ``http://localhost:9090`` to access the
|
||||
MinIO Console. Log in with the ``consoleAdmin`` access key and secret key to
|
||||
begin interacting with the MinIO Tenant.
|
||||
You can use the MinIO Console for general administration tasks like
|
||||
Identity and Access Management, Metrics and Log Monitoring, or
|
||||
Server Configuration.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
@ -171,14 +171,25 @@ Prometheus includes a
|
||||
visualizing collected metrics.
|
||||
|
||||
The :minio-git:`MinIO Console <console>` supports visualizing collected metrics
|
||||
from Prometheus. Specify the following environment variables prior to starting
|
||||
the Console server:
|
||||
from Prometheus. Specify the URL of the Prometheus service to the
|
||||
:envvar:`MINIO_PROMETHEUS_URL` environment variable to each MinIO server
|
||||
in the deployment:
|
||||
|
||||
- ``CONSOLE_PROMETHEUS_URL=https://prometheus.example.net`` - replace the
|
||||
hostname with the URL for the Prometheus server.
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
- ``CONSOLE_PROMETHEUS_JOB_ID=minio-job`` - replace the example job ID with the
|
||||
name of the ``scrape_configs.job_name`` for the MinIO cluster.
|
||||
set MINIO_PROMETHEUS_URL="https://prometheus.example.net"
|
||||
|
||||
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:
|
||||
|
||||
.. image:: /images/minio-console-dashboard.png
|
||||
:width: 600px
|
||||
:alt: MinIO Console Dashboard displaying Monitoring Data
|
||||
:align: center
|
||||
|
||||
MinIO also publishes a `Grafana Dashboard
|
||||
<https://grafana.com/grafana/dashboards/13502>`_ for visualizing collected
|
||||
|
||||
@ -135,6 +135,16 @@ The command accepts the following arguments:
|
||||
If omitted, :mc:`minio <minio server>` binds to port ``9000`` on all
|
||||
configured IP addresses or hostnames on the host machine.
|
||||
|
||||
.. mc-cmd:: console-address
|
||||
:option:
|
||||
|
||||
*Optional*
|
||||
|
||||
Specifies a static port for the embedded MinIO Console.
|
||||
|
||||
Omit to direct MinIO to generate a dynamic port at server startup. The
|
||||
MinIO server outputs the port to the system log.
|
||||
|
||||
.. mc-cmd:: certs-dir, -S
|
||||
:option:
|
||||
|
||||
@ -253,6 +263,45 @@ Root Credentials
|
||||
:envvar:`MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` environment
|
||||
variables.
|
||||
|
||||
MinIO Console
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
The following environment variables control behavior for the embedded
|
||||
MinIO Console:
|
||||
|
||||
.. envvar:: MINIO_PROMETHEUS_URL
|
||||
|
||||
*Optional*
|
||||
|
||||
Specify the URL for a Prometheus service configured to
|
||||
:ref:`scrape MinIO metrics <minio-metrics-collect-using-prometheus>`.
|
||||
|
||||
The MinIO Console populates the :guilabel:`Dashboard` with cluster metrics
|
||||
using the ``minio-job`` Prometheus scraping job.
|
||||
|
||||
.. envvar:: MINIO_LOG_QUERY_URL
|
||||
|
||||
*Optional*
|
||||
|
||||
Specify the URL of a PostgreSQL service to which MinIO writes
|
||||
:ref:`Audit logs <minio-logging-publish-audit-logs>`. The embedded
|
||||
MinIO Console provides a Log Search tool that allows querying the
|
||||
PostgreSQL service for collected logs.
|
||||
|
||||
.. envvar:: MINIO_BROWSER
|
||||
|
||||
*Optional*
|
||||
|
||||
Specify ``off`` to disable the embedded MinIO Console.
|
||||
|
||||
.. envvar:: MINIO_BROWSER_REDIRECT
|
||||
|
||||
*Optional*
|
||||
|
||||
Specify ``false`` to direct MinIO to prevent redirecting browsers accessing
|
||||
the ``localhost:9000`` URL to the MinIO Console. MinIO instead throws an
|
||||
XML access error.
|
||||
|
||||
Key Management Service and Encryption
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
Reference in New Issue
Block a user