Skip to content

Commit

Permalink
DOCS-1190: RELEASE.2024-04-18T19-09-19Z (#1215)
Browse files Browse the repository at this point in the history
Partially addresses #1190 

No staged build unless someone requests it.

# Summary

After some thinking, we've leaned towards just making a note of the
upgrade step and calling it done. We do not typically make extended
discussion of backward-breaking changes at this time, and have no where
to keep that sort of guidance.

Maybe in the future or as part of a larger re-arch we can consider where
we would best keep that kind of guidance.

As far as the rest:

- We are not covering s3zip today, so that's a no-op. We should leave
the ticket open in the event we have bandwidth to document the feature
later
- No changes to Console that need documentation at this time
- Added a quick callout on the warning behavior to the Versioning page
- Metrics v3 is also still In progress, come back to this once the
project is fully baked.
  • Loading branch information
ravindk89 committed May 10, 2024
1 parent 2953b54 commit 775e99d
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 5 deletions.
4 changes: 4 additions & 0 deletions source/administration/object-management/object-versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ following commands:
- :mc-cmd:`mc rm --versions --older-than <mc rm --older-than>` -
Removes all versions of an object older than the specified calendar date.

.. versionadded:: RELEASE.2024-04-18T19-09-19Z

MinIO emits a warning if the cumulative size of versions for any single object exceeds 1TiB.

.. _minio-bucket-versioning-id:

Version ID Generation
Expand Down
2 changes: 1 addition & 1 deletion source/default-conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
's3-docs' : ('https://docs.aws.amazon.com/AmazonS3/latest/userguide/%s', None),
's3-api' : ('https://docs.aws.amazon.com/AmazonS3/latest/API/%s', None),
'iam-docs' : ('https://docs.aws.amazon.com/IAM/latest/UserGuide/%s', None),
'minio-release' : ('https://github.com/minio/minio/releases/tag/%s', None),
'minio-release' : ('https://github.com/minio/minio/releases/tag/%s', '%s'),
'mc-release' : ('https://github.com/minio/mc/releases/tag/%s', None),
'prometheus-docs' : ('https://prometheus.io/docs/%s', None),
'podman-docs' : ('https://docs.podman.io/en/latest/%s', None),
Expand Down
2 changes: 1 addition & 1 deletion source/includes/linux/common-installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ operating systems using RPM, DEB, or binary:
wget https://dl.min.io/server/minio/release/linux-amd64/minio
chmod +x minio
sudo mv minio /usr/local/bin/
sudo mv -f ./minio /usr/local/bin/minio
Replace ``/usr/local/bin`` with the location of the existing MinIO
binary. Run ``which minio`` to identify the path if not already known.
Expand Down
11 changes: 8 additions & 3 deletions source/includes/linux/steps-upgrade-minio-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,20 @@ Update ``systemctl``-Managed MinIO Deployments

Use these steps to upgrade a MinIO deployment where the MinIO server process is managed by ``systemctl``, such as those created using the MinIO :ref:`DEB/RPM packages <deploy-minio-distributed-baremetal>`.

This procedure assumes you have the :envvar:`MINIO_CONFIG_ENV_FILE` variable set on all MinIO nodes.

1. Update the MinIO Binary on Each Node

.. include:: /includes/linux/common-installation.rst
:start-after: start-upgrade-minio-binary-desc
:end-before: end-upgrade-minio-binary-desc

Run ``minio --version`` on each node to validate that you successfully upgraded all binaries to the same version.
Do **not** proceed unless all nodes use the same MinIO binary version.

2. Restart the Deployment

Run the :mc-cmd:`mc admin service restart` command to restart all MinIO server processes in the deployment simultaneously.

The restart process typically completes within a few seconds and is *non-disruptive* to ongoing operations.

.. code-block:: shell
:class: copyable
Expand All @@ -82,6 +85,8 @@ Use these steps to upgrade a MinIO deployment where the MinIO server process is
Replace :ref:`alias <alias>` of the MinIO deployment to restart.

S3-compatible SDKs and applications should retry operations automatically, such that the restart process is typically *non-disruptive* to ongoing operations.

3. Validate the Upgrade

Use the :mc:`mc admin info` command to check that all MinIO servers are online, operational, and reflect the installed MinIO version.
Expand Down Expand Up @@ -150,7 +155,7 @@ The command overwrites the existing ``minio`` binary at that path.
wget https://dl.min.io/server/minio/release/linux-amd64/minio
chmod +x ./minio
sudo mv -f ./minio /usr/local/bin/
sudo mv -f ./minio /usr/local/bin/minio
Once you have replaced the binary on all MinIO hosts in the deployment, you must restart all nodes simultaneously.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Upgrade a MinIO Deployment
:local:
:depth: 2

.. important::

For deployments older than :minio-release:`RELEASE.2024-03-30T09-41-56Z` running with :ref:`AD/LDAP <minio-ldap-config-settings>` enabled, you **must** read through the release notes for :minio-release:`RELEASE.2024-04-18T19-09-19Z` before starting this procedure.
You must take the extra steps documented in the linked release as part of the upgrade.

.. cond:: linux

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Upgrade a MinIO Tenant
:local:
:depth: 1

.. important::

For Tenants using a MinIO Image older than :minio-release:`RELEASE.2024-03-30T09-41-56Z` running with :ref:`AD/LDAP <minio-ldap-config-settings>` enabled, you **must** read through the release notes for :minio-release:`RELEASE.2024-04-18T19-09-19Z` before starting this procedure.
You must take the extra steps documented in the linked release as part of the upgrade procedure.

.. _minio-upgrade-tenant-plugin:

Upgrade the Tenant using the MinIO Kubernetes Plugin
Expand Down
4 changes: 4 additions & 0 deletions source/url-excludes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ excludes:
- 'operations/install-deploy-manage/delete-minio-tenant.rst'
- 'operations/install-deploy-manage/minio-operator-console.rst'
- 'operations/install-deploy-manage/deploy-minio-tenant-helm.rst'
- 'operations/install-deploy-manage/deploy-operator-kustomize.rst'
- 'operations/deploy-manage-tenants.rst'
- 'developers/sts-for-operator.rst'
- 'reference/kubectl-minio-plugin.rst'
Expand Down Expand Up @@ -43,6 +44,7 @@ excludes:
- 'operations/install-deploy-manage/delete-minio-tenant.rst'
- 'operations/install-deploy-manage/minio-operator-console.rst'
- 'operations/install-deploy-manage/deploy-minio-tenant-helm.rst'
- 'operations/install-deploy-manage/deploy-operator-kustomize.rst'
- 'operations/deploy-manage-tenants.rst'
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
Expand Down Expand Up @@ -75,6 +77,7 @@ excludes:
- 'operations/install-deploy-manage/delete-minio-tenant.rst'
- 'operations/install-deploy-manage/minio-operator-console.rst'
- 'operations/install-deploy-manage/deploy-minio-tenant-helm.rst'
- 'operations/install-deploy-manage/deploy-operator-kustomize.rst'
- 'operations/deploy-manage-tenants.rst'
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
Expand Down Expand Up @@ -104,6 +107,7 @@ excludes:
- 'operations/install-deploy-manage/expand-minio-deployment.rst'
- 'operations/deploy-manage-tenants.rst'
- 'operations/install-deploy-manage/deploy-minio-tenant-helm.rst'
- 'operations/install-deploy-manage/deploy-operator-kustomize.rst'
- 'reference/kubectl-minio-plugin*'
- 'reference/minio-server*'
- 'reference/minio-mc*'
Expand Down

0 comments on commit 775e99d

Please sign in to comment.