1
0
mirror of https://github.com/minio/docs.git synced 2025-08-08 01:43:18 +03:00

348 Commits

Author SHA1 Message Date
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
Ravind Kumar
f08b2d67aa Further removal of legacy console references 2025-06-04 16:51:51 -04:00
Ravind Kumar
d48cb3e006 Adding admonition for static KMS key 2025-04-24 13:55:30 -04:00
Daryl White
8969abda18 Removes some erroneous config options for webhook (#1444)
Closes #1434

These config options were likely a copy/paste error from other target types.
Refer to
https://github.com/minio/minio/blob/master/internal/event/target/webhook.go#L64-L73
for the correct list.
This update matches that code.
2025-04-01 15:32:11 -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
Mohamed Ahmed Fahmi
5c927e02c8 docs: fixed the format for --older-than parameter in mc-rm (#1437)
The format for--older-than parameter in the docs was #d#hh#mm#ss which
cannot be parsed when used, the correct format is #d#h#m#s
2025-03-27 10:10:35 -04:00
Andriy Utkin
fa92793112 mc-admin: Fix intro wording (#1432)
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2025-03-11 14:13:51 -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
Allan Roger Reid
942f1745a0 Remove documentation references to _MINIO_BATCH_REPLICATION_WORKERS (#1423)
Hidden env var `_MINIO_BATCH_REPLICATION_WORKERS` is being referred to
in documentation. It needs to be either:
- removed as a hidden variable
- renamed with a leading `_`
- enabled as a regular variable in ~`minio`~ and `eos`, without a
leading `_`

See example the files referred to in the PR and
39df134204/cmd/batch-handlers.go (L398)

Pending review and discussion with @harshavardhana and @poornas 

This PR removes documentation references to this variable.
2025-03-05 08:35:28 -07:00
Andrea Longo
162c5ea6cd Add info for Object Lambda via configuration settings (#1428)
Thank you to @wdinyes for noticing you can configure Object Lambda this
way. New text is not super comprehensive, but hopefully enough to guide
someone in the correct direction. My understanding is not too many
people are using Object Lambda right now.

Staged:

http://192.241.195.202:9000/staging/DOCS-1400/linux/reference/minio-server/settings/object-lambda.html

Fixes https://github.com/minio/docs/issues/1400
2025-02-21 15:28:40 -07: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
Daryl White
89bc282e41 noncurrent-trasition-days can accept 0 (#1422)
If the target transition tier is another MinIO deployment, the days
value can be `0`.
2025-02-19 15:29:34 -05:00
Daryl White
4680c16e5e Adds note about setting transition-days flag to 0 (#1420)
Only applicable for remote tiers that are also MinIO deployments. 
Per internal discussion.

Need to verify if this applies to the `edit` command and the
`noncurrent-transition-days` flags.
2025-02-18 19:47:21 -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
f54d1425de Deprecates logs for mc support callhome (#1395)
SUBNET no longer supports the uploading of logs.
The flags still exist in the MinIO Client, but no longer function.

Opportunistic fix to clarify that s3v4 is a signature type, not an API.

No issue to link.
2025-01-17 11:55:41 -05:00
Daryl White
801bd33b7d Adds info that MC_HOST envvar uses s3v4 api (#1393)
Closes #1379

Not staged.
2025-01-14 12:34:29 -05:00
Ravind Kumar
fff6e87c03 Fixing incorrect duration unit for mc admin accesskey 2024-12-31 11:15:08 -05:00
xiemingxun
2514f0ab97 Update redis.rst (#1390)
MINIO_NOTIFY_REDIS_REDIS_ADDRESS_PRIMARY =>
MINIO_NOTIFY_REDIS_ADDRESS_PRIMARY
2024-12-23 09:46:01 -05:00
Daryl White
f2cbd2ffe5 Removes examples to expire all versions with delete marker (#1388)
This functionality was never fully implemented and will not be
implemented.

Closes #1383
2024-12-13 10:49:52 -05:00
Ravind Kumar
5adf2e066a DOCS-1386: Undeprecating mc license update (#1387)
Closes #1386 

# Summary

`mc license update` was mistakenly marked as deprecated.

This adds it back to the main reference.

Staged:
http://192.241.195.202:9000/staging/DOCS-1386/linux/reference/minio-mc/mc-license.html
2024-12-13 10:48:58 -05:00
Allan Roger Reid
282f902c02 Fix mismatching command examples (#1385)
Fix mismatching command examples
2024-12-13 10:31:24 -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
Julian
fdeadb4f06 added missing prefix to DISABLE_PAGER (#1378)
fixes #1377
2024-12-02 11:05:44 -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
Daryl White
127215c229 Adds information about changes to ILM deletes (#1359)
- New option with JSON to expire all versions of an object with a delete
marker.
- Changes `mc ilm rule` subcommand flags `--expire-all-object-versions`
to note that only applies to objects without a delete marker.

Closes #1201
2024-10-29 15:23:14 -04:00
Andrea Longo
0747c9a191 mention that tiny files are not compressed, also other typos (#1357)
Came up in a customer issue. Specifically the threshold is 4 kb and
there is no configuration option. (Nor does Klaus want one.)

Worth adding? With how much detail? The threshold choice is because of
typical block size on disk. You will use at least that much anyway so
why bother compressing.

Staged:


http://192.241.195.202:9000/staging/dont-compress-small-objects/linux/administration/object-management/data-compression.html#excluded-file-types

Drive-by fix tacked onto this PR: correct typos in some `mc anonymous`
examples.

Staged:

http://192.241.195.202:9000/staging/dont-compress-small-objects/linux/reference/minio-mc/mc-anonymous.html

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Ravind Kumar <ravind@min.io>
2024-10-25 14:52:33 -06:00
Daryl White
af3d8aba9f Updates for two October 2024 releases (#1353)
Deprecates a no longer used operator environment variable.

Closes #1351

Adds `mc admin accesskey` and subcommands.
Updates `mc admin user svcacct` and subcommands with reference to new
commands.

Closes #1350
2024-10-22 16:32:42 -04: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
Daryl White
0556337429 Adds part-number flag to mc cat (#1347)
Closes #1307
2024-10-09 16:10:09 -04:00
Daryl White
07a1569e87 Adds language about having write permission to use mc admin update (#1346)
Closes #1301

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-10-09 11:04:26 -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
8f9a1ff466 Updates mc event rm for mismatched event error (#1344)
- Cleans up `mc event` command flags with optional/required labels. 
- Drive by fix for an `mc idp` command with an `end-before` include
error.

Closes #1263
2024-10-08 13:07:04 -04:00
Daryl White
8da7c7d94c Adds mc admin scanner to reference docs (#1332)
Closes #1304
2024-10-08 11:55:48 -04:00
Daryl White
8ad71d4a5b Updates for mc RELEASE.2024-10-02T08-27-28Z (#1339)
- Adds a `--checksum` flag to `mc cp`, `mc mirror`, `mc pipe`, and `mc
put`
- Adds `--disable-multipart` to `mc put`
- Adds alias name to outputs of `mc ready`
- Adds flags to `mc admin heal`

Closes #1334
2024-10-04 13:56:07 -04:00
Daryl White
79cf400125 Updates for the 2024-09-09 releases of the server and mc (#1331)
- adds new config options for webhook events
- adds new subcommands to mc idp ldap accesskey
- adds info about new output during iam import

Closes #1316
2024-09-23 15:29:29 -04:00
Ruben Laguna
9171ccc58f Mention Invalid Login error on MINIO_SERVER_URL (#1312)
The MinIO Console currently does not warn the user if the MinIO server
is not reachable. MinIO Console will just say "Invalid Login" when the
MINIO_SERVER_URL is not reachable which is misleading in the sense that
will make think most people that the username/password/access key is
incorrect so I think it should be mentioned in the documentation that
Invalid Login could be just due to connectivity between console and
server.

Related to https://github.com/minio/console/issues/3428 and
https://github.com/minio/console/issues/3427

@marktheunissen

---------

Co-authored-by: Ruben Laguna <ruben.laguna@tele2.com>
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2024-09-23 15:09:28 -04:00
Daryl White
c67d446bac Minor fixes to address multiple small issues (#1326)
A few quick fixes noted in several issues:

- Literal reference in mc batch generate pointed to the wrong include
   Closes #1318 
- Lingering reference to an "unregister" function removed
  Closes #1324
- Adds admonition about root credentials required, even with KES
  Closes #1325 
- Adds mc batch cancel to list of commands on batch framework overview
page
   Closes #1310
- Updates mc client page S3 link to avoid possible copy/paste confusion
  Closes #1311
2024-09-20 11:25:14 -04:00
Daryl White
1e64bf8f6b Updates for mc RELEASE.2024-09-16T17-43-14Z (#1319)
- Adds new `--output` flag to `mc admin cluster iam export`
- Corrects encryption flags for `mc mv` command noted during build

Does not track a docs issue.
2024-09-16 16:59:31 -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
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
Daryl White
31367cf36c Updates for mc mirror parameters (#1300)
Closes #1270

- Adds some missing parameters to the syntax list.
- Adds the `--active-active` parameter.
2024-08-16 15:20:04 -04:00
Daryl White
f27c16f30a Updates for MinIO Server and MC releases on 2024-07-03/04 (#1299)
- Adds info about tracking batch job status for completed jobs
- Deprecates `mc license update`
- Adds flags for updating Azure credentials in `mc ilm tier update`

Closes #1260
2024-08-15 17:12:18 -04:00
Daryl White
f7c397c636 Changes for two mc releases (#1296)
[`RELEASE.2024-07-31T15-58-33Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-07-31T15-58-33Z)

- adds new flags to `mc idp ldap accesskey list`


[`RELEASE.2024-08-13T05-33-17Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-08-13T05-33-17Z)

- adds new flags to `mc stat`
- adds new global flag for custom DNS mapping

Does not track an outstanding docs issue.
2024-08-15 11:57:56 -04:00
Andrea Longo
5865c3b93d deprecate mc quota (#1294)
Bucket quotas don't work the way people think they work, as they cannot
enforce hard limits. Deprecate in docs while we sort out what to do with
the commands.

The future replacement is MinIO Enterprise Catalog.

Staged:

http://192.241.195.202:9000/staging/deprecate-bucket-quota/linux/reference/minio-mc-deprecated.html

See:
https://github.com/minio/mc/pull/5011
https://github.com/minio/mc/pull/5012
2024-08-08 14:58:54 -06:00
Pavel Anni
7722414e1b DOCS-1287: fix broken links to ARN reference (#1288)
Change broken links to ARN reference to
`<IAM/latest/UserGuide/reference-arns>`

Co-authored-by: Pavel Anni <pavel@minio.io>
2024-07-30 12:03:18 -04:00
Andrea Longo
63e44aff1c additional feedback for mc stat examples (#1286)
More improvements to `mc stat` examples following
https://github.com/minio/docs/pull/1285

Staged:

http://192.241.195.202:9000/staging/mc-stat-example-2/linux/reference/minio-mc/mc-stat.html#examples
2024-07-26 16:31:02 -06:00
Andrea Longo
daa7f32d59 add better examples to mc stat page (#1285)
Replace the abstract examples on the `mc stat` page with some that show
meaningful output. Including how to get the count of objects in a
bucket. Opportunistically update text flow throughout.

Staged:

http://192.241.195.202:9000/staging/mc-stat-example/linux/reference/minio-mc/mc-stat.html

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-07-26 14:39:41 -06:00