docs/source/operations/install-deploy-manage/deploy-minio-single-node-single-drive.rst

Deploy MinIO: Single-Node Single-Drive

minio

Table of Contents

The procedures on this page cover deploying MinIO in a Single-Node Single-Drive (SNSD) configuration for early development and evaluation. This mode was previously called Standalone Mode or 'filesystem' mode.

Starting with RELEASE.2022-06-02T02-11-04Z, MinIO implements a zero-parity erasure coded backend for single-node single-drive deployments. This feature allows access to erasure coding dependent features <minio-erasure-coding> without the requirement of multiple drives.

MinIO only starts in mode if the storage volume or path is empty or only contain files generated by a previous deployment. See minio-snsd-pre-existing-data <minio-snsd-pre-existing-data> for more complete documentation on MinIO startup behavior in mode.

For extended development or production environments, deploy MinIO in Distributed Mode. See deploy-minio-distributed for more information.

Pre-Existing Data

MinIO startup behavior depends on the the contents of the specified storage volume or path. The server checks for both MinIO-internal backend data and the structure of existing folders and files. The following table lists the possible storage volume states and MinIO behavior:

Storage Volume State	Behavior
Empty with no files, folders, or MinIO backend data	MinIO starts in mode and creates the zero-parity backend
Existing zero-parity objects and MinIO backend data	MinIO resumes in mode
Existing filesystem folders, files, and MinIO backend data	MinIO resumes in the legacy filesystem ("Standalone") mode with no erasure-coding features
Existing filesystem folders, files, but no MinIO backend data	MinIO returns an error and does not start

Deploy Single-Node Single-Drive MinIO

The following procedure deploys MinIO consisting of a single MinIO server and a single drive or storage volume.

Network File System Volumes Break Consistency Guarantees

MinIO's strict read-after-write and list-after-write consistency model requires local disk filesystems (xfs, ext4, etc.).

MinIO cannot provide consistency guarantees if the underlying storage volumes are NFS or a similar network-attached storage volume.

For deployments that require using network-attached storage, use NFSv4 for best results.

1) Download the MinIO Server

linux

macos

2) Download and Run MinIO Server

linux

macos

3) Add TLS Certificates

MinIO supports enabling Transport Layer Security (TLS) <minio-TLS> 1.2+ automatically upon detecting a x.509 private key (private.key) and public certificate (public.crt) in the MinIO certs directory:

linux

${HOME}/.minio/certs

macos

${HOME}/.minio/certs

windows

``%%USERPROFILE%%\.minio\certs``

You can override the certificate directory using the minio server --certs-dir commandline argument.

4) Run the MinIO Server with Non-Default Credentials

Issue the following command to start the minio server with non-default credentials. The table following this command breaks down each portion of the command:

linux

export MINIO_ROOT_USER=minio-admin
export MINIO_ROOT_PASSWORD=minio-secret-key-CHANGE-ME
#export MINIO_SERVER_URL=https://minio.example.net

minio server /data --console-address ":9090"

macos

export MINIO_ROOT_USER=minio-admin
export MINIO_ROOT_PASSWORD=minio-secret-key-CHANGE-ME
#export MINIO_SERVER_URL=https://minio.example.net

minio server /data --console-address ":9090"

windows

PS C:\minio> MINIO_ROOT_USER = 'minio-admin'
PS C:\minio> MINIO_ROOT_PASSWORD = 'minio-secret-key-CHANGE-ME'
PS C:\minio> MINIO_SERVER_URL = 'https://minio.example.net'

The example command breaks down as follows:

MINIO_ROOT_USER	The access key for the root <minio-users-root> user. Replace this value with a unique, random, and long string.
MINIO_ROOT_PASSWORD	The corresponding secret key to use for the root <minio-users-root> user. Replace this value with a unique, random, and long string.
MINIO_SERVER_URL	The URL hostname the MinIO Console uses for connecting to the MinIO server. This variable is required if specifying TLS certificates which do not contain the IP address of the MinIO Server host as a Subject Alternative Name <5280#section-4.2.1.6>. Specify a hostname covered by one of the TLS certificate SAN entries.
/data	The path to each disk on the host machine. See minio server DIRECTORIES for more information on configuring the backing storage for the minio server process. MinIO writes objects to the specified directory as is and without minio-erasure-coding. Any other application accessing that directory can read and modify stored objects.
--console-address ":9090"	The static port on which the embedded MinIO Console listens for incoming connections. Omit to allow MinIO to select a dynamic port for the MinIO Console. With dynamic port selection, browsers opening the root node hostname https://minio1.example.com:9000 are automatically redirected to the Console.

You may specify other environment variables <minio-server-environment-variables> as required by your deployment.

5) Open the MinIO Console

Open your browser to the DNS name or IP address corresponding to the container and the MinIO Console <minio-console> port. For example, https://127.0.0.1:9090.

Log in with the MINIO_ROOT_USER and MINIO_ROOT_PASSWORD from the previous step.

You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration. Each MinIO server includes its own embedded MinIO Console.

Applications should use the https://HOST-ADDRESS:9000 to perform S3 operations against the MinIO server.

Deploy Containerized Single-Node Single-Drive MinIO

The following procedure deploys a single MinIO container with a single drive.

The procedure uses Podman for running the MinIO container in rootfull mode. Configuring for rootless mode is out of scope for this procedure.

Network File System Volumes Break Consistency Guarantees

MinIO's strict read-after-write and list-after-write consistency model requires local disk filesystems (xfs, ext4, etc.).

MinIO cannot provide consistency guarantees if the underlying storage volumes are NFS or a similar network-attached storage volume.

For deployments that require using network-attached storage, use NFSv4 for best results.

1) Create a Configuration File to store Environment Variables

MinIO reads configuration values from environment variables. MinIO supports reading these environment variables from /run/secrets/config.env. Save the config.env file as a Podman secret <secret.html> and specify it as part of running the container.

Create a file config.env using your preferred text editor and enter the following environment variables:

export MINIO_ROOT_USER=minio-admin
export MINIO_ROOT_PASSWORD=minio-secret-key-CHANGE-ME
#export MINIO_SERVER_URL=https://minio.example.net

Create the Podman secret using the config.env file:

sudo podman secret create config.env config.env

The following table details each environment variable set in config.env:

MINIO_ROOT_USER	The access key for the root <minio-users-root> user. Replace this value with a unique, random, and long string.
MINIO_ROOT_PASSWORD	The corresponding secret key to use for the root <minio-users-root> user. Replace this value with a unique, random, and long string.
MINIO_SERVER_URL	The URL hostname the MinIO Console uses for connecting to the MinIO server. This variable is required if specifying TLS certificates which do not contain the IP address of the MinIO Server host as a Subject Alternative Name <5280#section-4.2.1.6>. Specify a hostname covered by one of the TLS certificate SAN entries.

You may specify other environment variables <minio-server-environment-variables> as required by your deployment.

2) Add TLS Certificates

MinIO supports enabling Transport Layer Security (TLS) <minio-TLS> 1.2+ automatically upon detecting a x.509 private key (private.key) and public certificate (public.crt) in the MinIO certs directory:

Create a Podman secret pointing to the x.509 private.key and public.crt to use for the container.

sudo podman secret create private.key /path/to/private.key
sudo podman secret create public.crt /path/to/public.crt

You can optionally skip this step to deploy without TLS enabled. MinIO strongly recommends against non-TLS deployments outside of early development.

3) Run the MinIO Container

Issue the following command to start the MinIO server in a container:

sudo podman run -p 9000:9000 -p 9090:9090 \
  -v /data:/data \
  --secret private.key \
  --secret public.crt \
  --secret config.env \
  minio/minio server /data \
  --console-address ":9090" \
  --certs-dir "/run/secrets/"

The example command breaks down as follows:

-p 9000:9000, -p 9090:9090	Exposes the container internal port 9000 and 9090 through the node port 9000 and 9090 respectively. Port 9000 is the default MinIO server listen port. Port 9090 is the MinIO Console <minio-console> listen port specified by the --console-address argument.
-v /data:/data	Mounts a local volume to the container at the specified path.
--secret ...	Mounts a secret to the container. The specified secrets correspond to the following: The x.509 private and public key the MinIO server process uses for enabling TLS. The config.env file from which MinIO looks for configuration environment variables.
/data	The path to the container volume in which the minio server stores all information related to the deployment. See minio server DIRECTORIES for more information on configuring the backing storage for the minio server process.
--console-address ":9090"	The static port on which the embedded MinIO Console listens for incoming connections. Omit to allow MinIO to select a dynamic port for the MinIO Console. With dynamic port selection, browsers opening the root node hostname https://minio1.example.com:9000 are automatically redirected to the Console.
--cert /run/secrets/	Directs the MinIO server to use the /run/secrets/ folder for retrieving x.509 certificates to use for enabling TLS.

4) Open the MinIO Console

Open your browser to the DNS name or IP address corresponding to the container and the MinIO Console <minio-console> port. For example, https://127.0.0.1:9090.

Log in with the MINIO_ROOT_USER and MINIO_ROOT_PASSWORD from the previous step.

You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration. Each MinIO server includes its own embedded MinIO Console.

Applications should use the https://HOST-ADDRESS:9000 to perform S3 operations against the MinIO server.