minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-19 21:02:14 +03:00
Code
594 Commits 18 Branches 0 Tags
Commit Graph

160 Commits

Author SHA1 Message Date
Harshavardhana
548ee3f082
Rename disk_ -> drive_ for alert metrics 2023-12-01 13:58:17 -08:00
Ravind Kumar
b3e259b6e6 Further clarify SNSD + 0 parity mode access 2023-11-28 19:25:58 -05:00
Ravind Kumar
0741f57013 Quickfix: Guidance on firewall + port access 2023-11-21 14:17:05 -05:00
Allan Roger Reid
9381b113f5
Tweak helm deployment strategy (#1073) 
Important @ravindk89 : the installation of the tenant will end up with
CrashLooping pods unless a Standard storageclass is previously installed
- similar to the following. Please document this where best you see fit.
```
cat <<EOF | kubectl apply -f -
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: standard
provisioner: rancher.io/local-path
reclaimPolicy: Delete
volumeBindingMode: WaitForFirstConsumer
EOF
 2023-11-17 10:58:43 -05:00
Daryl White
bef64557eb
Add info on grafana with KES/KMS (#1072) 
Closes #1057 .
 2023-11-17 09:59:01 -05:00
Ravind Kumar
8b7448cb95 Fixup to NodePort range for Operator 2023-11-16 17:00:09 -05:00
Ravind Kumar
c770ba9d76
DOCS-1021: Adding helm information (#1060) 
Closes #1021 
Closes #1055 
Closes #968 
Closes #943 


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
 2023-11-16 12:56:20 -05:00
Daryl White
09ce8edb48
Updates for two October releases (#1065) 
- Adds additional flag for `mc admin trace`
- Adds info about supported secret types for k8s

Closes #1039 

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

Closes #1045
 2023-11-15 11:58:16 -05:00
Daryl White
1af11084ec
Removing reference to unsupported decom with tiering (#1069) 
Per community Slack, correcting conflicting docs notes about
decommissioning when tiering is enabled.

Support for this was added in March 2023.
 2023-11-14 15:35:20 -05:00
Daryl White
a8afbc1465
[Community request] Clarify Operator upgrade (#1062) 
Operator upgrade docs for 4.2.3 to 4.5.8 had an incorrect sentence
saying the procedure could upgrade directly to latest stable.
This updates the description to clarify that upgrade should first
upgrade to 4.5.8.

This was noted by a community Slack user.
 2023-11-06 10:47:05 -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
Ravind Kumar
f2d61b2bee
DOCS-1040: Clarify behavior with name conflicts on prefixes (#1052) 
Closes #1040 

Tried to keep this simple:

1. Use better examples
2. Try to use more clear language
3. Keep the consequence clear.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
 2023-10-27 14:13:39 -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
Andrea Longo
ed963c6506
Typo in Helm deploy docs (#1043) 
Incorrect capitalization of `Tenant` in the Helm deploy page causes a
few of the example commands to fail.

Fixes https://github.com/minio/docs/issues/1041
 2023-10-20 13:25:18 -06:00
Andrea Longo
0b6f3e0b38
Improve TLS configuration instructions (#1037) 
Update and clarify how to configure TLS for a distributed deployment.
The existing steps were out of date, and also were not clear
configuration needs to happen on each node.

I'd particularly appreciate comments on terminology. I'm a little fuzzy
about how to work with CAs, perhaps some of the phrasing can be
improved.

Staged:
- linux
-
http://192.241.195.202:9000/staging/DOCS-447/linux/operations/network-encryption.html
-
http://192.241.195.202:9000/staging/DOCS-447/linux/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#add-tls-ssl-certificates

-http://192.241.195.202:9000/staging/DOCS-447/linux/operations/install-deploy-manage/expand-minio-deployment.html#add-tls-ssl-certificates
- k8s
-
http://192.241.195.202:9000/staging/DOCS-447/k8s/operations/network-encryption.html

Closes https://github.com/minio/docs/issues/447
 2023-10-18 10:39:34 -06:00
Daryl White
5c766a8008
Move thresholds page and add references (#1020) 
Per a request from @klauspost, this moves the Thresholds and Limits page
to a more logical place as a core operational concept.

Closes #1018 .
 2023-10-06 16:56:21 -04:00
Ravind Kumar
b13c87d20f Add checklist item for perf-impacting system services 2023-09-29 11:28:30 -04:00
Cesar Celis Hernandez
71497d3072
Warn user to use XFS in EBS Volumes (#992) 
### Objective:

To warn users to use XFS as File system type for MinIO Tenant.

### Docs:

* [CreateVolume
Parameters](https://github.com/kubernetes-sigs/aws-ebs-csi-driver/blob/master/docs/parameters.md)

`"csi.storage.k8s.io/fstype"` should be `xfs` NOT `ext4`

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
 2023-09-25 11:27:36 -04:00
Ravind Kumar
77f3074081
typo fix for upgrade-minio-operator.rst 2023-09-20 12:45:05 -04: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
Ravind Kumar
92f45471cd
Update misnumbered step on recover-after-drive-failure.rst 
Closes #1001
 2023-09-13 15:53:11 -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
Ravind Kumar
ada852eca3
DOCS-934: Clean up container procedures (#985) 
Closes #934
 2023-09-05 15:26:19 -04:00
Andrea Longo
33b28825f3
Partial updates for Operator v5.0.7 docs (#978) 
The easy bits from https://github.com/minio/docs/issues/943: 

- [x] `kubectl minio tenant info` now includes tenant secret info ([PR
#1704](https://github.com/minio/operator/pull/1704))
- [x] `kubectl minio delete` now has a `--force` flag ([PR
#1687](https://github.com/minio/operator/pull/1687))

Staged:

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/reference/kubectl-minio-plugin/kubectl-minio-delete.html

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-info.html

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/operations/install-deploy-manage/deploy-minio-tenant.html#persistent-volumes
 2023-08-31 12:05:42 -06:00
Daryl White
1fae334ff3
Updates tenant upgrade instructions with prereqs (#982) 
Community member noted that the prereqs were out of date in our tenant
upgrade docs.
This brings them in line with what's in Github.

Closes #963
 2023-08-31 13:04:35 -05:00
Andrea Longo
3496680300
typo in erasure coding page (#981) 
Drive-by typo fix, link formatting broken
 2023-08-31 08:16:20 -06:00
Andrea Longo
c2f1181015
Discourage replication for SNSD/SNMD (#976) 
It's technically possible to replicate with SNSD/SNMD configurations.
This is not safe for production environments, docs should discourage it.
(See https://github.com/minio/minio/issues/17523)

Staged

http://192.241.195.202:9000/staging/DOCS-919-6-snsd-replication-nope/linux/operations/install-deploy-manage/multi-site-replication.html#load-balancers-installed-on-each-site

Fixes https://github.com/minio/docs/issues/909
(last item to doc for that release)
 2023-08-29 15:49:14 -06: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
756d9f1799
Correct mc admin user example, fix warnings (#969) 
A few small things:

* find/replace error from https://github.com/minio/docs/pull/950
* build warnings

Thank you @bendem!
https://github.com/minio/docs/pull/950#discussion_r1303044374
 2023-08-23 16:04:32 -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
f05a8aae32
Updates for RELEASE.2023-07-18T17-49-40Z (#962) 
- 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 #931 .

Not staged, but can do if needed.
 2023-08-21 13:07:36 -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
Daryl White
79751411a4
Updating fstab and minio.service path (#936) 
Updates fstab to add `nofail`.
Modifies path for `minio.service` to be in `/lib/` instead of `/etc/`.

Closes #874 .

Staged [here](
http://192.241.195.202:9000/staging/fstab874/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#local-jbod-storage-with-sequential-mounts).

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2023-08-14 14:10:26 -05:00
Andrea Longo
fbee736485
Fix a bunch of incorrect commands for attaching policies (#950) 
Found many incorrect commands for creating/attaching policies to users
and groups.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-3-admin-policy/k8s/html/index.html

This is additional follow-up from
https://github.com/minio/docs/issues/919 and also SUBNET docs feedback.
 2023-08-14 10:15:12 -06:00
Ravind Kumar
20403a7464
DOCS-912: Part 1: Cleaning up Vault (#949) 
Staged:
http://192.241.195.202:9000/staging/DOCS-912/linux/operations/server-side-encryption/configure-minio-kes-hashicorp.html

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-08-11 17:08:36 -04:00
Cesar Celis Hernandez
d2e8899685
Rephrasing the Operator Support (#948) 
### Objective:

To rephrase the Operator Support accordingly for single node single
drive configurations.

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
 2023-08-11 10:29:56 -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
bhara03021989
a5729b78e5
Update configure-minio-kes-hashicorp.rst (#941) 
Adding /v1/key/list/* in the doc instead of /v1/key/list which gives
Authentication issue .

policy:
minio:
allow:
- /v1/key/create/* # You can replace these wildcard '' with a string
prefix to restrict key names
- /v1/key/generate/ # e.g. '/minio-'
- /v1/key/decrypt/*
- /v1/key/bulk/decrypt
- /v1/key/list
- /v1/status
 2023-08-10 10:03:18 -04:00
Ravind Kumar
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
Ravind Kumar
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
Ravind Kumar
8801c834b2
Update deploy-operator-helm.rst 
Closes #928
 2023-07-21 17:36:46 -04:00
Pieter Gijsbers
fd66cf5c10
Add missing word: "is" (#927) 
Per title, it seemed that the word "is" was missing from the sentence.
 2023-07-21 11:50:43 -04:00
Andrea Longo
2572c46cd0
Decommissioning logs skipped delete markers and expired objects (#925) 
Add mention of logging skipped items

Partially addresses https://github.com/minio/docs/issues/909
 2023-07-20 15:21:03 -06:00
Andrea Longo
2abd324c3a
split mc version into subcommand pages (#923) 
Addresses potential confusion about required/optional and the several
mutually exclusive options.

Staged:

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-enable.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-info.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-suspend.html

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

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2023-07-20 10:04:58 -06:00
Ravind Kumar
e90d64bb32
Fix up recommendation page (#914) 2023-07-11 12:35:44 -04:00
Ravind Kumar
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00