Usage
Getting started: how to use MinIO? How to reliably access MinIO? How to use mc / rclone client tools?
MinIO is an S3-compatible multi-cloud object storage software, open-sourced under the AGPLv3 license.
MinIO can be used to store documents, images, videos, and backups. Pigsty natively supports deploying various MinIO clusters with native multi-node multi-disk high availability support, easy to scale, secure, and ready to use out of the box. It has been used in production environments at 10PB+ scale.
MinIO is an optional module in Pigsty. You can use MinIO as an optional storage repository for PostgreSQL backups, supplementing the default local POSIX filesystem repository.
If using the MinIO backup repository, the MINIO module should be installed before any PGSQL modules. MinIO requires a trusted CA certificate to work, so it depends on the NODE module.
Here’s a simple example of MinIO single-node single-disk deployment:
# Define MinIO cluster in the config inventory
minio: { hosts: { 10.10.10.10: { minio_seq: 1 } }, vars: { minio_cluster: minio } }
./minio.yml -l minio # Deploy MinIO module on the minio group
After deployment, you can access MinIO via:
https://sss.pigsty:9000 (requires DNS resolution for the domain)https://<minio-ip>:9001 (default username/password: minioadmin / S3User.MinIO)mcli ls sss/ (alias pre-configured on the admin node)MinIO supports three major deployment modes:
| Mode | Description | Use Cases |
|---|---|---|
| Single-Node Single-Disk (SNSD) | Single node, single data directory | Development, testing, demo |
| Single-Node Multi-Disk (SNMD) | Single node, multiple disks | Resource-constrained small-scale deployments |
| Multi-Node Multi-Disk (MNMD) | Multiple nodes, multiple disks per node | Recommended for production |
Additionally, you can use multi-pool deployment to scale existing clusters, or deploy multiple clusters.
mcli client alias, one-click deployment and managementGetting started: how to use MinIO? How to reliably access MinIO? How to use mc / rclone client tools?
Choose the appropriate MinIO deployment type based on your requirements and provide reliable access.
MinIO module provides 21 configuration parameters for customizing your MinIO cluster.
Manage MinIO clusters with Ansible playbooks and quick command reference.
MinIO cluster management SOP: create, destroy, expand, shrink, and handle node and disk failures.
How to monitor MinIO in Pigsty? How to use MinIO’s built-in console? What alerting rules are worth noting?
Complete list of monitoring metrics provided by the Pigsty MINIO module with explanations
Frequently asked questions about the Pigsty MINIO object storage module
Was this page helpful?
Thanks for the feedback! Please let us know how we can improve.
Sorry to hear that. Please let us know how we can improve.