1
0
mirror of https://github.com/minio/docs.git synced 2025-07-24 10:22:32 +03:00

Updates for MinIO Server release 2023-08-04 (#1000)

Updates for release 2023-08-04T17-40-21Z
    
- Adds info on new 10,000 version limit to appropriate pags
- Updates Grafana with site replication info

Closes #938
This commit is contained in:
Daryl White
2023-09-16 20:35:13 -04:00
committed by GitHub
parent a077c6b9c5
commit 01606fbfa1
6 changed files with 49 additions and 16 deletions

View File

@ -51,7 +51,7 @@ The login flow for an application using :abbr:`OIDC (OpenID Connect)` credential
1. Create an OIDC Configuration.
2. Record the RoleARN assigned to the configuration either at time of creation or at MinIO start.
Use this RoleARN with the :ref:`AssumeRoleWithWebIdentity <minio-sts-assumerolewithwebidentit>` STS API.
Use this RoleARN with the :ref:`AssumeRoleWithWebIdentity <minio-sts-assumerolewithwebidentity>` STS API.
3. Create a RolePolicy to use with the RoleARN.
Use either the :envvar:`MINIO_IDENTITY_OPENID_ROLE_POLICY` environment variable or the :mc-conf:`identity_openid role_policy <identity_openid.role_policy>` configuration setting to define the list of policies to use for the provider
4. Users select the configured OIDC provider when logging in to MinIO.

View File

@ -84,7 +84,10 @@ For a deeper discussion on the benefits of limiting prefix contents, see the art
Object Versioning
-----------------
MinIO supports keeping multiple "versions" of an object in a single bucket.
.. versionchanged:: RELEASE.2023-08-04T17-40-21Z
MinIO supports keeping up to 10,000 "versions" of an object in a single bucket.
For workloads that require keeping more than 10K versions per object, please reach out to MinIO by email at hello@min.io.
.. image:: /images/retention/minio-versioning-multiple-versions.svg
:alt: Object with Multiple Versions

View File

@ -19,16 +19,28 @@ Overview
--------
MinIO supports keeping multiple "versions" of an object in a single bucket.
Write operations which would normally overwrite an existing object instead
result in the creation of a new versioned object. MinIO versioning protects from
unintended overwrites and deletions while providing support for "undoing" a
write operation. Bucket versioning is a prerequisite for configuring
:ref:`object locking and retention rules <minio-object-locking>`.
For versioned buckets, any write operation that mutates an object results in a
new version of that object with a unique version ID. MinIO marks the "latest"
version of the object that clients retrieve by default. Clients can then
explicitly choose to list, retrieve, or remove a specific object version.
When enabled, versioning allows MinIO to keep multiple iterations of the same object.
Write operations which would normally overwrite an existing object instead result in the creation of a new versioned object.
MinIO versioning protects from unintended overwrites and deletions while providing support for "undoing" a write operation.
Bucket versioning is a prerequisite for configuring :ref:`object locking and retention rules <minio-object-locking>`.
For versioned buckets, a write operation that mutates an object results in a new version of that object with a unique version ID.
MinIO marks the "latest" version of the object that clients retrieve by default.
Clients can then explicitly choose to list, retrieve, or remove a specific object version.
.. versionchanged:: 2023-08-04T17-40-21Z
MinIO restricts object versioning to no more than 10,000 versions of each object.
If a write operation would exceed the 10,000 object version limit, MinIO blocks the operation and returns an error.
:ref:`Delete one or more <minio-bucket-versioning-delete>` versions to create a new version of the object.
Read Operations on Versioned Objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Review each of the four images in this series to see how MinIO retrieves objects in a versioned bucket.
Use the arrows on either side of the images to navigate from one to the next.
.. card-carousel:: 1
@ -55,13 +67,15 @@ explicitly choose to list, retrieve, or remove a specific object version.
:alt: Object with Multiple Versions
:align: center
A read operation request without a version ID returns the latest version of the object.
.. card:: Retrieving a Specific Object Version
.. image:: /images/retention/minio-versioning-retrieve-single-version.svg
:alt: Object with Multiple Versions
:align: center
:ref:`Delete operations <minio-bucket-versioning-delete>` which do *not* specify the unique object version ID create a 0-byte ``DeleteMarker`` for that object.
Include the version ID to retrieve a specific version of an object during a read operation.
.. versionchanged:: MinIO Server RELEASE.2023-05-04T21-44-30Z
@ -151,7 +165,7 @@ Performing a ``DELETE`` operation on a versioned object creates a 0-byte ``Delet
For objects where the latest version is a ``DeleteMarker``, clients must specify versioning flags or identifiers to perform ``GET/HEAD/LIST/DELETE`` operations on a prior version of that object.
The default server behavior omits ``DeleteMarker`` objects from consideration for unversioned operations.
MinIO can utilize :ref:`Lifecycle Management expiration rules <minio-lifecycle-management-expiration>` to automatically remove versioned objects permanently.
MinIO can utilize :ref:`Lifecycle Management expiration rules <minio-lifecycle-management-expiration>` to automatically remove versioned objects permanently.
Otherwise, use manual ``DELETE`` operations to permanently remove non-current versioned objects or ``DeleteMarker`` objects.
.. admonition:: MinIO Implements Idempotent Delete Markers
@ -160,7 +174,7 @@ Otherwise, use manual ``DELETE`` operations to permanently remove non-current ve
.. versionchanged:: RELEASE.2022-08-22T23-53-06Z
Standard S3 implementations can create multiple sequential delete markers for the same object when processing simple ``DeleteObject`` requests with no version identifier.
See the S3 docs for details on :s3-docs:`managing delete markers <ManagingDelMarkers.html#RemDelMarker>``
See the S3 docs for details on :s3-docs:`managing delete markers <ManagingDelMarkers.html#RemDelMarker>`.
MinIO diverges from standard S3 implementation by avoiding this potential duplication of delete markers.
When processing a ``Delete`` request with no version identifier, MinIO creates at most one Delete Marker for the specified object.

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

View File

@ -27,6 +27,7 @@ MinIO provides two official Grafana Dashboards you can download from the Grafana
1. :ref:`MinIO Server metrics <minio-server-grafana-metrics>`
2. :ref:`MinIO Bucket metrics <minio-buckets-grafana-metrics>`
3. :ref:`MinIO Replication metrics <minio-replication-grafana-metrics>`
To track changes to the Grafana dashboard, introspect the JSON files for the `server <https://github.com/minio/minio/blob/master/docs/metrics/prometheus/grafana/minio-dashboard.json>`__ or `bucket <https://github.com/minio/minio/blob/master/docs/metrics/prometheus/grafana/minio-bucket.json>`__ dashboards in the MinIO Server GitHub repository.
@ -50,11 +51,25 @@ For specifics on the dashboard's configuration, see the `JSON file on GitHub <ht
MinIO Bucket Metrics Dashboard
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Visualize MinIO bucket metrics with the official MinIO Grafana dashboard for buckets available on the `Grafana dashboard portal <https://grafana.com/grafana/dashboards/19237-minio-bucket-dashboard//>`__.
Visualize MinIO bucket metrics with the official MinIO Grafana dashboard for buckets available on the `Grafana dashboard portal <https://grafana.com/grafana/dashboards/19237-minio-bucket-dashboard/>`__.
Bucket metrics can be viewed in the Grafana dashboard using the `bucket JSON file on GitHub <https://raw.githubusercontent.com/minio/minio/master/docs/metrics/prometheus/grafana/minio-bucket.json>`__.
.. image:: /images/grafana-bucket.png
:width: 600px
:alt: A sample of the MinIO Grafana dashboard showing many different captured metrics MinIO buckets.
:alt: A sample of the MinIO Grafana dashboard showing many different captured metrics for MinIO buckets.
:align: center
.. _minio-replication-grafana-metrics:
MinIO Cluster Replication Metrics Dashboard
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Visualize MinIO bucket metrics with the official MinIO Grafana dashboard for cluster replication available on the `Grafana dashboard portal <https://grafana.com/grafana/dashboards/15305-minio-cluster-replication-dashboard/>`__.
Cluster replication metrics can be viewed in the Grafana dashboard using the `cluster replication JSON file on GitHub <https://raw.githubusercontent.com/minio/minio/master/docs/metrics/prometheus/grafana/minio-replication.json>`__.
.. image:: /images/grafana-replication.png
:width: 600px
:alt: A sample of the MinIO Grafana dashboard showing many different captured metrics for cluster replication.
:align: center

View File

@ -107,6 +107,7 @@ Parameters
:optional:
Enables :ref:`object versioning <minio-bucket-versioning>` on the new bucket.
When enabled, MinIO keeps up to 10,000 versions of each object.
Versioning is required for :ref:`bucket replication <minio-bucket-replication>` or :ref:`site replication <minio-site-replication-overview>`.
Versioning does not imply or require object locking.