1
0
mirror of https://github.com/minio/docs.git synced 2025-04-19 21:02:14 +03:00

800 Commits

Author SHA1 Message Date
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
Rushan
15a5c34a2a
Fix table white-space behavior (#1450)
Fixes https://github.com/minio/docs/issues/1449

**Fix:**

![Screenshot 2025-04-09 at 1 10
18 PM](https://github.com/user-attachments/assets/fad45b2d-60d2-4997-aeb5-613619383e23)
2025-04-09 10:40:28 -04:00
Daryl White
01c32ace46
Add section for supported KMS actions (#1448)
Adds section to the policy based access control page for supported KMS
action keys.
Refers two existing kms related keys to the preferred `kms:` keys.

Closes #1283
2025-04-04 15:37:52 -04: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
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
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
Sinscerly
b9f77cb5c3
Missing part of command in Object Versioning documentation (#1433)
Now there is standing: `mc version ALIAS/BUCKET` but it should be `mc
version enable ALIAS/BUCKET`

the `enable` part in the command example is missing
2025-03-27 10:14:48 -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
Ravind Kumar
7732ef45c7 one more drive by fix 2025-02-25 17:33:53 -05:00
Ravind Kumar
97c35f87b9 Removing mention of Apple M1/M2 on Linux ARM instructions 2025-02-25 17:26:04 -05: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
65df48e1c9
There is no v2 batch api (#1429) 2025-02-21 15:59:07 -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
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
Ravind Kumar
51d5f9c215 fixup to redhat ocp support language 2025-02-18 18:50:36 -05:00
Allan Roger Reid
2208441e31
Specify RFC3339 and not ISO-8601 data and time (#1419)
MinIO uses RFC3339 data and time formatting and not ISO-8601. RFC3339
requires that there be a `T` as part of the data and time separation.
ISO-8601 allows a space.
The documentation also currently refers to using a date in the batch
framework; this should be a RFC3339 date and time.
e.g.
```
mc batch start play expire.yaml
mc: <ERROR> Unable to start job. We encountered an internal error, please try again.: cause(parsing time "2006-01-02 15:04:05.00Z" as "2006-01-02T15:04:05Z07:00": cannot parse " 15:04:05.00Z" as "T").

```

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2025-02-18 14:25:57 -05:00
Daryl White
9b4839fdd0
Removes lingering references to DelMarkerObjectExpiration (#1418)
Some references were removed in #1388 in the `mc ilm` docs, but these
references remained.
2025-02-14 16:16:58 -05:00
Jennifer Rondeau
340444e205
correct parent flag for mkdir in installation content (#1417)
Flag is lower case, not upper case.

Caught while testing

Not (manually) staged.
2025-02-13 11:22:52 -05:00
Allan Roger Reid
d6ae738e87
Add batch replication specific actions to source user policy (#1414)
#### Issue
Batch replication requires specific actions to be performable by the
source user, including:
```
  "admin:ListBatchJobs",
  "admin:DescribeBatchJob",
  "admin:StartBatchJob",
  "admin:CancelBatchJob"
```
This PR suggests them in the batch replication example provided in the
docs.

@poornas Please correct me if needed. This allowed the documentation to
be followed smoothly, with a resultant successful batch replication job
being spawned.
2025-02-12 07:33:07 -07:00
Andrea Longo
90e47e5425
Add schema and example to bucket notification page (#1410)
The page with the event type detail seemed an ok place to put this.
Suggestions for other/additional locations welcome.

Tested on AIStor + EOS with an outbound webhook to an external service.
Since I had a live example, I included it in the page as well.

Fixes https://github.com/minio/docs/issues/1394
2025-02-11 15:19:38 -07: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
Daryl White
b68915278c
Install page quickstarts generated multiple H1s (#1411)
Include files for quickstarts had a page title that resulted in a
duplicate H1. This removes the duplicate and moves the links for video
to the index.rst page.

Opportunity fix of an unrelated build error.

Closes #1408
2025-02-07 11:26:50 -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
Rushan
1537ccfec8
Remove font ligatures settings (#1407)
Fixes https://github.com/minio/docs/issues/1405
2025-02-06 10:46:10 -05:00
Daryl White
9ce1af6fdd
Fixes command for upgrading a MinIO Tenant (#1406)
Closes #1403
2025-02-05 17:14:40 -05:00
Ravind Kumar
0dc9df6e2a
Update top-navigation.html (#1402)
Looks like this URL is broken - I think this should fix it.
2025-02-03 12:54:38 -05:00
Daryl White
3fd12ad26e
Correct upgrade command (#1401)
Per internal discussion, the command to update MinIO in an airgapped
environment should point to `minio.sha256sum`.
2025-01-30 08:38:29 -05:00
Andrea Longo
baafa4f80a
Clarify additional MinIO Console options available using mc (#1399)
Add a clearer callout to `mc` for features not/no longer available in
MinIO Console.

Given that several things were removed, enumerating specific commands
seems impractical? Opinions solicited.

From a community issue: https://github.com/minio/console/issues/3498

Not yet staged.

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2025-01-28 10:30:53 -07: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
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
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
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
Allan Roger Reid
c9db0b63e5
Update common-installation.rst (#1389)
See https://miniohq.slack.com/archives/C03VDE2R9ED/p1734487467518789

The admonition in
https://min.io/docs/minio/linux/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#storage-requirements
should read:
`MinIO limits the size used per drive to the smallest drive in the
pool.`
instead of
`MinIO limits the size used per drive to the smallest drive in the
deployment.`
2024-12-18 07:44:49 -07: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
Guillaume Michaud
0b1d9a7751
Fix console port number (#1370) 2024-11-20 16:57:18 -05:00