minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-05 03:41:24 +03:00
Code Activity
772 Commits 17 Branches 0 Tags
fix-sse-c-encryption
Commit Graph

742 Commits

Author SHA1 Message Date
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
d0a0ff1022 Docs automation: fix |java-jar-url| replacement (#1049) 
The URL for the Java SDK JAR is a static string + the SDK version
number. Use the existing `java-sdk-version` value to construct the
correct URL.

C++ doesn't have any releases, so there's no Quickstart to generate.
Move it to the bottom and only link to GitHub and the Doxygen reference
page.

Staged

http://192.241.195.202:9000/staging/java-sdk-jar-url/linux/developers/minio-drivers.html
 2023-10-26 14:06:23 -06:00
Andrea Longo
8b4e38d48d Improve main SDK page (#1047) 
Small cleanup of the main SDK index page. 

[x] More clearly link to respective Quickstarts, API references, and
GitHub repos.
[x] Reorder more-or-less by popularity.

Non-goals:
Validating the install steps provided (except replace `go get` with `go
install ...@version`)

Staged:

http://192.241.195.202:9000/staging/main-sdk-page/linux/developers/minio-drivers.html
 2023-10-25 10:59:13 -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
Ravind Kumar
69e291fa6e DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025) 
Closes #1007
 2023-10-10 16:45:06 -04:00
Cesar Celis Hernandez
d96f3ee959 Correcting Repository Link (#1032) 
### Objective:

To set the correct repository in our Official Documentation.

### Related:

To fix: https://github.com/minio/operator/issues/1453

### Explanation:

TBD
 2023-10-10 13:02:03 -04:00
Cesar Celis Hernandez
13067accd9 Removing nonexistant flag (#1031) 
### Objective:

To correct our documentation because `--default-console-image` does not
exist in our Operator plugin.

### Related:

* This is related to https://github.com/minio/operator/issues/1453 but
will partially fix the issue, there is more work to do. I will create
another PR for the missing update spot.
 2023-10-10 12:37:31 -04: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
Andrea Longo
07d94a4aa7 sphinx-reredirects redirect for mc admin top (#1027) 
Add `sphinx-reredirects` extension and create a redirect for the former
`reference/minio-mc-admin/mc-admin-top.rst`.

To install locally:
```
pip3 install sphinx-reredirects
```
To test:
- Go to the old URL.
- You are redirected to the new deprecated URL.

Example:
```
http://192.241.195.202:9000/staging/DOCS-896-redirects/linux/reference/minio-mc-admin/mc-admin-top.html
```
redirects to
```
http://192.241.195.202:9000/staging/DOCS-896-redirects/linux/reference/deprecated/mc-admin-top.html
```


The redirect is server-side, browser without JS still gets the correct
redirected page.
 2023-10-06 10:26:35 -06:00
Ravind Kumar
6a1697c9f5 DOCS-1022: Use 'mc idp ldap policy' for AD/LDAP policy assignments (#1026) 
---------

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 (#1019) 
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
Ravind Kumar
3b5a7537a4 Update publish-events-to-elasticsearch.rst 
Closes #971
 2023-10-04 18:01:34 -04:00
Daryl White
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
Daryl White
3769dd0173 Batch replication requires realtime tier (#1010) 
Based on discussion of https://github.com/minio/minio/pull/18044, adding
info to the batch replication doc about requiring a realtime tier for
replication.

Not staged.
 2023-10-04 10:46:30 -04:00
Daryl White
20124c9a59 Updates for mc RELEASE.2023-09-20T15-22-31Z (#1015) 
- Deprecates mc admin heal flags
- Adds info about healing colors
- Adds mc mirror --exclude-storageclass flag
    
Closes #1009
Closes #1005
 2023-09-29 17:47:55 -04:00
Ravind Kumar
b13c87d20f Add checklist item for perf-impacting system services 2023-09-29 11:28:30 -04:00
Daryl White
962835b758 Updates for mc RELEASE.2023-08-30T08-02-26Z (#1013) 
Adds example output for `mc admin replicate status` to reflect expanded
output.

Closes #988
 2023-09-28 14:00:23 -04:00
Daryl White
22919dbbe0 Updates for console 0.38 (#1012) 
Add description of access key table.

Closes #989
 2023-09-27 11:37:24 -04:00
Ravind Kumar
a5d432729e Warn against using profiles using cpuio or trace 2023-09-25 16:30:51 -04:00
Ravind Kumar
10a34e1656 Update setup-nginx-proxy-with-minio.rst 2023-09-25 11:54:17 -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
Andrea Longo
62e1447422 Document OpenShift service certificates for Operator deployments (#1002) 
MinIO Operator on OpenShift may require manual configuration of TLS cert
management via the OpenShift `service-ca` Operator. (For deployments
that are _not_ done through Red Hat OperatorHub.)

Document the needed envvars, `volumes`, and `volumeMounts` to enable
`service-ca` and avoid the need to manually renew certs.

~Note: This presumes kustomize, additional research/testing required to
determine configuration for Helm chart deployments.~

Staged

http://192.241.195.202:9000/staging/DOCS-991/openshift/operations/installation.html#procedure

See also:
https://github.com/minio/wiki/wiki/Besides-MINIO_OPERATOR_RUNTIME-what-else-is-needed-in-Operator%3F

Fixes https://github.com/minio/docs/issues/991 (remaining item for
v5.0.8)

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2023-09-25 11:27:06 -04:00
Ravind Kumar
535c1ed36b DOCS-998: Tiering requires source and remote (#1008) 
Closes #998
 2023-09-21 11:44:38 -04:00
Ravind Kumar
77f3074081 typo fix for upgrade-minio-operator.rst 2023-09-20 12:45:05 -04:00
Rushan
d68d9bc774 Increase code readability in dark mode by updating the syntax theme (#1004) 2023-09-18 11:25:00 -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
2304f69a5f AKS deploy page typo (#999) 
Drive-by fix, happened to spot this search/replace oops on the AKS page.
 2023-09-12 11:47:25 -06: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
Rushan
d54b54cafa Light/dark mode: avoid flickering on page reload (#995) 
**Current behaviour:**


https://github.com/minio/docs/assets/13393018/1c8b5762-9ee5-45ec-9e44-88f99c1750dd

**Fix:**


https://github.com/minio/docs/assets/13393018/658f7858-d793-40ca-87de-8f519a12dffa
 2023-09-11 09:30:27 -04:00
Andrea Longo
0e917c2fad typo: fix k8s sftp link (#997) 
Typo from https://github.com/minio/docs/pull/993
 2023-09-08 13:12:00 -06:00
Andrea Longo
1aea92b141 SFTP access for Operator Tenants (#993) 
Document SFTP access for Operator Tenants, from Operator v5.0.7.
https://github.com/minio/operator/pull/1685
https://github.com/minio/operator/pull/1692

The new Operator SFTP text and the not-Operator version it is based on
were converted to includes rather than have a mess of conditionals in a
single file.

Staged

http://192.241.195.202:9000/staging/DOCS-943-2/k8s/developers/file-transfer-protocol.html

http://192.241.195.202:9000/staging/DOCS-943-2/linux/developers/file-transfer-protocol.html

Partially addresses https://github.com/minio/docs/issues/943
 2023-09-08 12:45:29 -06:00
Aofei Sheng
42efe20e4f Correct ChaCha20Poly-1305 to ChaCha20-Poly1305 (#932) 
It's
[ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305),
not ChaCha20Poly-1305. Sorry a little bit OCD.
 2023-09-06 11:53:02 -04:00
Vincent Murphy
374931f6df Reminder to enable minio.service (#990) 
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
 2023-09-06 11:52:45 -04:00
Ravind Kumar
ada852eca3 DOCS-934: Clean up container procedures (#985) 
Closes #934
 2023-09-05 15:26:19 -04:00
Daryl White
4ea1289617 Adds explanation for new scanner events (#986) 
Internal discussion explained when scanner events trigger.
This adds the explanation for those two events.

No issue for this.
 2023-09-05 11:17:53 -05: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
Ravind Kumar
45092bab4b Update bucket-notifications.rst 
Should close #984
 2023-09-01 14:49: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
Daryl White
c8a0eb1f95 Adds notes for changes in console v0.35.0 (#980) 
Closes #944
 2023-08-31 10:08:53 -05:00
Daryl White
28e415fd8c Updates for mc RELEASE.2023-08-29T22-55-06Z (#979) 
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
Andrea Longo
3496680300 typo in erasure coding page (#981) 
Drive-by typo fix, link formatting broken
 2023-08-31 08:16:20 -06:00
Rushan
76099f5cda Style Quick Steps section on quickstart pages (#977) 
The section can be styled by adding the container class `.. rst-class::
section-next-steps`


<img width="798" alt="Screenshot 2023-08-30 at 13 52 07"
src="https://github.com/minio/docs/assets/13393018/7ff22195-1d2a-454f-9736-ea89a58a7515">
 2023-08-30 10:59:19 -05: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
9dabf28246 Add additional context for what local means in the batch context (#975) 
Closes #924
 2023-08-29 16:27:40 -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