mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
Attempting to reduce docs to single platform
This commit is contained in:
Ravind Kumar
@ -1,96 +0,0 @@
|
||||
.. _minio-installation:
|
||||
|
||||
========================
|
||||
Install and Deploy MinIO
|
||||
========================
|
||||
|
||||
.. default-domain:: minio
|
||||
|
||||
.. contents:: Table of Contents
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
.. container:: extlinks-video
|
||||
|
||||
- `Installing and Running MinIO: Overview <https://youtu.be/mg9NRR6Js1s?ref=docs>`__
|
||||
- `Installing and Running MinIO: Installation Lab <https://youtu.be/Z0FtabDUPtU?ref=docs>`__
|
||||
- `Installing and Running MinIO: Docker Compose Overview <https://youtu.be/FtJA3TmjaJQ?ref=docs>`__
|
||||
- `Installing and Running MinIO: Docker Compose Lab: <https://youtu.be/tRlEctAwkk8?ref=docs>`__
|
||||
|
||||
MinIO is a software-defined high performance distributed object storage server.
|
||||
You can run MinIO on consumer or enterprise-grade hardware and a variety of operating systems and architectures.
|
||||
|
||||
MinIO supports three deployment topologies:
|
||||
|
||||
Single-Node Single-Drive (SNSD or "Standalone")
|
||||
A single MinIO server with a single storage volume or folder.
|
||||
|SNSD| deployment provides failover protections. Drive-level reliability and failover depends on the underlying storage volume.
|
||||
|
||||
|SNSD| deployments are best suited for evaluation and initial development of applications using MinIO for object storage.
|
||||
|
||||
|SNSD| deployments implement a zero-parity erasure coding backend and include support for the following erasure-coding dependent features:
|
||||
|
||||
- :ref:`Versioning <minio-bucket-versioning>`
|
||||
- :ref:`Object Locking / Retention <minio-object-retention>`
|
||||
|
||||
Single-Node Multi-Drive (SNMD or "Standalone Multi-Drive")
|
||||
A single MinIO server with four or more storage volumes.
|
||||
|SNMD| deployments provide drive-level reliability and failover only.
|
||||
|
||||
Multi-Node Multi-Drive (MNMD or "Distributed")
|
||||
Multiple MinIO servers with at least four drives across all servers.
|
||||
The distributed |MNMD| topology supports production-grade object storage with drive and node-level availability and resiliency.
|
||||
|
||||
.. note::
|
||||
|
||||
This documentation provides instructions for |SNSD| and |SNMD| for supporting local development and evaluation of MinIO on a single host machine **only**.
|
||||
For |MNMD| deployments, use the MinIO Kubernetes Operator to :minio-docs:`deploy and manage MinIO tenants in a containerized and orchestrated environment <minio/kubernetes/upstream/operations/installation.html>`.
|
||||
|
||||
Site Replication
|
||||
----------------
|
||||
|
||||
:ref:`Site replication <minio-site-replication-overview>` links multiple MinIO deployments together and keeps the buckets, objects, and Identity and Access Management (IAM) settings in sync across all connected sites.
|
||||
|
||||
.. include:: /includes/common-replication.rst
|
||||
:start-after: start-mc-admin-replicate-what-replicates
|
||||
:end-before: end-mc-admin-replicate-what-replicates
|
||||
|
||||
.. important::
|
||||
|
||||
MinIO does not recommend using |platform| hosts for site replication outside of early development, evaluation, or general experimentation.
|
||||
For production, use :minio-docs:`Kubernetes <minio/kubernetes/upstream/operations/install-deploy-manage/multi-site-replication.html>` for an orchestrated container environment.
|
||||
|
||||
What Does Not Replicate?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Not everything replicates across sites.
|
||||
|
||||
.. include:: /includes/common-replication.rst
|
||||
:start-after: start-mc-admin-replicate-what-does-not-replicate
|
||||
:end-before: end-mc-admin-replicate-what-does-not-replicate
|
||||
|
||||
.. _minio-installation-platform-support:
|
||||
|
||||
Platform Support
|
||||
----------------
|
||||
|
||||
MinIO provides container images at the following repositories:
|
||||
|
||||
- https://hub.docker.com/r/minio/minio
|
||||
- https://quay.io/repository/minio/minio?tab=info
|
||||
|
||||
.. versionchanged:: RELEASE.2022-12-02T19-19-22Z
|
||||
|
||||
These images include the :ref:`MinIO Client <minio-client>` command line tool built in for container-level debugging.
|
||||
However, to regularly interact with a container MinIO install, :ref:`install the MinIO Client <mc-install>` on your computer and define an :mc:`alias <mc alias set>` to the container instead.
|
||||
|
||||
Use of MinIO images from any other repository, host, or organization is at your own risk.
|
||||
|
||||
The :ref:`Single-Node Single-Drive <minio-snsd>` and :ref:`Single-Node Multi-Drive <minio-snmd>` tutorials provide instructions for the `Docker <https://www.docker.com/>`__ and :podman-docs:`Podman <>` container managers.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
/operations/install-deploy-manage/deploy-minio-single-node-single-drive
|
||||
/operations/install-deploy-manage/deploy-minio-single-node-multi-drive
|
||||
@ -1,142 +0,0 @@
|
||||
MinIO uses an update-then-restart methodology for upgrading a deployment to a newer release:
|
||||
|
||||
1. Update the container MinIO image with the newer release.
|
||||
2. Restart the container.
|
||||
|
||||
This procedure does not require taking downtime and is non-disruptive to ongoing operations.
|
||||
|
||||
Considerations
|
||||
--------------
|
||||
|
||||
Upgrades Are Non-Disruptive
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
MinIO's upgrade-then-restart procedure does *not* require taking downtime or scheduling a maintenance period.
|
||||
MinIO restarts are fast, such that restarting all server processes in parallel typically completes in a few seconds.
|
||||
MinIO operations are atomic and strictly consistent, such that applications using MinIO or S3 SDKs can rely on the built-in :aws-docs:`transparent retry <general/latest/gr/api-retries.html>` without further client-side logic.
|
||||
This ensures upgrades are non-disruptive to ongoing operations.
|
||||
|
||||
Check Release Notes
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
MinIO publishes :minio-git:`Release Notes <minio/releases>` for your reference as part of identifying the changes applied in each release.
|
||||
Review the associated release notes between your current MinIO version and the newer release so you have a complete view of any changes.
|
||||
|
||||
Pay particular attention to any releases that are *not* backwards compatible.
|
||||
You cannot trivially downgrade from any such release.
|
||||
|
||||
Procedure
|
||||
---------
|
||||
|
||||
You can run the ``podman container inspect`` or ``docker inspect`` command to inspect the container and validate the current container image:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
# For docker, use docker inspect
|
||||
podman container inspect --format='{{.Config.Image}}' CONTAINER_NAME
|
||||
|
||||
The following output indicates the container was created using the most recent stable image tag:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
quay.io/minio/minio:latest
|
||||
|
||||
Use the :ref:`minio-upgrade-latest-tag` steps to upgrade your container.
|
||||
|
||||
The following output indicates the container was created using a specific image tag:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
quay.io/minio/minio:RELEASE.2023-07-21T21-12-44Z
|
||||
|
||||
Use the :ref:`minio-upgrade-specific-tag` steps to upgrade your container.
|
||||
|
||||
.. _minio-upgrade-latest-tag:
|
||||
|
||||
Upgrade Containers using Latest Image Tag
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Update your image registry
|
||||
|
||||
Pull the latest stable MinIO image for the configured image repository:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
# For docker, use docker pull
|
||||
podman pull quay.io/minio/minio:latest
|
||||
|
||||
#. Restart the container
|
||||
|
||||
You must restart the container to load the new image binary for use by MinIO:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
# For docker, use docker restart
|
||||
podman container restart CONTAINER_NAME
|
||||
|
||||
#. Validate the Upgrade
|
||||
|
||||
Use the :mc:`mc admin info` command to check that the MinIO container is online, operational, and reflects the installed MinIO version.
|
||||
|
||||
#. Update MinIO Client
|
||||
|
||||
You should upgrade your :mc:`mc` binary to match or closely follow the MinIO server release.
|
||||
You can use the :mc:`mc update` command to update the binary to the latest stable release:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc update
|
||||
|
||||
.. _minio-upgrade-specific-tag:
|
||||
|
||||
Upgrade Containers using Specific Image Tag
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Update your local image registry
|
||||
|
||||
Pull the desired image you want to use for updating the container.
|
||||
The following example uses the latest stable version of MinIO:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
# For docker, use docker pull
|
||||
podman pull quay.io/minio/minio:|minio-tag|
|
||||
|
||||
#. Modify the container start script or configuration
|
||||
|
||||
Specify the new MinIO tag to the container start script or configuration.
|
||||
For Docker, this might be the Compose file used to start MinIO.
|
||||
For Podman, this might be a YAML file used to create the container or pod.
|
||||
|
||||
Ensure the ``image: <VALUE>`` matches the newly pulled image tag.
|
||||
|
||||
#. Restart or re-create the container
|
||||
|
||||
If you started the container using CLI commands, you may need to completely stop, remove, and re-create the container.
|
||||
Use a script to perform this procedure to minimize potential downtime.
|
||||
|
||||
For Docker, this might require running ``docker compose restart``.
|
||||
|
||||
#. Validate the Upgrade
|
||||
|
||||
Use the :mc:`mc admin info` command to check that the MinIO container is online, operational, and reflects the installed MinIO version.
|
||||
|
||||
#. Update MinIO Client
|
||||
|
||||
You should upgrade your :mc:`mc` binary to match or closely follow the MinIO server release.
|
||||
You can use the :mc:`mc update` command to update the binary to the latest stable release:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mc update
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user