minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-10-31 06:30:27 +03:00
Code Activity
852 Commits 17 Branches 0 Tags
ef4faab6d8d0688765b3f8e9aed317f74cf82e48
Commit Graph

47 Commits

Author SHA1 Message Date
Andrea Longo
bde954fcd8 fix prom example typo (#1474) 
The `minio-job` example has `{job-"minio-job"}` where it should be
`{job="minio-job"}`

Corresponding changes in other repos/branches:
https://github.com/miniohq/aistor-object-store-docs/pull/70
https://github.com/miniohq/aistor-object-store-docs/pull/71
 2025-06-06 12:39:28 -06:00
Daryl White
3298919df0 Corrects broken link to GitHub file (#1443) 
Noted in internal discussion that the existing link resulted in a 404.
New link resolves.
 2025-04-01 15:18:18 -04:00
Daryl White
292c604f47 Updates for mc RELEASE.2025-03-12T17-29-24Z (#1441) 
- removes `--logs` flag from `mc support callhome`
- enforces 100 bucket limit for v2 metrics

Closes #1439

Opportunistic fix to remove errant copy/paste for
`--noncurrent-expire-days` flag in `mc ilm rule add`

Closes #1438
 2025-04-01 15:04:32 -04:00
Allan Roger Reid
22a6a3b562 Fix metrics typos (#1413) 
#### Issue
Some minor typos found in the repo while working on metrics
 2025-02-07 15:16:15 -05:00
Jennifer Rondeau
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
Andrea Longo
3458e72e40 Undeprecate v2 metrics (#1375) 
Metrics version 2 is not dead. Continue to feature v3, but restore the
v2 info as an alternate version.

Out of scope: 
Updating the Prometheus and InfluxDB procedures. For now, note they are
v2 and deal with it in a separate PR.

Staged

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/operations/monitoring/metrics-and-alerts.html

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/reference/minio-mc-admin/mc-admin-prometheus.html
 2024-12-05 08:19:18 -07:00
Daryl White
ca34aa7e43 Add cert-manager documentation (#1317) 
Adds cert-manager docs for Kubernetes outputs.

Closes #1245 

Partially addresses #1273
 2024-10-01 16:06:37 -04:00
Andrea Longo
343e54d402 Metrics v3 (#1289) 
Add metrics v3 to the Metrics and Alerts page and other relevant
locations, deprecate metrics v2.

- Updated the metrics extract script to parse the [list of v3 metrics
from
GitHub](https://github.com/minio/minio/blob/master/docs/metrics/v3.md).
- Remove references to MinIO Console metrics.
- Make `:mc-release:` show friendly release name text like
`:minio-release:` does.

Staged:

Linux

http://192.241.195.202:9000/staging/DOCS-1266/linux/operations/monitoring/metrics-and-alerts.html

k8s

http://192.241.195.202:9000/staging/DOCS-1266/k8s/operations/monitoring/metrics-and-alerts.html

fixes https://github.com/minio/docs/issues/1266
 2024-08-02 17:58:59 -06:00
Andrea Longo
62124720a5 fix ref typos for mc admin prometheus generate (#1268) 
Fix broken refs that were causing build warnings on some platforms. Not
staged.
 2024-07-11 15:55:32 -06:00
Andrea Longo
e75fcbce65 typo in grafana.rst (#1261) 
Quick grammar fix for the list of Grafana dashboards.

Not staged.
 2024-07-08 14:04:19 -06:00
Andrea Longo
7c4261d99f broken refs from DOCS-1255 (#1257) 
Sphinx why u no warn _before_ merge??

cf. https://github.com/minio/docs/pull/1256
 2024-06-28 14:01:11 -06:00
Andrea Longo
b422c71bd9 Change scrape_interval in metrics scraping example (#1231) 
The examples show `15s`, which is too short for a typical deployment.
`60s` is recommended. Also note that this value may need to be increased
if there are too many metrics to collect in the specified amount of
time. Each scraping operation should complete before the next begins.

Staged

http://192.241.195.202:9000/staging/scrape_interval/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html#generate-the-scrape-configuration
 2024-06-05 16:49:58 -06:00
Ravind Kumar
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
Ravind Kumar
c9505be39d Revert "MinIO Server releases and other fixes (#1172)" 
This reverts commit 2488541cd0.
 2024-03-27 18:00:59 -04:00
Daryl White
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
Harshavardhana
b7e08de9eb metrics must show relevant yaml per tab selection (#1163) 2024-03-19 16:38:28 -04:00
Ravind Kumar
67e81ce2f8 Multiple SERVER Releases (#1141) 
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 #1124 , 

Partially addresses #1116 
Partially Addresses #1105


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2024-03-11 10:06:46 -04:00
Daryl White
54584b290c Adds recommended metrics to Prometheus procedure (#1147) 
Partially addresses #1135

To consider:
I added the tabs as part of step 3 of the procedure, but we might want
to consider having a recommended alerts section separate from the
procedure, perhaps above the "Dashboards" heading. Let me know your
thoughts.
 2024-03-08 12:29:40 -05:00
Harshavardhana
6e35feaadf Rename disk_ -> drive_ to match with server changes 2023-12-01 14:01:19 -08:00
Daryl White
bef64557eb Add info on grafana with KES/KMS (#1072) 
Closes #1057 .
 2023-11-17 09:59:01 -05:00
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
Andrea Longo
9cc466e9df Fix broken Prometheus doc links (#1051) 
Reported by a reader: Prometheus changed the location of their Data
Model page. Fix our links to match.

Staged

http://192.241.195.202:9000/staging/fix-bad-links/linux/operations/monitoring.html

http://192.241.195.202:9000/staging/fix-bad-links/linux/operations/monitoring/metrics-and-alerts.html

http://192.241.195.202:9000/staging/fix-bad-links/linux/operations/monitoring/monitor-and-alert-using-influxdb.html
 2023-10-27 09:13:17 -06:00
Andrea Longo
1747558ffc Doc updates for mc RELEASE.2023-10-04T06-52-56Z (#1044) 
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
Daryl White
01606fbfa1 Updates for MinIO Server release 2023-08-04 (#1000) 
Updates for release 2023-08-04T17-40-21Z
    
- Adds info on new 10,000 version limit to appropriate pags
- Updates Grafana with site replication info

Closes #938
 2023-09-16 20:35:13 -04:00
Ravind Kumar
a077c6b9c5 DOCS-987: Fixing prometheus metrics to pull from Minio Server docs list (#1003) 
---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
 2023-09-15 12:57:30 -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
34cf55934a Updates for several July 2023 mc releases (#964) 
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  #930
 2023-08-22 13:54:51 -05:00
Daryl White
aac614d083 Updates for Minio Server and mc releases (#958) 
Updates for mc and MinIO server releases
    
- Adds `client` command to mc support perf
- Adds new metrics
- Corrects typos and minor issues in metric related docs
    
Closes #955
Closes #956
 2023-08-21 13:02:04 -05:00
Daryl White
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
Andrea Longo
afc7a03071 Docs 860 part1: max policy document size, webhook metrics (#882) 
Docs updates for two items from [MinIO
RELEASE.2023-05-18T00-05-36Z](https://github.com/minio/docs/issues/860):

* Max policy size of 2KiB for service accounts
I _think_ this change now means json policy documents have the same max
size in all cases. The limit wasn't documented previously. This change
adds max size info throughout, not only for service accounts.
* Webhook usage metrics

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-policy-create.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/administration/identity-access-management/policy-based-access-control.html#policy-document-structure


Partly addresses https://github.com/minio/docs/issues/860

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-06-14 15:32:03 -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
d293a50ab9 Adds changes for MinIO RELEASE.2023-04-28T18-11-17Z. 
- Adds note to removed metric
- Adds note to an existing  metric now available on the console's metric dashboard

Closes #840
 2023-05-11 12:44:19 -07:00
Daryl White
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
Daryl White
579540ae5c Updates for MinIO RELEASE.2023-04-13T03-08-07Z (#824) 
- Adds example output to mc admin info command
- Adds new metric

Closes #814
 2023-04-19 18:30:10 -05:00
Andrea Longo
a2f3f5d8da Add minio_bucket_objects_version_distribution to metrics list (#808) 
Add a new metric to the list of object and bucket metrics.
`minio_bucket_objects_version_distribution`, similar to the existing
`minio_bucket_objects_size_distribution`, is a histogram of object
version counts. (As in: "How many objects in this bucket have between 10
and 100 versions?")

Adding the new one following the established pattern, more comprehensive
info about each metric is a future task.

Staged:

http://192.241.195.202:9000/staging/DOCS-756/linux/html/operations/monitoring/metrics-and-alerts.html#object-and-bucket-metrics

Fixes https://github.com/minio/docs/issues/756
 2023-04-12 08:03:28 -06:00
Ravind Kumar
a432637298 Adding more EDU videos (#803) 2023-04-10 16:36:35 -04:00
Daryl White
ca60d1f3c1 Adds changes for minio release from Feb 27 2023 (#774) 
- updates list of metrics to add new IDP plugin metrics
- Adds info about expiring sts tokens

Depends on two topics added in PR #735  for internal links.

Closes #746
 2023-03-24 12:10:33 -05:00
Ravind Kumar
da88409290 DOCS-690, DOCS-707: Release updates (#720) 
Closes #690 

Closes #707 

Partially addresses scheduled removal of Console Audit Log and Tenant
Prometheus deployments
 2023-02-03 18:27:45 -05:00
Daryl White
ea489b4a30 Updates for minio Dec 2022 releases (#701) 
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.

Updates for Dec 2022 minio updates
    
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
    
Closes #684

Updates for Jan 2 2023 release
    
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
    
Closes #689
 2023-01-12 13:57:36 -06:00
Daryl White
f7b3b1c621 Updating links to Prometheus docs (#668) 
Just a couple of link adjustments for the Prometheus doc.

- One link was broken due to a page move on the Prometheus side.
- Other is a request from Slack to add a link to Prometheus install.
 2022-12-08 11:58:15 -06:00
Ravind Kumar
1cfda2e9dc RELEASE: Multiple Issues (#647) 
Closes #639 
Closes #635 
Partially Addresses #590 

- MINIO #16026 https://github.com/minio/minio/pull/16026
- MINIO #16044 https://github.com/minio/minio/pull/16044
- MINIO #16035 https://github.com/minio/minio/pull/16035
- CONSOLE #2428 https://github.com/minio/console/pull/2428

Other Fixes:

- Removes admonition about IDP interactions (multi-IDP support)
- Update Console screenshots and overview page to cover layout changes
- Partial fix for DOCS #590 (Policy now under Identity section)
 2022-11-23 14:51:47 -05:00
Daryl White
bce5f8267f Updates for minio RELEASE.2022-08-22T23-53-06Z (#648) 
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
    
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts

Closes #537
 2022-11-22 15:08:35 -06:00
Daryl White
0cd491c328 Mc updates for multiple releases (#642) 
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
 2022-11-18 12:49:03 -06:00
Ravind Kumar
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00
Daryl White
6e7444c812 Updates documentation for Console release 0.20.0 (#601) 
Closes #535

- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
 2022-10-11 16:31:04 -05:00
Daryl White
f0611160dc Adding node scanner metrics 2022-08-12 17:22:07 -04:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00