Skip to content

Commit

Permalink
Merge branch 'main' into metrics-v2-not-deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
feorlen authored Dec 4, 2024
2 parents 35b674e + cfaedc8 commit 6cd6c59
Show file tree
Hide file tree
Showing 18 changed files with 275 additions and 730 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/makefile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ jobs:
- name: upload-artifact
uses: actions/upload-artifact@v4
with:
name: minio-docs-artifact
name: assets
compression-level: 9
path: ./minio
42 changes: 42 additions & 0 deletions .github/workflows/minimal-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Makefile CI

on:
pull_request:
types: [opened, reopened, synchronize]

jobs:
build:

runs-on: ubuntu-latest

steps:
- name: checkout
uses: actions/checkout@v4

- name: install-python
uses: actions/setup-python@v5
with:
python-version: '3.12'

- name: pip-requirements
run: pip install -r requirements.txt

- name: npm-setup
uses: actions/setup-node@v4
with:
node-version: 20

- name: npm-install-setup
uses: bahmutov/npm-install@v1
with:
working-directory: ./

- name: build-docs
run: ./build-docs-ci-minimal.sh

- name: upload-artifact
uses: actions/upload-artifact@v4
with:
name: linux-k8s-builds
compression-level: 9
path: ./minio
18 changes: 18 additions & 0 deletions build-docs-ci-minimal.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/bash

set -ex

export PATH=${PATH}:${HOME}/.local/bin
export GITDIR=main


make SYNC_SDK=TRUE linux
make k8s

echo $(ls build)

mkdir -p minio/kubernetes/upstream
cp -vr build/${GITDIR}/k8s/html/* ./minio/kubernetes/upstream/

mkdir -p minio/linux
cp -vr build/${GITDIR}/linux/html/* ./minio/linux/
7 changes: 3 additions & 4 deletions source/administration/batch-framework-job-keyrotate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ Required Fields
* - ``key:``
- Only for use with the ``sse-kms`` type.
The key to use to unseal the key vault.
* - ``context:``
- Only for use with the ``sse-kms`` type.
The context within which to perform actions.


Optional Fields
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -73,6 +69,9 @@ For **flag based filters**
- A date in ``YYYY-MM-DD`` format.

Keys rotate only for objects created prior to the date.
* - ``context:``
- Only for use with the ``sse-kms`` type.
The context within which to perform actions.
* - ``tags:``
- Rotate keys only for objects with tags that match the specified ``key:`` and ``value:``.
* - ``metadata:``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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>`
- Configure Multi-Site Bucket Replication Using the Command Line

- :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``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -162,8 +129,6 @@ This procedure assumes each alias corresponds to a user with the :ref:`necessary
:mc:`mc replicate add` automatically creates the necessary replication targets, removing the need for using the deprecated ``mc admin remote bucket add`` command.
This procedure only documents the procedure as of that release.

.. _minio-bucket-replication-multi-site-minio-cli-create-remote-targets:

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

1) Create New Bucket Replication Rules
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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``
Expand Down Expand Up @@ -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
Expand Up @@ -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::
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand All @@ -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.
Loading

0 comments on commit 6cd6c59

Please sign in to comment.