Skip to content

Commit

Permalink
Remove references to various ex MinIO Console features (#1373)
Browse files Browse the repository at this point in the history
UI for the following has been removed from MinIO Console:

- Lifecycle and tiering
- Site replication
- SUBNET

Waiting for merge of minio/console#3472

Staged:

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/minio-console.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/bucket-replication.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/operations/install-deploy-manage/multi-site-replication.html#id4


fixes #1372

---------

Co-authored-by: Jennifer Rondeau <Bradamant3@users.noreply.github.com>
feorlen and Bradamant3 authored Nov 26, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 53e1498 commit 48feb40
Showing 10 changed files with 151 additions and 707 deletions.
Original file line number Diff line number Diff line change
@@ -48,9 +48,9 @@ Access to All Clusters

You must have network access and log in credentials with correct permissions to all deployments to set up multi-site active-active bucket replication.

You can access the deployments by logging in to the :ref:`MinIO Console <minio-console>` for each deployment or by installing :mc:`mc` and using the command line.
You can access the deployments by installing :mc:`mc` and using the command line.
Use the :mc:`mc alias set` command to create an alias for each MinIO deployment.

If using the command line, use the :mc:`mc alias set` command to create an alias for each MinIO deployment.
Alias creation requires specifying an access key for a user on the deployment.
This user **must** have permission to create and manage users and policies on the deployment.

@@ -110,44 +110,11 @@ Procedure

This procedure requires repeating steps for each MinIO deployment participating in the multi-site replication configuration. Depending on the number of deployments, this procedure may require significant time and care in implementation. MinIO recommends reading through the procedure *before* attempting to implement the documented steps.

- :ref:`Configure Multi-Site Bucket Replication Using the MinIO Console <minio-bucket-replication-multi-site-minio-console-procedure>`
- :ref:`Create the Replication Rules <minio-bucket-replication-multi-site-minio-console-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-multi-site-minio-console-validate-replication-config>`
- :ref:`Configure Multi-Site Bucket Replication Using the Command Line <minio-bucket-replication-multi-site-minio-cli-procedure>`
- :ref:`Create Replication Remote Targets <minio-bucket-replication-multi-site-minio-cli-create-remote-targets>`
- :ref:`Create New Bucket Replication Rules <minio-bucket-replication-multi-site-minio-cli-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-multi-site-minio-cli-verify-replication-config>`

.. _minio-bucket-replication-multi-site-minio-console-procedure:

Configure Multi-Site Bucket Replication Using the MinIO Console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. _minio-bucket-replication-multi-site-minio-console-create-replication-rules:

1) Create the Replication Rules
+++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-create-bucket-replication-rule-console-desc
:end-before: end-create-bucket-replication-rule-console-desc

Repeat the above steps to create a rule from this deployment to each of the other target deployments.

Then, repeat the above steps on each of the other deployments in the multi-site setup so that each deployment has a separate replication rule for all of the other deployments.

.. _minio-bucket-replication-multi-site-minio-console-validate-replication-config:

2) Validate the Replication Configuration
+++++++++++++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-validate-bucket-replication-console-desc
:end-before: end-validate-bucket-replication-console-desc

Repeat this test on each deployment by copying a new unique file and checking that the file replicates to each of the other deployments.

.. _minio-bucket-replication-multi-site-minio-cli-procedure:

Configure Multi-Site Bucket Replication Using the Command Line ``mc``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Original file line number Diff line number Diff line change
@@ -80,36 +80,11 @@ Click to expand any of the following:
Procedure
---------

- :ref:`Configure One-Way Bucket Replication Using the MinIO Console <minio-bucket-replication-one-way-minio-console-procedure>`
- :ref:`Create a New Bucket Replication Rule <minio-bucket-replication-one-way-minio-console-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-one-way-minio-console-validate-replication-config>`
- :ref:`Configure One-Way Bucket Replication Using the Command Line <minio-bucket-replication-one-way-minio-cli-procedure>`
- :ref:`Create a Replication Remote Target <minio-bucket-replication-one-way-minio-cli-create-remote-targets>`
- :ref:`Create a New Bucket Replication Rule <minio-bucket-replication-one-way-minio-cli-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-one-way-minio-cli-verify-replication-config>`

.. _minio-bucket-replication-one-way-minio-console-procedure:

Configure One-Way Bucket Replication Using the MinIO Console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. _minio-bucket-replication-one-way-minio-console-create-replication-rules:

1) Create a New Bucket Replication Rule
+++++++++++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-create-bucket-replication-rule-console-desc
:end-before: end-create-bucket-replication-rule-console-desc

.. _minio-bucket-replication-one-way-minio-console-validate-replication-config:

2) Validate the Replication Configuration
+++++++++++++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-validate-bucket-replication-console-desc
:end-before: end-validate-bucket-replication-console-desc

.. _minio-bucket-replication-one-way-minio-cli-procedure:

Original file line number Diff line number Diff line change
@@ -42,9 +42,9 @@ Access to Both Clusters

You must have network access and login credentials with required permissions to both deployment to set up active-active bucket replication.

You can access the deployments by logging in to the :ref:`MinIO Console <minio-console>` for each deployment or by installing :mc:`mc` and using the command line.
You can access the deployments by installing :mc:`mc` and using the command line.
Use the :mc:`mc alias set` command to create an alias for both MinIO deployments.

If using the command line, use the :mc:`mc alias set` command to create an alias for both MinIO deployments.
Alias creation requires specifying an access key for a user on the deployment.
This user **must** have permission to create and manage users and policies on the deployment.

@@ -111,43 +111,11 @@ Considerations
Procedure
---------

- :ref:`Configure Two-Way Bucket Replication Using the MinIO Console <minio-bucket-replication-two-way-minio-console-procedure>`
- :ref:`Create a New Bucket Replication Rule on Each Deployment <minio-bucket-replication-two-way-minio-console-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-two-way-minio-console-validate-replication-config>`
- :ref:`Configure Two-Way Bucket Replication Using the Command Line <minio-bucket-replication-two-way-minio-cli-procedure>`
- :ref:`Create Replication Remote Targets <minio-bucket-replication-two-way-minio-cli-create-remote-targets>`
- :ref:`Create a New Bucket Replication Rule on Each Deployment <minio-bucket-replication-two-way-minio-cli-create-replication-rules>`
- :ref:`Validate the Replication Configuration <minio-bucket-replication-two-way-minio-cli-verify-replication-config>`

.. _minio-bucket-replication-two-way-minio-console-procedure:

Configure Two-Way Bucket Replication Using the MinIO Console
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. _minio-bucket-replication-two-way-minio-console-create-replication-rules:

1) Create a New Bucket Replication Rule on Each Deployment
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-create-bucket-replication-rule-console-desc
:end-before: end-create-bucket-replication-rule-console-desc

Repeat the above steps to create a rule in the other direction.

A) Go to the Console for the destination deployment used above.
B) Create a replication rule from the second deployment back to the first deployment.
The first deployment becomes the target deployment for the rule on the second deployment.

.. _minio-bucket-replication-two-way-minio-console-validate-replication-config:

2) Validate the Replication Configuration
+++++++++++++++++++++++++++++++++++++++++

.. include:: /includes/common/bucket-replication.rst
:start-after: start-validate-bucket-replication-console-desc
:end-before: end-validate-bucket-replication-console-desc

.. _minio-bucket-replication-two-way-minio-cli-procedure:

Configure Two-Way Bucket Replication Using the Command Line ``mc``
@@ -199,4 +167,4 @@ Once both objects exist on both deployments, you have successfully set up two-wa

- Use the :mc:`mc replicate update` command with the :mc-cmd:`--state "disable" <mc replicate update --state>` flag to disable an existing replication rule.

- Use the :mc:`mc replicate rm` command to remove an existing replication rule.
- Use the :mc:`mc replicate rm` command to remove an existing replication rule.
12 changes: 1 addition & 11 deletions source/administration/console/managing-deployment.rst
Original file line number Diff line number Diff line change
@@ -15,7 +15,6 @@ You can use the MinIO Console to perform many of the deployment monitoring and m

- :ref:`Monitor <minio-console-monitoring>` the deployment activity and health by viewing a dashboard of metrics, server or audit logs, trace history, S3 events, or drive health.
- Configure alerts by adding or managing a :ref:`notification target <minio-console-notifications>`.
- Set up :ref:`site replication <minio-console-site-replication>` to synchronize datacenters for timely access across geographically dispersed workforces or for disaster preparedness.
- Configure deployment :ref:`settings <minio-console-settings>`.

.. important::
@@ -106,15 +105,6 @@ Select the :guilabel:`Add Event Destination +` button to add a new event target

You can select an existing notification target from the list to view its details or delete the target.

.. _minio-console-site-replication:

Site Replication
----------------

The :guilabel:`Site Replication` section provides an interface for adding and managing the :ref:`site replication <minio-site-replication-overview>` configuration for the deployment.

Configuring site replication requires that only a single site have existing buckets or objects (if any).

.. _minio-console-encryption:

Encryption
@@ -160,4 +150,4 @@ Some subsections may not be visible if the authenticated user does not have the
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.
Some configuration settings may require restarting the MinIO deployment to apply changes.
21 changes: 1 addition & 20 deletions source/administration/console/managing-objects.rst
Original file line number Diff line number Diff line change
@@ -16,7 +16,6 @@ Depending on the permissions and IAM policies for the authenticated user, you ca

- :ref:`Browse, upload, revert, manage, and interact with objects <minio-console-object-browser>`.
- :ref:`Browse, create, and manage buckets <minio-console-buckets>`.
- :ref:`Create or monitor remote tiers <minio-console-tiers>` for object transition rules.

.. _minio-console-object-browser:

@@ -84,7 +83,7 @@ While creating a bucket, you can enable :ref:`versioning <minio-bucket-versionin

If you enable versioning, you can specify prefixes to exclude from versioning.

You **must** configure replication, locking, and versioning options at the time of bucket creation.
You can configure locking and versioning options only when you create the bucket.
You cannot change these settings for the bucket later.

Managing Buckets
@@ -107,24 +106,6 @@ When managing a bucket, your access settings may allow you to view or change any

- Configure alerts in the :guilabel:`Events` section to trigger :ref:`notification events <minio-bucket-notifications>` when a user uploads, accesses, or deletes matching objects.

- Copy objects to remote locations in the :guilabel:`Replication` section with :ref:`Server Side Bucket Replication Rules <minio-bucket-replication-serverside>`.

- Expire or transition objects in the bucket from the :guilabel:`Lifecycle` section by setting up :ref:`Object Lifecycle Management Rules <minio-lifecycle-management>`.

- Review security in the :guilabel:`Access` section by listing the :ref:`policies <minio-policy>` and :ref:`users <minio-users>` with access to that bucket.

- Properly secure unauthenticated access with the :guilabel:`Anonymous` section by managing rules for prefixes that unauthenticated users can use to read or write objects.

.. _minio-console-tiers:

Tiers
-----

The :guilabel:`Tiering` section provides an interface for adding and managing :ref:`remote tiers <minio-lifecycle-management-tiering>` to support lifecycle management transition rules.
MinIO tiering supports moving objects from the deployment to the remote storage, but does not support automatically restoring them to the deployment.

The tiering tab allows users with the appropriate permissions to:

- Review the status and summary information for all configured remote tiers.
- Create a tier for a new remote target to storage on another MinIO deployment, Google Cloud Storage, Amazon's AWS S3, or Azure.
- Cycle the access credentials for any of the configured tiers with the tier's :octicon:`pencil` icon.
95 changes: 0 additions & 95 deletions source/administration/console/subnet-registration.rst

This file was deleted.

10 changes: 2 additions & 8 deletions source/administration/minio-console.rst
Original file line number Diff line number Diff line change
@@ -13,11 +13,6 @@ MinIO Console

The MinIO Console is a rich graphical user interface that provides similar functionality to the :mc:`mc` command line tool.

.. image:: /images/minio-console/minio-console.png
:width: 600px
:alt: MinIO Console Landing Page provides a view of the Object Browser for the authenticated user
:align: center

This page provides an overview of the MinIO Console and describes configuration options and instructions for logging in.

Overview
@@ -153,9 +148,9 @@ Available Tasks

Once logged in to the MinIO Console, users can perform many kinds of tasks.

- :ref:`Manage objects <minio-console-managing-objects>` by browsing or uploading objects, managing bucket settings, or creating tiers.
- :ref:`Manage objects <minio-console-managing-objects>` by browsing existing objects, uploading objects, or modifying bucket settings.
- :ref:`Review or modify identity and security <minio-console-security-access>` with access keys, policies, and Identity Provider settings.
- :ref:`Monitor the health and activities <minio-console-managing-deployment>` with metrics, notifications, or site replication
- :ref:`Monitor the health and activities <minio-console-managing-deployment>` with metrics and notifications.
- :ref:`Manage your deployment's license <minio-console-subscription>`

.. toctree::
@@ -165,4 +160,3 @@ Once logged in to the MinIO Console, users can perform many kinds of tasks.
/administration/console/managing-deployment
/administration/console/managing-objects
/administration/console/security-and-access
/administration/console/subnet-registration
115 changes: 1 addition & 114 deletions source/includes/common/bucket-replication.rst
Original file line number Diff line number Diff line change
@@ -1,94 +1,3 @@
.. start-create-bucket-replication-rule-console-desc
A) Log in to the MinIO Console for the deployment
B) Select the :guilabel:`Manage` button for the bucket to replicate

.. image:: /images/minio-console/console-bucket.png
:width: 600px
:alt: After a successful log in, the MinIO Console shows a list of buckets with options to manage or explore each bucket.
:align: center

C) Select the :guilabel:`Replication` section

.. image:: /images/minio-console/console-iam.png
:width: 600px
:alt: After selecting a bucket to manage, MinIO shows summary information about the bucket as well as a navigation list of pages for adjusting the bucket configuration.
:align: center

D) Select :guilabel:`Add Replication Rule +`
E) Complete the requested information:

.. list-table::
:header-rows: 1
:widths: 25 75
:width: 100%

* - Field
- Description

* - Priority
- Enter a number value to indicate the order in which to process replication rules for the bucket.
`1` indicates the highest importance.

* - Target URL
- The URL of the deployment to replicate data to.

* - Use TLS
- Leave the toggle in the :guilabel:`ON` position if the destination deployment uses TLS.
Otherwise, move the toggle to the :guilabel:`OFF` position.

* - Access Key
- The user name to use on the destination deployment.
The user must have write access to the bucket to replicate to.

* - Secret Key
- The password for the provided **Access Key**.

* - Target Bucket
- The bucket at the destination to write the data to.
The target bucket may have the same name as the origin bucket, depending on the destination bucket location.

* - Region
- The AWS resource region location of the destination deployment.

* - Replication mode
- Leave the default selection of **Asynchronous** to allow MinIO to replicate data after the write operation completes on the origin ment.
Select **Synchronous** to attempt to complete the replication of the object during its write operation.

While synchronous replication may result in more reliable synchronization between the origin and destination buckets, it may also increase the time of each write operation.

* - Bandwidth
- Specify the maximum amount of bandwidth the replication process can use while replicating data.
Enter a number and select a data unit.

* - Health Check Duration
- The maximum length of time in seconds MinIO should spend verifying the health of the replicated data on the destination bucket.

* - Storage Class
- The class of storage to use on the destination deployment for the replicated data.
Valid values are either ``STANDARD`` or ``REDUCED_REDUNDANCY``.

* - Object Filters
- Limit which objects to replicate from the bucket by :term:`Prefix` or **tags**.
If you enter multiple tags, the objects must match all tag values.

* - Metadata Sync
- Leave selected to also replicate the object's metadata file.
Otherwise, move the toggle to the :guilabel:`Off` position.

* - Delete Markers
- Leave selected to also replicate MinIO's indication that an object has been deleted and should also be marked deleted at the action bucket.
Otherwise, move the toggle to the :guilabel:`Off` position to prevent marking the object as deleted in the destination bucket.

* - Deletes
- Leave selected to allow replication of the deletion of versions of an object.
Otherwise, move the toggle to the :guilabel:`Off` position to not replicate deletion of object versions.

F) Select :guilabel:`Save` to finish adding the replication rule

.. end-create-bucket-replication-rule-console-desc
.. start-create-bucket-replication-rule-cli-desc
Use the :mc:`mc replicate add` command to add a new replication rule to each MinIO deployment.
@@ -124,28 +33,6 @@ Specify any other supported optional arguments for :mc:`mc replicate add`.

.. end-create-bucket-replication-rule-cli-desc
.. start-validate-bucket-replication-console-desc
A) Go to the :guilabel:`Buckets` section of the MinIO Console

.. image:: /images/minio-console/console-bucket.png
:width: 600px
:alt: The default screen when logging into the MinIO Console. The screen shows a list of the buckets available in the Deployment with options to Manage or Browse the bucket contents.
:align: center

B) Select the :guilabel:`Browse` button for the bucket you added replication to

.. image:: /images/minio-console/console-object-browser.png
:width: 600px
:alt: The contents of a bucket display after selecting to Browse the MinIO bucket. Options including to Rewind, Refresh, or Upload contents.

C) Select the :guilabel:`Upload` button to add a new object to the bucket
D) Select :guilabel:`Upload File`
E) Use the interface to add a new object to the bucket
F) Go to the other deployment's console and select the destination bucket defined in the replication

.. end-validate-bucket-replication-console-desc
.. start-validate-bucket-replication-cli-desc
Use :mc:`mc cp` to copy a new object to the replicated bucket on one of the deployments.
@@ -162,4 +49,4 @@ Use :mc:`mc ls` to verify the object exists on the destination bucket:
mc ls ALIAS/BUCKET
.. end-validate-bucket-replication-cli-desc
.. end-validate-bucket-replication-cli-desc
500 changes: 139 additions & 361 deletions source/operations/install-deploy-manage/multi-site-replication.rst

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions source/reference/minio-mc/mc-license-register.rst
Original file line number Diff line number Diff line change
@@ -15,8 +15,7 @@

``mc license register`` requires :ref:`MinIO Client <minio-client>` version ``RELEASE.2023-11-20T16-30-59Z`` or later.
While not strictly required, best practice keeps the :ref:`MinIO Client version <mc-client-versioning>` in alignment with the MinIO Server version.

If for any reason you cannot upgrade your MinIO Client to the required version or later for the purpose of registering to SUBNET, register using the :ref:`MinIO Console <minio-docs-subnet>` instead.


Description
-----------
@@ -197,4 +196,4 @@ Automatic License Updates

Once registered for |SUBNET|, MinIO automatically checks for and updates the license every month.

In airgapped or other environments where the server does not have direct access to the internet, use :mc-cmd:`mc license update` with the path to the file to update the registration.
In airgapped or other environments where the server does not have direct access to the internet, use :mc-cmd:`mc license update` with the path to the file to update the registration.

0 comments on commit 48feb40

Please sign in to comment.