1
0
mirror of https://github.com/minio/docs.git synced 2025-09-14 20:09:30 +03:00

239 Commits

Author SHA1 Message Date
Nurzhan Zhanuzak
462bfcb46e Fix typos in mkdir command (#1497) 2025-09-04 15:57:00 -04:00
Daryl White
bc261ad8bb Updating links for new docs subdomain (#1494)
Docs have moved from min.io/docs to docs.min.io/commuinity.

This fixes hard, external links to use the new subdomain.

Note that some of these files are automatically pulled from elsewhere as
part of the build process, so some may not carry through even after this
PR merges.
2025-08-12 17:20:53 -04:00
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
Ravind Kumar
f778a58c70 Adding guidance around LDAP groups 2025-06-24 10:48:37 -04:00
Andrea Longo
bde954fcd8 fix prom example typo (#1474)
The `minio-job` example has `{job-"minio-job"}` where it should be
`{job="minio-job"}`

Corresponding changes in other repos/branches:
https://github.com/miniohq/aistor-object-store-docs/pull/70
https://github.com/miniohq/aistor-object-store-docs/pull/71
2025-06-06 12:39:28 -06:00
Ravind Kumar
f08b2d67aa Further removal of legacy console references 2025-06-04 16:51:51 -04:00
Allan Roger Reid
dffba7566f Recommend kernel 6.6 and greater (#1472)
Recommend kernel 6.6+ to include fix for fstrim performance

PTAL @klauspost @harshavardhana 

https://lore.kernel.org/all/20230903232923.211003-3-david@fromorbit.com/


89cfa89960

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2025-06-03 12:21:24 -04:00
Kim Hyunyoung, Abel
b7935b5139 fix typo in healing page (#1452) 2025-04-23 14:43:28 -04:00
Andrea Longo
d0be5e7d42 Software checklist: clarify kernel version requirements (#1455)
Prompted by a customer conversation. Not staged.

Matching `miniohq/aistor-object-store-docs` PR:
https://github.com/miniohq/aistor-object-store-docs/pull/41
2025-04-16 15:51:42 -06:00
Nicholas Simpkins
71405b0d5b Removed duplicate paragraph in network-encryption.rst (#1447)
Pretty self-explanatory. Removed back-to-back paragraphs that said the
exact same thing.
2025-04-04 09:51:33 -04:00
Daryl White
3298919df0 Corrects broken link to GitHub file (#1443)
Noted in internal discussion that the existing link resulted in a 404.
New link resolves.
2025-04-01 15:18:18 -04:00
Daryl White
292c604f47 Updates for mc RELEASE.2025-03-12T17-29-24Z (#1441)
- removes `--logs` flag from `mc support callhome`
- enforces 100 bucket limit for v2 metrics

Closes #1439

Opportunistic fix to remove errant copy/paste for
`--noncurrent-expire-days` flag in `mc ilm rule add`

Closes #1438
2025-04-01 15:04:32 -04:00
Daryl White
bbdedad170 Simplifying troubleshooting page and minimizing references to call home (#1431)
This commit removes lengthy discussion of SUBNET from the community
docs. Other affected pages that linked to removed sections also updated.

Also reduces references to Call Home to the remaining mc support pages
and links to those pages.
2025-03-07 12:29:50 -05:00
Daryl White
da87d38137 Updates for mc RELEASE.2025-02-04T04-57-50Z (#1427)
- Adds info for using absolute time on some mc find flags
- Adds --enc flag to mc support upload
- Fixes for thresholds page

Closes #1412
2025-02-21 12:15:41 -05:00
Ravind Kumar
265af648e2 Removing references to openshift container platform, bumping CRD (#1415)
# Summary

We removed support for deploying via OpenShift operatorhub / marketplace
a few months back. The burden of maintaining the certifications/process
required was sufficient to pull that feature set out moving forward and
migrate it to AIStor as part of a more complete enterprise offering.

For now we need to remove references to the operator hub / marketplace.
It is possible that the Openshift Kubernetes Engine may work w/ our
stock kubernetes installation paths, but we do not have resources to
test.

So for the immediate term, we're just going to pull whats outdated.

Also throwing in a fixup to the CRDs - I ran into a weird issue where I
had to `pip3 install asciidoc` before the sync-operator-crd-docs job
worked, am looking into that separately.

Staged:
http://192.241.195.202:9000/staging/openshift-fixup/openshift/index.html
2025-02-11 14:00:44 -05:00
Allan Roger Reid
22a6a3b562 Fix metrics typos (#1413)
#### Issue
Some minor typos found in the repo while working on metrics
2025-02-07 15:16:15 -05:00
Jennifer Rondeau
80cc97e88f fix example commands to export envvars for linux (#1409)
Fixes #1404 

Two sets of fixes:

- add conditionals for windows and linux where shared
- search/replace for linux only (MinIO Server reference pages)

Staging server not available, tested/checked locally
2025-02-07 11:25:34 -05:00
Daryl White
9ce1af6fdd Fixes command for upgrading a MinIO Tenant (#1406)
Closes #1403
2025-02-05 17:14:40 -05:00
Daryl White
919e47a778 Drop fstrim as a recommended software to remove or disable (#1396)
Per internal discussion.
`fstrim` has more benefits than concerns at this point.
2025-01-17 14:06:37 -05:00
Daryl White
9e7388cc9f Bug fixes for two issues (#1392)
## Tenant Namespaces

Adds information for unique tenant namespaces.

Closes #1391

## Changing erasure code parity

Adds information about changes to erasure code to MNMD deploys.

Closes #1365
2025-01-13 11:28:11 -05:00
Daryl White
5006f1f2b9 MC updates for two releases. (#1382)
- Adds mc support top rpc command
- Adds information about new mc support inspect file names

Closes #1361

- Updates healing color meaning.

Closes #1371
2024-12-06 12:33:39 -05:00
Andrea Longo
3458e72e40 Undeprecate v2 metrics (#1375)
Metrics version 2 is not dead. Continue to feature v3, but restore the
v2 info as an alternate version.

Out of scope: 
Updating the Prometheus and InfluxDB procedures. For now, note they are
v2 and deal with it in a separate PR.

Staged

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/operations/monitoring/metrics-and-alerts.html

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/reference/minio-mc-admin/mc-admin-prometheus.html
2024-12-05 08:19:18 -07:00
Daryl White
cfaedc843c Minor fixes for several smaller issues (#1380)
- Adds missing config settings throughout storage class page.
    
  Closes #1349
    
- Adds instructions for adding certificates for connecting by sftp.
    
  Closes #1354
    
- Corrects information about which key to use for self-signed CAs.
    
  Closes #1358
    
- Moves `context` to optional for batch key rotate jobs.
    
  Closes #1356

- clean up missing ref links causing build warnings.
2024-12-04 11:17:52 -05:00
Andrea Longo
48feb40740 Remove references to various ex MinIO Console features (#1373)
UI for the following has been removed from MinIO Console:

- Lifecycle and tiering
- Site replication
- SUBNET

Waiting for merge of https://github.com/minio/console/pull/3472

Staged:

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/minio-console.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/bucket-replication.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/operations/install-deploy-manage/multi-site-replication.html#id4


fixes https://github.com/minio/docs/issues/1372

---------

Co-authored-by: Jennifer Rondeau <Bradamant3@users.noreply.github.com>
2024-11-26 14:17:12 -07:00
Ravind Kumar
2208266161 Update expand-minio-deployment.rst (#1363)
drive by typo
2024-11-07 10:27:26 -05:00
Daryl White
b79934f11d Bug fixes for two issues related to LDAP and site replication (#1348)
Corrects docs to state that when expanding a site replication peer set,
you must list all existing peers.

Closes #1340 

Adds information that when adding Distinguished Names as search
parameters, multiple DNs must be separated with a semi-colon.

Closes #1341
2024-10-10 16:22:00 -04:00
Jennifer Rondeau
d8fd984346 Explain limitations with multi-part uploads, move other unsupported/limitations content (#1345)
- Explains requirements for `ListMultipartUploads`
- Notes that `AbortIncompleteMultipartUploads` is not supported with
`PutBucketLifecycle`

This approach does not provide all the detail in the original ticket,
because we don't do so for other operations/actions.

Also moved content about bucket operations limitations from thresholds
and limits page to S3 compatibility page. Took some suggestions from
discussion in ticket.

Closes #1216 

Staging:

[Differences from S3 APIs for Multipart
Uploads](http://192.241.195.202:9000/staging/DOC-1216/linux/reference/s3-api-compatibility.html#id5)
[MinIO alternatives for unsupported Bucket
resources](http://192.241.195.202:9000/staging/DOC-1216/linux/reference/s3-api-compatibility.html#id12)
To check that content is moved: [Thresholds and
Limits](http://192.241.195.202:9000/staging/DOC-1216/linux/operations/concepts/thresholds.html)
2024-10-08 13:19:16 -04:00
Daryl White
ca34aa7e43 Add cert-manager documentation (#1317)
Adds cert-manager docs for Kubernetes outputs.

Closes #1245 

Partially addresses #1273
2024-10-01 16:06:37 -04:00
Ravind Kumar
3f9a46bcbe Update upgrade-minio-operator.rst 2024-10-01 15:30:35 -04:00
Daryl White
008cd9acba Drive by fix noted by end user (#1308)
Just a quick change to replace "two" with the "three" it was supposed to
be.
2024-08-27 16:46:32 -04:00
Ravind Kumar
76e5e35ab3 DOCS-1191: Updating SSE params, general fixups (#1295)
Closes #1191 

# Summary

Finally getting around to this mc release

- Added docs for enc-c, enc-s3, enc-kms
- Some docs are making assumptions around behavior that needs to be
fixed _first_
- Drive-by linker fixes

Staged: http://192.241.195.202:9000/staging/DOCS-1191/linux/index.html

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-08-26 11:54:49 -04:00
Daryl White
c37ff313cb Updating legacy k8s upgrade doc (#1305)
The legacy upgrade doc had some unclear and confusing references in the
upgrade path. This updates the upgrade chart on the page to include
latest stable. Fixes references to 6.0.2 that should have been 5.0.15.

Not tied to a docs issue.

Staged:

- [Legacy upgrade
doc](http://192.241.195.202:9000/staging/k8s-update/k8s/operations/install-deploy-manage/upgrade-minio-operator-4.5.7-earlier.html#minio-k8s-upgrade-minio-operator-to-5-0-15)
2024-08-23 22:46:30 -04:00
Daryl White
08f2da3343 Changes for MinIO Server releases (#1302)
- Updates references for licensing to use "Enterprise" branding
- Updates the mc idp ldap policy entities command with flags and changes
to groups
- Deprecates OpenID envvar

Closes #1271
2024-08-21 14:18:33 -04:00
Ravind Kumar
b05ae61a55 DOCS-1291: Removing trailing operator console references, fixing broken refs (#1292)
Closes #1291 

Missed a few log lines referencing Operator Console.

Also cleaning up some broken refs and further simplifying references to
the Console when in context of Tenant/MinIO Object Store.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-08-05 16:06:55 -04:00
Andrea Longo
343e54d402 Metrics v3 (#1289)
Add metrics v3 to the Metrics and Alerts page and other relevant
locations, deprecate metrics v2.

- Updated the metrics extract script to parse the [list of v3 metrics
from
GitHub](https://github.com/minio/minio/blob/master/docs/metrics/v3.md).
- Remove references to MinIO Console metrics.
- Make `:mc-release:` show friendly release name text like
`:minio-release:` does.

Staged:

Linux

http://192.241.195.202:9000/staging/DOCS-1266/linux/operations/monitoring/metrics-and-alerts.html

k8s

http://192.241.195.202:9000/staging/DOCS-1266/k8s/operations/monitoring/metrics-and-alerts.html

fixes https://github.com/minio/docs/issues/1266
2024-08-02 17:58:59 -06:00
Ravind Kumar
23253dd71c DOCS-1273: Operator 6.0.0 Deploy/Upgrade docs, removing Console references (#1284)
Addresses #1273 

# Summary

This pass does three things:

1. Updates all tutorials related to Operator/Tenant deployment for
Kustomize and Helm
2. Removes references to Operator Console + updates to reference
Kustomize/Helm wherever possible
3. Slightly tidies up old or dangling references

This pass does not do these things:

- Link out heavily to Kubernetes docs (for later)
- Clean up organization (singleplat build handles this)
- Addresses OpenShift, Rancher, etc.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Allan Roger Reid <allanrogerreid@gmail.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-08-01 15:51:39 -04:00
Ravind Kumar
7ffa8b61b2 Fixing build error 2024-07-12 20:21:03 -04:00
Ravind Kumar
aa7bb5802c Apply suggestions from code review
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-07-12 16:20:46 -07:00
Ravind Kumar
5173a10569 Update software.rst 2024-07-12 16:20:46 -07:00
Andrea Longo
511aa87da4 Clarify pool ordering for add after decom (#1267)
If you decommission one pool from a multiple pool deployment, you can't
reuse the same node (hostname) sequence for a new pool. If you are using
expansion notation to define a set of hostnames for the pool, each new
pool must continue the numerical sequence even if some pools were
decommissioned along the way.


Staged

linux

http://192.241.195.202:9000/staging/DOCS-1250/linux/operations/concepts.html#can-i-change-the-size-of-an-existing-minio-deployment

k8s

http://192.241.195.202:9000/staging/DOCS-1250/k8s/operations/install-deploy-manage/modify-minio-tenant.html#decommission-a-tenant-server-pool

Fixes https://github.com/minio/docs/issues/1250
2024-07-11 16:08:58 -06:00
Andrea Longo
62124720a5 fix ref typos for mc admin prometheus generate (#1268)
Fix broken refs that were causing build warnings on some platforms. Not
staged.
2024-07-11 15:55:32 -06:00
Andrea Longo
e75fcbce65 typo in grafana.rst (#1261)
Quick grammar fix for the list of Grafana dashboards.

Not staged.
2024-07-08 14:04:19 -06:00
Andrea Longo
7c4261d99f broken refs from DOCS-1255 (#1257)
Sphinx why u no warn _before_ merge??

cf. https://github.com/minio/docs/pull/1256
2024-06-28 14:01:11 -06:00
Andrea Longo
df011dc263 Can't resize server pools (#1246)
Explicitly note in the concepts page that you can't change the size of a
server pool after it's created.

Not staged
2024-06-12 15:56:23 -06:00
Andrea Longo
b173e7bb6e Fix build warnings for Operator pages (#1238)
Fix build warnings from https://github.com/minio/docs/pull/1219 

Some are broken refs that need to point elsewhere.

Some are because `openshift`, `eks`, `gke`, `aks` can't see a target
that's on a `k8s` page, apparently due to how
`operations/installation.rst` is structured. These we are still
investigating.
2024-06-07 13:37:24 -06:00
Andrea Longo
d17c896f75 attempt to remove plugin from docs (#1219)
The Kubernetes plugin is gone, this PR replaces the procedures that use
`kubectl minio` in all its various forms. The plugin was referenced on
many pages and for many purposes so there is _a lot_ of restructuring
involved.

Some procedures no longer have CLI instructions, which can be addressed
in subsequent PRs. Everything should have at least one working method,
even if it's to use Operator Console.

- Remove references to plugin, except for pre-4.5.8 upgrade paths
- Move pre-4.5.8 upgrade paths to new child page (currently hidden from
TOC, linked in page)
- Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:
- [Operator
deploy](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/installation.html)
- [Operator
upgrade](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/install-deploy-manage/upgrade-minio-operator.html)
- [Deploy and manage
Tenants](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/deploy-manage-tenants.html)

Fixes https://github.com/minio/docs/issues/1213
2024-06-07 09:05:39 -06:00
Daryl White
52e66839f1 Updates for MinIO Server 2024-05-10 release (#1234)
Updates for MinIO Server RELEASE.2024-05-10T01-41-38Z
    
- Removes references to `MINIO_SERVER_URL` envvar.
- Updates KMS and KES related envvar settings to add KMS as an option.
- Also differentiates KMS and KES related envvar into three groups,
which are mutually exclusive.
    
Closes #1214
2024-06-06 17:33:02 -04:00
Andrea Longo
b422c71bd9 Change scrape_interval in metrics scraping example (#1231)
The examples show `15s`, which is too short for a typical deployment.
`60s` is recommended. Also note that this value may need to be increased
if there are too many metrics to collect in the specified amount of
time. Each scraping operation should complete before the next begins.

Staged

http://192.241.195.202:9000/staging/scrape_interval/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html#generate-the-scrape-configuration
2024-06-05 16:49:58 -06:00
Daryl White
c407fec6ed Adds erasure code video to doc (#1230)
Added EC video as a recommended video in the right nav on the EC
overview page.

Closes #1228
2024-05-29 16:23:27 -04:00
Andrea Longo
1933043f7e quote the kubectl apply -k command (#1217)
By request, for readability and also apparently it will then work on
other platforms too.

---------

Co-authored-by: Ramon de Klein <mail@ramondeklein.nl>
2024-05-15 14:00:28 -06:00