minio/docs

mirror of https://github.com/minio/docs.git synced 2025-10-26 20:12:23 +03:00

Files

Ravind Kumar 571f188a4e Attempting to reduce docs to single platform (#1258 )

##

We are going to make the following changes to the Object Store docs as
part of a larger QC/Content pass:

### Left Navigation

We want to modify the left navigation flow to be a natural progression
from a basic setup to more advanced.

For example:

- Core Concepts
  - Deployment Architecture
  - Availability and Resiliency
  - Erasure Coding and Object Healing
  - Object Scanner
  - Site Replication and Failover
  - Thresholds and Limits
- Installation
  - Deployment Checklist
  - Deploy MinIO on Kubernetes
  - Deploy MinIO on Red Hat Linux
  - Deploy MinIO on Ubuntu Linux
  - Deploy MinIO for Development (MacOS, Windows, Container)
- Security and Encryption (Conceptual Overview)
  - Network Encryption (TLS) (Conceptual overview)
    - Enable Network Encryption using Single Domain
    - Enable Network Encryption using Multiple Domains
    - Enable Network Encryption using certmanager (Kubernetes only)
  - Data Encryption (SSE) (Conceptual overview)
    - Enable SSE using AIStor Key Management Server
    - Enable SSE using KES (Summary page + linkouts)
  - External Identity Management (Conceptual Overview)
    - Enable External Identity management using OpenID
    - Enable External Identity management using AD/LDAP
- Backup and Recovery
  - Create a Multi-Site Replication Configuration
  - Recovery after Hardware Failure
    - Recover after drive failure
    - Recover after node failure
    - Recover after site failure
- Monitoring and Alerts
  - Metrics and Alerting (v3 reference)
    - Monitoring and Alerting using Prometheus
    - Monitoring and Alerting using InfluxDB
    - Monitoring and Alerting using Grafana
    - Metrics V2 Reference
  - Publish Server and Audit Logs to External Services
  - MinIO Healthcheck API

The Administration, Developer, and Reference sections will remain as-is
for now.

http://192.241.195.202:9000/staging/singleplat/mindocs/index.html

# Goals

Maintaining multiple platforms is getting to be too much, and based on
analytics the actual number of users taking advantage of it is minimal.

Furthermore, the majority of traffic is to installation pages.

Therefore we're going to try to collapse back into a single MinIO Object
Storage product, and use simple navigation and on-page selectors to
handle Baremetal vs Kubernetes.

This may also help to eventually stage us to migrate to Hugo + Markdown

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Rushan <rushenn@minio.io>
Co-authored-by: rushenn <rushenn123@gmail.com>

2025-07-30 12:33:02 -04:00

4.1 KiB

Raw Blame History

Software Checklist

minio

Table of Contents

Use the following checklist when planning the software configuration for a production, distributed MinIO deployment.

MinIO Pre-requisites

`circle`	Servers running a Linux operating system with a 6.6+ kernel. Red Hat Enterprise Linux (RHEL) 10 or Ubuntu LTS 22.04.01+ ship with these Kernel's by default. Ensure the chosen OS uses LTS and in-support releases of a 6.6+ Linux kernel.
`circle`	A method to synchronize time servers across nodes, such as with `ntp`, `timedatectl` or `timesyncd`. The method to use varies by operating system. Check with your operating system's documentation for how to synchronize time with a time server.
`circle`	Disable system services that index, scan, or audit the filesystem, system-level calls, or kernel-level calls. These services can reduce performance due to resource contention or interception of MinIO operations. MinIO strongly recommends uninstalling or disabling the following services on hosts running MinIO: `mlocate` or `plocate` `updatedb` `auditd` Crowdstrike Falcon Antivirus software (`clamav`) The above list represents the most common services or softwares known to cause performance or behavioral issues with high performance systems like MinIO. Consider removing or disabling any other service or software which functions similarly to those listed above on MinIO hosts. Alternatively, configure these services to ignore or exclude the MinIO Server process and all drives or drive paths accessed by MinIO.
`circle`	System administrator access to the remote servers
`circle`	A management tool for distributed systems, such as Ansible, Terraform, or Kubernetes for orchestrated environments. Kubernetes infrastructures should use the MinIO Operator for best results.
`circle`	Load balancer to handle routing of requests (for example, NGINX)
`circle`	`Prometheus <minio-metrics-collect-using-prometheus>` or a Prometheus-compatible setup for monitoring and metrics
`circle`	`Grafana configured <minio-grafana>` for dashboards
`circle`	(optional) `mc` installed on the local host system

MinIO Install

Install a matching version of MinIO across all nodes in the deployment.

Post Install Tasks

`circle`	(optional) Create an `mc alias` for each server with `mc alias set` from your local machine for command line access to work with the MinIO deployment from a local machine
`circle`	Configure `Bucket replication <minio-bucket-replication-requirements>` to duplicate contents of a bucket to another bucket location
`circle`	Configure `Site replication <minio-site-replication-overview>` to synchronize contents of multiple dispersed data center locations
`circle`	Configure `Object retention rules with lifecycle management <minio-lifecycle-management>` to manage when objects should expire
`circle`	Configure `Object storage level rules with tiering <minio-lifecycle-management-tiering>` to move objects between hot, warm, and cold storage and maximize storage cost efficiencies

3rd Party Identity Provider Tasks

circle

Authenticate to MinIO with Security Token Service (STS) <minio-security-token-service>
Enabling this requires MinIO support.

4.1 KiB Raw Blame History