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
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
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
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
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
24dd7edf49
Adding info about the MINIO_OPTS envvar ( #1185 )
...
We didn't discuss `MINIO_OPTS` anywhere.
This adds it.
2024-04-12 16:39:52 -04:00
24cde64392
Changing admonition for erasure set to warning
2024-04-11 12:07:23 -04:00
c06a77403e
MinIO Erasure Stripe Size ( #1183 )
...
Staged:
http://192.241.195.202:9000/staging/ERASURE_STRIPE_SIZE/linux/reference/minio-server/settings/core.html#erasure-stripe-size
# Overview
We get somewhat frequent inquiries on how to set a stripe size.
We're going to document the option, but heavily emphasize how carefully
this needs to be handled
The defaults are *almost always* the best choice.
We are not going to provide any additional guidance here.
---------
Co-authored-by: Klaus Post <klauspost@gmail.com >
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2024-04-10 17:46:08 -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
2488541cd0
MinIO Server releases and other fixes ( #1172 )
...
## 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
## Staging info
- [SSE encryption key
simplification](http://192.241.195.202:9000/staging/server-updates/linux/administration/server-side-encryption.html )
- [Node Grafana metrics & JSON
links](http://192.241.195.202:9000/staging/server-updates/linux/operations/monitoring/grafana.html#minio-node-metrics-dashboard )
- [Policy size
limit](http://192.241.195.202:9000/staging/server-updates/linux/administration/identity-access-management/policy-based-access-control.html#policy-document-structure )
- [Object
tagging](http://192.241.195.202:9000/staging/server-updates/linux/administration/object-management.html#object-tagging )
- [mc tag
set](http://192.241.195.202:9000/staging/server-updates/linux/reference/minio-mc/mc-tag-set.html )
- [REDIS
User](http://192.241.195.202:9000/staging/server-updates/linux/reference/minio-server/settings/notifications/redis.html#user )
2024-03-27 17:54:37 -04:00
a335fd7495
Dropping admonitions, review and revisit later
2024-03-18 15:50:11 -04:00
909178a753
Correcting envvar address for redis ( #1161 )
...
Corrects the documentation per
https://github.com/minio/minio/issues/19284 .
The address should not have the `user:password` as part of it.
This matches the envvar setting for address to what we already had for
the config setting.
2024-03-18 10:01:43 -04:00
3a52f00cb7
Release work for two server releases ( #1157 )
...
Release work for Server RELEASE.2024-03-03T17-50-39Z
- Adds new NATS config
- Adds new ilm configs
- Adds info on having a KMS auto generate root credentials
Closes #1144
Release work for Server RELEASE.2024-03-10T02-53-48Z
- Corrects a missing URL excludes line for some builds
- Adds new webhook options
Closes #1155
Staged:
- [Webhook
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/metrics-and-logging.html#envvar.MINIO_AUDIT_WEBHOOK_BATCH_SIZE )
- [NATS
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/notifications/nats.html#user-credentials-file )
- [Root
credentials](http://192.241.195.202:9000/staging/release-work/linux/operations/install-deploy-manage/deploy-minio-single-node-single-drive.html#create-the-environment-variable-file )
- [ILM
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/ilm.html )
2024-03-14 17:28:29 -04:00
cb2aa233a0
Simplify SSE tutorials and refer to KES docs ( #1136 )
...
This PR simplifies the management of KMS integrations by removing the
detailed documentation and linking out to the KES docs site instead.
There should be no mention of any specific KMS target.
Each OS/platform should have references to the correct paths, OS, and
the like.
This completes work started on the KES docs side in
https://github.com/minio/kes-docs/pull/48 .
Staged:
-
[Linux](http://192.241.195.202:9000/staging/ssekms/linux/operations/server-side-encryption/configure-minio-kes.html )
-
[Windows](http://192.241.195.202:9000/staging/ssekms/windows/operations/server-side-encryption/configure-minio-kes.html )
-
[Kubernetes](http://192.241.195.202:9000/staging/ssekms/k8s/operations/server-side-encryption/configure-minio-kes.html )
-
[Containers](http://192.241.195.202:9000/staging/ssekms/container/operations/server-side-encryption/configure-minio-kes.html )
-
[MacOS](http://192.241.195.202:9000/staging/ssekms/macos/operations/server-side-encryption/configure-minio-kes.html )
2024-02-29 12:30:06 -05:00
75574cf03f
Typo caught
2024-02-15 11:07:57 -05:00
4edb3f7bae
Improve documentation on MINIO_DOMAIN ( #1131 )
...
# Summary
As per a recent customer issue, our guidance on `MINIO_DOMAIN` and
path/virtual bucket lookups needs some attention.
There are two main areas to address:
1. We need to guide users to avoid namespace collision within the
`MINIO_DOMAIN` , as this causes bucket lookup issues with certain MinIO
services/features
2. We need to generally improve docs on setting `MINIO_DOMAIN` correctly
There is also a side objective from Engineering to ensure we have a
simple admonition to direct users to test wherever possible changes to
config settings before applying to production.
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2024-02-14 17:16:58 -05:00
431675e429
Document security header envvars and config items ( #1122 )
...
New settings to configure security headers for requests returned from
MinIO Console.
- `Content-Security-Policy`
- `Strict-Transport-Security`
- `Referrer-Policy`
Staged
http://192.241.195.202:9000/staging/DOCS-1102/linux/reference/minio-server/settings/console.html#content-security-policy
Partially addresses https://github.com/minio/docs/issues/1102
---------
Co-authored-by: Ravind Kumar <ravind@min.io >
2024-02-09 11:12:37 -07:00
5cba0951fb
DOCS-1090: Document Access Management Plugin ( #1115 )
...
Closes #1090
Simple enough - document that which was previously only on github.
Doing a minimal pass here, no core tutorial, just basics.
Staged:
-
http://192.241.195.202:9000/staging/DOCS-1090/linux/administration/identity-access-management/pluggable-authorization.html
-
http://192.241.195.202:9000/staging/DOCS-1090/linux/reference/minio-server/settings/iam/minio-access-plugin.html#
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com >
2024-01-30 11:15:25 -05:00
a065b7a29f
DOCS-1083: MinIO Server Release RELEASE.2023-12-02T10-51-33Z ( #1097 )
...
# Summary
Closes #1083
Also reorganizes the batch framework pages. Could use additional
refinement, but considering that out of scope for now.
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2024-01-02 14:25:04 -05:00
faf5c8a3ef
Guidance on removal of --config-dir | -C
2023-12-29 15:23:27 -05:00
072b82c1e4
Fixing default values for RRS storage class
2023-11-28 16:46:53 -05:00
ca23b065b2
Correcting mc-conf errors ( #1061 )
...
Corrects errors from `mc-conf` references not noticed until after
merging #1028 .
No issue to track it.
2023-11-03 14:13:08 -04:00
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
72d4eb9df9
Adds envvar for Console functionality ( #1014 )
...
Adds two new envvar
Closes #1006
Staged:
http://192.241.195.202:9000/staging/server-2023-09-16/linux/reference/minio-server/minio-server.html#envvar.MINIO_PROMETHEUS_AUTH_TOKEN
2023-10-04 16:43:20 -04:00
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
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
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
7d2a162b1b
Update for MinIO Server RELEASE.2023-08-23T10-07-06Z ( #970 )
...
Adds new environment variable for defining the duration of a browser
session for the MinIO Console.
Related PR: https://github.com/minio/minio/pull/17885
2023-08-24 13:44:55 -05:00
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
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
9ea539b8ab
Restructure/expand mc idp ldap reference pages ( #959 )
...
Improve the AD/LDAP reference docs:
- Break up `mc idp ldap` and `mc idp ldap policy` into parents/children.
- Add commands from the `identity_ldap` configuration key to `mc idp
ldap add` and `mc idp ldap update`.
- Update links from relevant envvars to `mc idp ldap` instead of
`identity_ldap`
- Fix stuff that needs fixing.
Staged:
http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap.html
http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap-policy.html
Fixes https://github.com/minio/docs/issues/940
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2023-08-18 13:50:15 -06:00
20644952de
Grafana and metric updates ( #953 )
...
- 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 #930
Partially addresses #931
Partially addresses #898
Closes #864
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
1a1c340c3c
clarify redirect_uri maybe
2023-08-15 09:55:22 -07:00
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
d674b2ea90
DOCS-872: Update condition key list ( #935 )
...
Closes #872
---------
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com >
2023-08-07 12:33:09 -04:00
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
940c9563c0
DOCS-911: Improving erasure coding core concepts ( #929 )
...
Closes #911
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com >
2023-08-01 17:01:08 -04:00
975cbeb5ff
DOCS-910: Updating proxy and console configurations ( #921 )
2023-07-21 17:41:51 -04:00
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
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
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
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
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
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
443279c3de
Adds documentation for ftp and sftp ( #848 )
...
- Adds a new page to the developer section for File Transfer Protocol.
- Update the `minio server` command with two new flags.
Closes #828
2023-05-11 11:44:14 -05:00
363e688617
Updates for MinIO RELEASE.2023-04-07T05-28-58Z ( #823 )
...
- Adds new environment variable for ILM expiration workers
- Adds new metrics for locks
- Adds keyrotate batch job type
- Adds info about batch replicate from remote to local
Closes #806
Staged:
http://192.241.195.202:9000/staging/minio-2023-04-07/administration/batch-framework.html
2023-05-01 16:42:13 -05:00
6d65d8aba2
Object Lambda docs ( #800 )
...
Object Lambda functions to transform objects via a webhook. Expand and
refine the developer docs from
c4d71bc1a5/docs/lambda/README.mdhttp://192.241.195.202:9000/staging/DOCS-754/linux/html/developers/transforms-with-object-lambda.html
Notes for reviewers:
In addition to the items noted in inline comments, some general things
to confirm:
* Accurate usage/terminology? Is this how we talk about the relevant
topics?
* Any technical points that need more/more correct detail?
* What would someone need to know to go from trying this dev example to
having a real function in their production environment?
[x] Add new docs page in Developers
[x] Add envars to envar list
Fixes https://github.com/minio/docs/issues/754
2023-04-19 15:05:48 -06:00
508940787b
Adding webhook environment variables ( #813 )
...
Fixes build errors due to missing environment variables for logger
webhook configs.
2023-04-14 09:52:14 -05:00
2ea1b14032
Fixed MINIO_ROOT_PASSWORD to be secret key ( #812 )
...
I’ve fixed a little typo that could save some minutes to users:
The MINIO_ROOT_PASSWORD is the secret key, not the access key.
2023-04-13 17:25:14 -05:00
