1
0
mirror of https://github.com/minio/docs.git synced 2025-11-03 05:13:12 +03:00
Commit Graph

780 Commits

Author SHA1 Message Date
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
Rushan
d9d1532d9d Update docs menu to accommodate lengthy content (#1367)
…ntent.
2024-11-13 10:29:04 -05:00
Rushan
7bef83f94b Center align search and title 2024-11-13 06:01:42 -08:00
Rushan
2470e96a7e Comment dark and read mode 2024-11-13 06:01:42 -08:00
Rushan
5757f1acf5 Update base theme to match the new website 2024-11-13 06:01:42 -08:00
Ravind Kumar
2208266161 Update expand-minio-deployment.rst (#1363)
drive by typo
2024-11-07 10:27:26 -05: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
Ravind Kumar
f3f32063ce Remove outdated reference 2024-10-25 10:55:04 -04: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
Rushan
9c80a0e89f Fix non .docutils table styles (#1343)
As @pavelanni pointed out, some tables, like the ones shown below, had
broken styling that didn't align with the [design
specs](https://min.io/docs/minio/kubernetes/upstream/design.html#list-table).
This PR resolves the issue by applying the correct styles to ensure
consistency with the overall design guidelines.

**Issue:** 


https://min.io/docs/minio/kubernetes/upstream/reference/operator-crd.html#customcertificateconfig

<img width="783" alt="Screenshot 2024-10-08 at 14 26 17"
src="https://github.com/user-attachments/assets/cdb8ff3e-2ace-4bf4-9b43-6dceccb0d2ae">


**Fix:**
<img width="783" alt="Screenshot 2024-10-08 at 15 19 20"
src="https://github.com/user-attachments/assets/6306cdd7-7d19-4452-a109-03328b43128d">
2024-10-08 11:55:12 -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
Jennifer Rondeau
fd2a339d48 Correct instructions for single-node single-drive deploy on linux (#1338)
Common include for single-node deployments describes multi-drive, which
is wrong for single-drive. Replaced include with inline content that
specifies only a single drive everywhere.

Incidentally fixed list indentation in override, copied fix into include
as well.

Fixes: 

https://github.com/minio/docs/issues/1330

Staged:

[Deploy MinIO: Single-Node
Single-Drive](http://192.241.195.202:9000/staging/DOC-1330/linux/operations/install-deploy-manage/deploy-minio-single-node-single-drive.html)

(edited include not available to review on staging -- applies to macos
or docker/container -- but checked locally)
2024-10-04 13:40:40 -04:00
Daryl White
56ecef97b2 Fix for bucket event limits (#1337)
- Updates information on limits related to events.
- Adds cert-manager pages to URL-excludes file for non-k8s builds

Closes #1313
2024-10-03 17:29:59 -04:00
Daryl White
36f5bea8ea Updating encryption pages for KES API (#1333)
Our preferred method for authenticating from MinIO to KES is with an API
identity. This PR updates encryption docs to reflect this.

Closes #1280
2024-10-03 12:38:10 -04:00