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

318 Commits

Author SHA1 Message Date
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
Daryl White
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
Andrea Longo
cb658261c8
Typo in deprecated mc ilm import page (#1282)
Hopefully nobody tries to use this deprecated command anymore, but fix
the example typo anyway.
2024-07-24 13:02:37 -06:00
Daryl White
3e5df481f0
Storage class (#1276)
Missed saving a file, so missed a few fixes on the storage class name
`_` to `-` switch.
2024-07-22 11:16:35 -04:00
Daryl White
b48a8bcd42
Adds example of deleting delete markers to mc ilm rule add page (#1274)
Drive-by fixes to one example on the rule add page.
Adds an example for delete markers.

Closes #1262
2024-07-19 15:03:26 -04:00
Daryl White
529e67dc7e
Changes for several issues related to SFTP and LDAP (#1252)
- Adds info the docs about recent changes to LDAP and SFTP
authentication
- Adds new config/envvar parameter
- Adds new sftp option for server
- Adds new example for forcing ldap or sa auth to SFTP
- Adds new example for using certificate authority for auth to SFTP

Closes #1240
Closes #1229
Closes #1226
Closes #1208
2024-07-15 14:30:19 -04:00
Andrea Longo
697b851a5d
Rework mc admin prometheus reference page (#1256)
Split the `mc admin prometheus` page into subpages and add missing docs
for `mc admin prometheus metrics`.

Staged

http://192.241.195.202:9000/staging/DOCS-1255/linux/reference/minio-mc-admin/mc-admin-prometheus.html

Fixes https://github.com/minio/docs/issues/1255

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-06-28 07:35:22 -06:00
Mark Theunissen
af031f77a7
Remove unbalanced quotes in MINIO_OPTS var, clarify how it is used (#1249)
- Please click "Ignore Whitespace" when reviewing, my editor stripped
out all the trailing whitespace.
- Removes an extra `"` quote 
- Try to explain how MINIO_OPTS works, does that sound right?
- Add missing `:` in front of port number

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Ravind Kumar <ravind@min.io>
2024-06-25 12:07:45 -04:00
Ravind Kumar
9fa014a073
Add MINIO_SERVER_URL to deprecated command list (#1251)
For reference by support w/ customers running older MinIO versions

Mostly need this because it sometimes comes up via support, and this
lets us reference it while also pushing users to upgrade to versions
where this kind of behavior is handled automatically.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-06-20 12:32:37 -04:00
Ravind Kumar
492a08756d
Make Ipv6 support more visible (#1248)
Keeping it simple to start.
2024-06-14 13:01:39 -04:00
Daryl White
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
Daryl White
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
Daryl White
d3eac20f2b
Updates for mc 2024-06-04 release (#1241)
Corrects mc batch examples
Closes #1235

Applies changes to the mc admin trace --stat flag in mc
RELEASE.2024-06-05T18-13-30Z. That change has no tracking docs issue.
2024-06-11 13:02:46 -04: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
voldikss
63d0482a63
Fix typos (#1236) 2024-06-06 12:30:10 -04:00
Daryl White
344e6560c1
Adds three new sets of algorithm definitions for sftp (#1225)
Partially addresses #1201
2024-05-24 17:12:46 -04:00
Daryl White
91f16cedd2
Adds disable pager global flag and envvar (#1223)
Closes #1200
2024-05-22 17:35:57 -04:00
Daryl White
9b0a2e6eb9
Adds updated command output to include EC value. (#1222)
For mc RELEASE.2024-05-03T11-21-07Z.

Closes #1209
2024-05-22 15:02:32 -04:00
Daryl White
c1bbe71ceb
Adds mc ready to reference docs (#1221)
Closes #1188
2024-05-22 13:52:25 -04:00
Daryl White
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
Andrea Longo
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
Ravind Kumar
64923e3c1b
DOCS-1159: RELEASE.2024-03-15T01-07-19Z (#1211)
Partially addresses #1159 

Excluding Metrics v3 since that work is ongoing, and it's not fully
baked as of yet.

All changes are effectively config level.

Also fixed up some format/hierarchy issues while I was at it.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html#compression-extensions
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html#maximum-object-versions
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/storage-class.html#parity-retention-optimization

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-05-09 14:38:07 -04:00
Ravind Kumar
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
Andrea Longo
3399695e18
Remove deprecated heal options, add two trace call types (#1203)
Remove several `mc admin heal` options from the reference docs. These
were previously deprecated and are now hidden.

Also add two `mc admin trace` call types from the same PR, noted in the
relevant GitHub docs: `batch-keyrotation` and `ilm`.

Staged

http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-heal.html

http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-trace.html#mc.admin.trace.-call

Fixes https://github.com/minio/docs/issues/1029
2024-05-06 12:34:08 -06:00
Daryl White
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
Andrea Longo
72e56b4d98
Note that mc support perf suspends other S3 API calls for testing (#1199)
Add information about queuing requests for `drive` and `net` options.

See https://github.com/minio/minio/pull/19634

Staged:

http://192.241.195.202:9000/staging/mc-support-perf-s3-api/linux/reference/minio-mc/mc-support-perf.html#description
2024-05-03 08:13:54 -06:00
Daryl White
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
Daryl White
8b24974faf
Fix remove references (#1195)
@allanrogerr Noticed that our `mc cp` page had references to removing
objects, almost certainly due to a copy/paste error. This fixes those
references.
2024-04-24 15:09:12 -04:00
Allan Roger Reid
85ef20c21a
Fix typos (#1189) 2024-04-17 17:57:48 -04:00
Ravind Kumar
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