1
0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00

165 Commits

Author SHA1 Message Date
ef4faab6d8 Fixes for missing or bugs in the custom token STS docs (#1479)
- Adds that `idmp-` string is added to `ROLE_ID` when generating an ARN
- Updates claims example in the plugin docs to be JSON instead of basic
comma-delimited key-value pairs
2025-07-06 15:43:45 -04:00
f08b2d67aa Further removal of legacy console references 2025-06-04 16:51:51 -04:00
522ccf4c33 copy conflicting object text from thresholds page (#1473)
Add the conflicting objects info from the thresholds page to object
management, where someone might actually find it. Did not make it an
include.

cc @klauspost 

Related changes:
`miniohq/aistor-object-store-docs`:
https://github.com/miniohq/aistor-object-store-docs/pull/66

`miniohq/aistor-object-store-docs/hugo-migration`:
https://github.com/miniohq/aistor-object-store-docs/pull/65
2025-06-03 14:53:57 -04:00
6da905b25d quick cleanup of legacy console docs' 2025-05-27 17:56:37 -04:00
71b42c32da Clarify the effect of a write operation on versioning (#1468)
All write operations, mutation or not, result in a new version of that
object with a unique version ID.
2025-05-27 11:10:18 -04:00
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
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
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
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
65df48e1c9 There is no v2 batch api (#1429) 2025-02-21 15:59:07 -05:00
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
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
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
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
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
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
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
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
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
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
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
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
b8a62baa90 Fixing links to videos missing a : (#1321)
Found a few more links for videos missing a `:` after the `http`.
This fixes those.
2024-09-17 10:05:24 -04:00
5f5fc42530 Fix the recommended video URLs on the Object Locking page (#1320) 2024-09-17 10:01:34 -04:00
af6811de3a Update data-compression.rst
Fixing typo
2024-09-13 13:38:24 -04:00
d87eb665c9 COMPLIANCE functionally equiv to S3 COMPLIANCE mode (#1309)
This seems to be a copy error, based on my comparison of the COMPLIANCE
LOCK and S3's Compliance mode (vs S3's Governance mode).

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-08-28 16:54:40 -04:00
11a3bd8ae9 Make port numbers consistent in the port assignment chapter (#1306) 2024-08-23 17:33:49 -04:00
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
762b942009 Changes for MinIO Server RELEASE.2024-08-03T04-33-23Z (#1297)
MinIO Server
[RELEASE.2024-08-03T04-33-23Z](https://github.com/minio/minio/releases/tag/RELEASE.2024-08-03T04-33-23Z)
adds a v2 for the batch job replicate API.

This new version supports including multiple prefixes on the source for
replication.

Not linked to a docs issue.
2024-08-14 17:32:09 -04:00
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
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
848b5b7d34 Updates for mc RELEASE.2024-06-20T14-50-54Z (#1279)
Updates for mc release 2024-06-20T14-50-54Z
    
- Adds info about requiring Raw Base64 or Hex keys
- Updates links for KES docs on encryption pages
- Updates encryption pages to use ventilated prose (one sentence per
line)
- Adds new flag for `mc get`
- Updates `mc put` with enc-# flags
    
Closes #1253
2024-07-25 12:31:28 -04:00
684217cdf9 Minor fixes for remote storage names (#1275)
Swapping `_` for `-` in remote class names for S3.
2024-07-22 08:22:58 -04:00
0c5dc28687 MinIO removed the version limit in a prior version (#1244)
This removes references to version limits and suggests using object
expiration rules to manage unneeded noncurrent versions.

There is no doc issue to track this.
2024-06-13 10:37:37 -04:00
fa8c73d584 Updates for server and mc releases on 2024-06-10 (#1243)
For mc RELEASE.2024-06-10T16-44-16Z

- Updates `mc admin info` to add the `--offline` flag

For MinIO Server RELEASE.2024-06-11T03-13-30Z

- Adds to note to object management page about avoiding the `:`
character on Windows
- Adds info that directory objects (0-byte, end in `/`) do not tier

These releases do not have doc repo issues to track them.
2024-06-11 16:32:40 -04:00
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
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
76b5bb0333 Adds information about tiering rules and exclusive access (#1220)
Adds info to the object management page.
Does not restructure the docs at this time.

Partially addresses #1207
2024-05-22 13:57:37 -04:00
9374fb56e4 Aggregate information on deleting objects (#1218)
Creates a new object management page to aggregate information on
deleting objects.
Links to the page from other docs throughout.

Intentionally leaves most delete information where it is in existing
docs.
    
Closes #741
2024-05-17 16:28:45 -04:00
775e99d47b DOCS-1190: RELEASE.2024-04-18T19-09-19Z (#1215)
Partially addresses #1190 

No staged build unless someone requests it.

# Summary

After some thinking, we've leaned towards just making a note of the
upgrade step and calling it done. We do not typically make extended
discussion of backward-breaking changes at this time, and have no where
to keep that sort of guidance.

Maybe in the future or as part of a larger re-arch we can consider where
we would best keep that kind of guidance.

As far as the rest:

- We are not covering s3zip today, so that's a no-op. We should leave
the ticket open in the event we have bandwidth to document the feature
later
- No changes to Console that need documentation at this time
- Added a quick callout on the warning behavior to the Versioning page
- Metrics v3 is also still In progress, come back to this once the
project is fully baked.
2024-05-10 18:16:49 -04:00
2953b54ecd correct NATS endpoint syntax (#1212)
NATS endpoints should be specified with hostname and port, not a URL. 

Staged

http://192.241.195.202:9000/staging/nats-endpoint-fix/linux/reference/minio-server/settings/notifications/nats.html

http://192.241.195.202:9000/staging/nats-endpoint-fix/linux/administration/monitoring/publish-events-to-nats.html

Fixes https://github.com/miniohq/engineering/issues/1966
2024-05-10 07:36:52 -06:00
9c8c089342 FIXUP: Existing object replication is on by default (#1206)
# Summary

We some time ago updated bucket replication to perform existing object
replication by default. Not entirely sure when, but long enough that we
can just make the change.

Also fixed one out-of-band syntax error.

# Staged


http://192.241.195.202:9000/staging/REPLFIX/linux/administration/bucket-replication.html#replication-of-existing-objects
2024-05-07 20:41:32 -04:00
7be620fd13 Deprecates the long-dead mc admin console command (#1204)
Corrects most references to point to the current command.

Additional references to deprecated command fixed by PR #1198 .
We should merge 1198 at the same time we merge this one.
2024-05-06 14:30:36 -04:00
96224468c4 Add concept pages for Scanner and Healing (#1192)
Adds concept pages for healing and the scanner.
Updates other related files for better context.
    
Adds ref links and other related updates.
    
Closes #1168
2024-04-25 14:27:25 -04:00
c676da2376 Adds an admonition for exclusive drive access (#1196)
Admonition added as an include, then put in many files throughout the
docs.
Where it is included, it's the same admonition and text.

It's worth making sure where I placed the include makes sense.

Closes #1186
2024-04-25 14:19:30 -04:00
e71bbe9040 Quick Fix: KES Guidance (#1187)
We already state on one page that you cannot undo KES once configured.

This ensures we make that statement on all other relevant pages.

Staged:

-
http://192.241.195.202:9000/staging/QUICKFIX/linux/operations/server-side-encryption.html
- SSE-KMS and SSE-S3 tabs
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/operations/server-side-encryption/configure-minio-kes.html
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption.html
SSE KMS and SSE-S3 Tabs
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption/server-side-encryption-sse-kms.html#quickstart
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption/server-side-encryption-sse-s3.html#quickstart
2024-04-15 14:58:26 -04:00
96c0d232f8 Updates for several releases and issues (#1179)
Updates for server RELEASE.2024-03-30T09-41-56Z
    
- Adds information that SSE-C encrypted objects can now replicate.
    
Closes #1177

- Adds information on operator renewal of tenant certificates
    
Closes #1167

- Corrects a description for `ilm restore` function
    
Closes #1175

Updates for Console release 0.45.0
    
- Removes healing references
- Updates headings and subheadings for the current Console UI
    
Closes #1107
2024-04-05 16:43:32 -04:00
8b5be57ee3 Deprecated command cleanup (#1166)
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes #1164

- Moves wildcard matching from `mc mirror` to `minio-mc.rst` page and
adds ref links throughout as needed.
2024-03-28 17:13:35 -04:00
ef81b3d357 Server updates (#1173)
## Server release  RELEASE.2024-03-26T22-10-45Z 

- Adding info about node dashboard for Grafana.
- Also updates links to JSON files for other dashboards that were
incorrect.

*no related docs issue*

## Not a server release, but fixes:

- Corrects information about JSON policy file size limits.
- Adds information about limit on tags per object.
    
Closes #1134

## Server RELEASE.2024-03-21T23-13-43Z
    
- Adds new `user` envvar and config for REDIS notifications
- Simplifies and updates discussion of encryption keys for SSE
    
Closes #1169
2024-03-28 17:07:39 -04:00
c9505be39d Revert "MinIO Server releases and other fixes (#1172)"
This reverts commit 2488541cd0.
2024-03-27 18:00:59 -04:00