minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-09 13:02:53 +03:00
Code Activity
755 Commits 17 Branches 0 Tags
remove-recommended-v2-metrics
Commit Graph

27 Commits

Author SHA1 Message Date
Daryl White
eb94513104 Breaking up envvars and config settings into separate settings pages (#1028) 
- 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 #1017
 2023-11-03 07:55:22 -04:00
Harshavardhana
2a10ceabdc remove out of context doc (#1053) 2023-10-30 15:50:31 -04:00
Andrea Longo
958269a4d1 Clarify webhook auth token details (#996) 
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. (#983) 
Closes #933

- Adds envvar and config param
- Adds Role Policy openID authentication flow
 2023-09-01 16:37:59 -05:00
Daryl White
e7e83d91b4 Documents the scanner.speed config and minio_scanner_speed envvar (#973) 
Closes #796

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 (#966) 
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
Ravind Kumar
ac72345962 DOCS-898: Synchronous Bucket Notifications, config API secret redaction (#960) 
Closes #898 

- 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
Andrea Longo
389d338b6f Remove sts_expiry, username_format; add srv_record_name (#947) 
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 (#939) 
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 (#937) 
Streaming configs and envvars are deprecated.

Closes #903
 2023-08-04 14:07:02 -05:00
Andrea Longo
6e3d3c56ae Document audit kafka queue config/envvars (#926) 
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 (#920) 
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 (#915) 
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
c6b87ee0ee Fixing multiple issues (#906) 
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
Ravind Kumar
c45ac2b0f1 DOCS-867: MINIO Server Release.2023-05-27T05-56-19Z (#904) 
Partially addresses DOCS-898: MINIO Server RElease.2023-06-23T20-26-00Z
 2023-06-29 16:50:46 -04:00
Andrea Longo
45d18ddef8 Docs 860 part2: persistant queues (#883) 
Docs updates for persistent queues added in
https://github.com/minio/minio/pull/17121

Kafka bit needs additional attention, see
https://github.com/minio/docs/issues/886

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-server/minio-server.html#logging

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-mc-admin/mc-admin-config.html#http-webhook-log-target

Partly addresses https://github.com/minio/docs/issues/860
 2023-06-19 09:56:14 -06:00
Ravind Kumar
79e55b4d90 DOCS-845: Updates for MinIO Server RELEASE.2023-05-04T21-44-30Z (#852) 
Closes #845 

Staged: http://192.241.195.202:9000/staging/DOCS-845/linux/index.html
 2023-05-17 17:38:27 -04:00
Daryl White
2d900caa0f Adds new proxy argument webhook logger configuration. (#810) 
Closes #745

Also adds three other missing arguments for the webhook logger
configuration.
 2023-04-12 12:28:47 -05:00
Ravind Kumar
8caa50e3d1 General work on releases (#797) 
Closes #750 
Closes #736 
Partially Address #767
 2023-04-10 16:03:13 -04:00
Ravind Kumar
831f7b29de Removing errant debug statement 2023-03-24 18:41:01 -04:00
Ravind Kumar
b32d6167db DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Daryl White
9db99342d4 MinIO Nov 2022 releases updates (#658) 
Updates docs for various releases through November 2022.

## Updates for mc RELEASE.2022-11-17T21-20-39Z
    
- Creates `mc admin idp ldap policy entities` section
- Corrects incorrect `--tier` flag in `mc ilm add`
- Adds info to `mc ilm ls` about new tabular format of output
    
Closes #645
    
- Adds info about modifying endpoints for distributed endpoits.
    
Partially addresses #644

## Updates for Bugfix [minio
RELEASE.2022-11-29T23-40-49Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-11-29T23-40-49Z)
    
- Adds information about the --remove flag dropping data directories as
well and running on a per-drive basis [PR
16122](https://github.com/minio/minio/pull/16122)
- Adds note that MinIO only supports one JWT based OpenID provider [PR
#16145](https://github.com/minio/minio/pull/16145)
    
Note: There was no Docs issue to track this release.
    
## Other fix:
- Minor correction to Admin Trace
- Clarifies that mc admin idp ldap policy entities command is
cumulative, not exclusive when using multiple flags

## Add additional `mc admin config` commands

- Adds three additional commands. 
- Notes under several commands that environment variables override
config keys.

Closes #653
 2022-12-06 17:41:33 -06:00
Ravind Kumar
0c4c7be68b BUGFIX: PostgreSQL and MySQL Bucket Notification Examples have incorrect values 2022-11-23 09:56:44 -05:00
Daryl White
2f8c5a94f6 Release updates mc RELEASE.2022-11-07T23-47-39Z (#640) 
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)

- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.

Closes #636
Closes #632
 2022-11-18 12:31:11 -06:00
Daryl White
46ef64ed2d Updates the Gateway migration doc (#631) 
- Utilizes mc admin cluster commands to export/import bucket and IAM
settings.
- Adds export and import to the mc admin config command reference doc.
- Applies additional feedback from #628 that was added after that PR was
merged.
 2022-11-04 16:05:07 -05:00
Ravind Kumar
d815aa9ce8 Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00