1
0
mirror of https://github.com/minio/docs.git synced 2025-05-08 02:41:51 +03:00
Commit Graph

109 Commits

Author SHA1 Message Date
Daryl White
b79934f11d
Bug fixes for two issues related to LDAP and site replication ()
Corrects docs to state that when expanding a site replication peer set,
you must list all existing peers.

Closes  

Adds information that when adding Distinguished Names as search
parameters, multiple DNs must be separated with a semi-colon.

Closes 
2024-10-10 16:22:00 -04:00
Daryl White
07a1569e87
Adds language about having write permission to use mc admin update ()
Closes 

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-10-09 11:04:26 -04:00
Daryl White
8da7c7d94c
Adds mc admin scanner to reference docs ()
Closes 
2024-10-08 11:55:48 -04:00
Daryl White
8ad71d4a5b
Updates for mc RELEASE.2024-10-02T08-27-28Z ()
- 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 
2024-10-04 13:56:07 -04:00
Daryl White
79cf400125
Updates for the 2024-09-09 releases of the server and mc ()
- adds new config options for webhook events
- adds new subcommands to mc idp ldap accesskey
- adds info about new output during iam import

Closes 
2024-09-23 15:29:29 -04:00
Daryl White
1e64bf8f6b
Updates for mc RELEASE.2024-09-16T17-43-14Z ()
- 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 ()
Closes  

# 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
529e67dc7e
Changes for several issues related to SFTP and LDAP ()
- 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 
Closes 
Closes 
Closes 
2024-07-15 14:30:19 -04:00
Andrea Longo
697b851a5d
Rework mc admin prometheus reference page ()
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
Daryl White
fa8c73d584
Updates for server and mc releases on 2024-06-10 ()
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 ()
Corrects mc batch examples
Closes 

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
Daryl White
9b0a2e6eb9
Adds updated command output to include EC value. ()
For mc RELEASE.2024-05-03T11-21-07Z.

Closes 
2024-05-22 15:02:32 -04:00
Andrea Longo
3399695e18
Remove deprecated heal options, add two trace call types ()
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 ()
Corrects most references to point to the current command.

Additional references to deprecated command fixed by PR  .
We should merge 1198 at the same time we merge this one.
2024-05-06 14:30:36 -04:00
Daryl White
96224468c4
Add concept pages for Scanner and Healing ()
Adds concept pages for healing and the scanner.
Updates other related files for better context.
    
Adds ref links and other related updates.
    
Closes 
2024-04-25 14:27:25 -04:00
Daryl White
8b5be57ee3
Deprecated command cleanup ()
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes 

- 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
Daryl White
c29eb489f4
Updates for two mc releases ()
Adds updates for mc RELEASE.2024-02-24T01-33-20Z
    
- New `mc put` command
- New `mc get` command
- New `--expire-all-object-versions` flag for the `mc ilm rule add`
command
- Adds info to the expiration of objects in versioned buckets on the
Object Lifecycle Management page
    
Closes 

Adds updates for mc release RELEASE.2024-01-28T16-23-14Z
    
- adds --skip-errors flag to mc mirror
- updates the mc admin service commands
    
Closes 
2024-03-18 13:08:59 -04:00
Ravind Kumar
67e81ce2f8
Multiple SERVER Releases ()
MinIO SERVER RELEASE.2024-01-05T22-17-24Z - added new metrics to
github.com/minio/minio for later sync

MinIO SERVER RELEASE.2024-01-28T22-35-53Z - MinIO preallocates memory,
mc update compresses binary in transit MinIO SERVER
RELEASE.2024-02-06T21-36-22Z -

MinIO adds condition key for restricting STS AssumeRoleWithWebIdentity
duration at policy level

Closes  , 

Partially addresses  
Partially Addresses 


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-03-11 10:06:46 -04:00
Daryl White
47c09b7d31
Change instances of --JSON flag to --json ()
Continues the work of  to change all other instances of `--JSON` to
`--json`.
2024-03-06 08:59:17 -05:00
Daryl White
22d576bc79
Updates related to three MinIO Client Dec 2023 releases ()
Updates for three December 2023 MinIO Client releases.

1. mc RELEASE.2023-12-02T02-03-28Z
- Enable/disabe ilm expiration rule replication in site replication
config
    - New size filters for ilm rule add
    - Make STS related envvars alias specific
2.  mc RELEASE.2023-12-14T00-37-41Z
- Adds flags to `mc ilm rule add` to support service principals for
Azure tiers.
3.  mc RELEASE.2023-12-23T08-47-21Z  
    - Adds new `mc idp ldap accesskey create` command
    - Updates other `mc idp ldap accesskey` commands
    - Updates `mc license registe` command
    - Adds `--license` flag to `mc license reigster` command
    
Closes 
Closes 
Closes 
2023-12-27 17:55:08 -05:00
Ravind Kumar
3a8768e85f
DOCS-1071: mc.RELEASE.2023-11-15T22-45-58Z PARTIAL ()
Partially addresses  

Just documenting `mc alias import` and `mc alias export`, the former of
which we seem to have missed a year or so back.

Staged: 


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-import.html


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-export.html
2023-11-22 14:21:55 -05:00
Daryl White
09ce8edb48
Updates for two October releases ()
- Adds additional flag for `mc admin trace`
- Adds info about supported secret types for k8s

Closes  

For the `mc admin trace --stats` flag, also adding example output.

Closes 
2023-11-15 11:58:16 -05:00
Daryl White
abee6a35d6
Updates for two Oct 2023 mc releases ()
Updates for October 2023 MinIO Client releases
    
- Adds output sample for `mc support top locks`
- Adds `mc idp ldap accesskey` and subcommands
    
Closes 
    
- Adds environment variables for most global flags
- Adds --retry flag to mc mirror
- Adds --bucket-bandwidth flag to mc admin replicate update
    
Partially addresses 

- Removes unsupported `--noncurrent-transition-newer` flags from
commands.
2023-11-10 14:05:07 -05:00
Daryl White
eb94513104
Breaking up envvars and config settings into separate settings pages ()
- Creates a slew of folders and pages nested under the mc-server page to store settings.
- Breaks up all of the environment variable options formerly in the mc-server page into these separate pages.
- Moves the config settings formerly in the mc admin config page to the appropriate new settings pages.
- Adds a MiniO Client settings page and document `mc-host-<alias>`

Closes 
2023-11-03 07:55:22 -04:00
Harshavardhana
2a10ceabdc
remove out of context doc () 2023-10-30 15:50:31 -04:00
Andrea Longo
1747558ffc
Doc updates for mc RELEASE.2023-10-04T06-52-56Z ()
Doc updates for mc release
[2023-10-04T06-52-56Z](https://github.com/minio/docs/issues/1035)

- [x] `resource` type for Prometheus metrics
- [x] Doc `mc admin trace --request-query`, ~maybe it and some other
should be hidden from `mc --help`?~

Staged:

http://192.241.195.202:9000/staging/DOCS-1035/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html

Fixes https://github.com/minio/docs/issues/1035
2023-10-23 15:17:50 -06:00
Ravind Kumar
6a1697c9f5
DOCS-1022: Use 'mc idp ldap policy' for AD/LDAP policy assignments ()
---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-10-05 16:59:43 -04:00
Andrea Longo
091a321e32
Improve mc deprecated reference: cleanup, move mc admin top ()
First batch of mc deprecation cleanup:

[x] Reorder section TOC: `mc` alphabetical, then `mc admin`
alphabetical.
[x] Standardize deprecation notice format and wording.
[x] Move `mc admin top` to deprecated section.

Staged

http://192.241.195.202:9000/staging/DOCS-896-cleanup-mc-admin-top/linux/reference/minio-mc-deprecated.html

Partially addresses https://github.com/minio/docs/issues/896
2023-10-05 10:29:02 -06:00
Daryl White
20124c9a59
Updates for mc RELEASE.2023-09-20T15-22-31Z ()
- Deprecates mc admin heal flags
- Adds info about healing colors
- Adds mc mirror --exclude-storageclass flag
    
Closes 
Closes 
2023-09-29 17:47:55 -04:00
Daryl White
962835b758
Updates for mc RELEASE.2023-08-30T08-02-26Z ()
Adds example output for `mc admin replicate status` to reflect expanded
output.

Closes 
2023-09-28 14:00:23 -04:00
Andrea Longo
958269a4d1
Clarify webhook auth token details ()
Update text about webhook auth tokens to clarify MinIO uses the value
specified as it is. So if it needs `Bearer` or `Basic` or something
else, that must be included in the string.

Affected items:
- `MINIO_LOGGER_WEBHOOK_AUTH_TOKEN`
- `MINIO_AUDIT_WEBHOOK_AUTH_TOKEN`
- `MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN`
- `mc admin config set logger_webhook auth_token`
- `mc admin config set audit_webhook auth_token`
- `mc admin config set notify_webhook auth_token`

Staged:

_Publish Server or Audit Logs to an External Service_

http://192.241.195.202:9000/staging/DOCS-407/linux/operations/monitoring/minio-logging.html#publish-server-logs-to-http-webhook

http://192.241.195.202:9000/staging/DOCS-407/linux/operations/monitoring/minio-logging.html#publish-audit-logs-to-http-webhook

_mc admin config_

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-mc-admin/mc-admin-config.html#mc-conf.logger_webhook.auth_token

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-mc-admin/mc-admin-config.html#mc-conf.audit_webhook.auth_token

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-mc-admin/mc-admin-config.html#mc-conf.notify_webhook.auth_token

_MinIO Server_

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-server/minio-server.html#envvar.MINIO_LOGGER_WEBHOOK_AUTH_TOKEN

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-server/minio-server.html#envvar.MINIO_AUDIT_WEBHOOK_AUTH_TOKEN

http://192.241.195.202:9000/staging/DOCS-407/linux/reference/minio-server/minio-server.html#envvar.MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN


Fixes https://github.com/minio/docs/issues/407
2023-09-11 09:06:58 -06:00
Daryl White
388cc6c9f3
Adds information about role policy and roleARN for OpenID docs. ()
Closes 

- Adds envvar and config param
- Adds Role Policy openID authentication flow
2023-09-01 16:37:59 -05:00
Daryl White
28e415fd8c
Updates for mc RELEASE.2023-08-29T22-55-06Z ()
mc
[RELEASE.2023-08-29T22-55-06Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-08-29T22-55-06Z)
has changes that impact the docs:

- Adds `list` command to `mc admin kms key`
- Adds new group of `scanner` event types

There is no issue to track this release.
2023-08-31 09:53:21 -05:00
Daryl White
e7e83d91b4
Documents the scanner.speed config and minio_scanner_speed envvar ()
Closes 

And a few other paragraphs here there and yon.
2023-08-29 10:49:10 -05:00
Andrea Longo
27e2f48b2d
Standardize wording of envvar/mc admin config links ()
This change standardizes the text for the "`foo` corresponds with `bar`"
links between the list of envvars and `mc admin config` settings.
(Thanks to @djwfyi for the suggestion.)

It also includes some opportunistic rejoining of hard wrapped lines.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-5-envvar-cmd-links/linux/reference/minio-mc-admin/mc-admin-config.html

http://192.241.195.202:9000/staging/DOCS-919-5-envvar-cmd-links/linux/reference/minio-server/minio-server.html
2023-08-23 14:40:09 -06:00
Daryl White
34cf55934a
Updates for several July 2023 mc releases ()
mc RELEASE.2023-07-18T21-05-38Z
- Replaces mc replicate diff with mc replicate backlog
- Adds mc support top net

mc RELEASE.2023-07-07T05-25-51Z
- Adds mc support perf site-replication
- Deprecates mc admin replicate --sync flag in favor of new mc admihn
replicate --mode flag
- Updates output example of mc admin user info to show authentication
info

Partially addresses  
2023-08-22 13:54:51 -05:00
Daryl White
f05a8aae32
Updates for RELEASE.2023-07-18T17-49-40Z ()
- Adds information about 3 attempts at site or bucket replication tasks
- Adds note about additional info for delete markers
- Updates mc admin info command example output

Partially addresses  .

Not staged, but can do if needed.
2023-08-21 13:07:36 -05:00
Ravind Kumar
ac72345962
DOCS-898: Synchronous Bucket Notifications, config API secret redaction ()
Closes  

- Adds a short section on synchronous vs asynchronous bucket
notifications
- Adds a note on specific configs which now return redacted data on `mc
admin config get`
- Found a few new webhook lambda envvars to add
2023-08-21 11:19:20 -04:00
Daryl White
20644952de
Grafana and metric updates ()
- Adds a new page for Grafana to overview.
- Replaces the list of metrics in the Metrics and Alerts page with an
include to pull the list of metrics maintained in GitHub.
- Removes use of the :metric: role throughout the docs.
- Adds note about the introduction of a new bucket metric endpoint.

Partially addresses 
Partially addresses 
Partially addresses 
Closes 

Staged:
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
2023-08-17 09:01:46 -05:00
Andrea Longo
389d338b6f
Remove sts_expiry, username_format; add srv_record_name ()
Remove long-gone LDAP settings and add docs for a recent one.

Gone:
- `sts_expiry`, `MINIO_IDENTITY_LDAP_STS_EXPIRY`
- `username_format`, `MINIO_IDENTITY_LDAP_USERNAME_FORMAT`
- Username-Bind mode

Related code change: https://github.com/minio/minio/pull/13165

Recent:
- `srv_record_name` for lookup via DNS SVR records

Added in https://github.com/minio/minio/pull/16201
RELEASE.2022-12-12T19-27-27Z

Staged:

http://192.241.195.202:9000/staging/DOCS-919-2-svc-record/linux/html/reference/minio-server/minio-server.html#envvar.MINIO_IDENTITY_LDAP_SRV_RECORD_NAME

http://192.241.195.202:9000/staging/DOCS-919-2-svc-record/linux/html/reference/minio-mc-admin/mc-admin-config.html#mc-conf.identity_ldap.srv_record_name
2023-08-10 18:53:20 -06:00
Andrea Longo
8f598693f0
Updated LDAP docs ()
Update the AD/LDAP configuration instructions, including adding details
about configuring with Console.

Includes reformatting some existing content.

Questions:
- What, exactly, is the status of the `mc admin config identity_ldap`
settings? Deprecated? There, but not recommended for new configurations?
- Are the "all settings" examples correct and appropriate? I'm not clear
if `mc idp ldap` supports the same settings with the same names as
`identity_ldap`.

Staged:

http://192.241.195.202:9000/staging/DOCS-919/linux/html/operations/external-iam/configure-ad-ldap-external-identity-management.html

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

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-08-10 09:44:12 -06:00
Daryl White
2ab9e51d34
Updates NATS notification docs to point to JetStream service ()
Streaming configs and envvars are deprecated.

Closes 
2023-08-04 14:07:02 -05:00
Andrea Longo
6e3d3c56ae
Document audit kafka queue config/envvars ()
Add audit_kafka `queue_dir`, `queue_size`, and their corresponding
envvars.

See https://github.com/minio/docs/issues/886 and
https://github.com/minio/docs/pull/906 for related updates.

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-server/minio-server.html#envvar.MINIO_AUDIT_KAFKA_QUEUE_DIR

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-mc-admin/mc-admin-config.html#mc-conf.audit_kafka.queue_dir

Fixes https://github.com/minio/docs/issues/860 (final item)
2023-07-20 14:03:44 -06:00
Andrea Longo
2c172e8bde
oops missing commit for DOCS-830: data compression ()
See https://github.com/minio/docs/pull/915

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
2023-07-17 12:59:58 -06:00
Andrea Longo
bb1600952e
Data compression docs ()
Document data compression, including security concerns with encrypting
compressed objects.

Staged:

http://192.241.195.202:9000/staging/DOCS-830/linux/html/administration/object-management/data-compression.html

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-mc-admin/mc-admin-config.html#data-compression

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-server/minio-server.html#data-compression

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
2023-07-17 12:33:15 -06:00
Ravind Kumar
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00
Ravind Kumar
c6b87ee0ee
Fixing multiple issues ()
DOCS-902: Add "M' and "Mi" units to --limit-upload and --limit-download
DOCS-895: Take Bucket/IAM snapshot before site replication config
DOCS-886: Add audit_kafka config settings and envvars.
2023-06-30 16:06:48 -04:00
Andrea Longo
9302e4fd86
ftp call type for mc admin trace ()
New `ftp` call type for `mc admin trace`.

Fixes https://github.com/minio/docs/issues/879
2023-06-30 09:34:26 -06:00
Andrea Longo
f5643ea7a5
mc ping --exit and mc admin user svcacct add/edit --expiry ()
Doc updates from [mc
RELEASE.2023-05-30T22-41-38Z](https://github.com/minio/docs/issues/870):

[x] New --exit option for mc ping 
[x] Expiration date can be set when adding or editing a service account

Staged:

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc/mc-ping.html#mc.ping.-exit

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html#mc.admin.user.svcacct.add.-expiry

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html#mc.admin.user.svcacct.edit.-expiry

Fixes https://github.com/minio/docs/issues/870
2023-06-29 15:11:52 -06:00
Ravind Kumar
c45ac2b0f1
DOCS-867: MINIO Server Release.2023-05-27T05-56-19Z ()
Partially addresses DOCS-898: MINIO Server RElease.2023-06-23T20-26-00Z
2023-06-29 16:50:46 -04:00