1
0
mirror of https://github.com/minio/docs.git synced 2025-06-30 17:42:04 +03:00

567 Commits

Author SHA1 Message Date
548ee3f082 Rename disk_ -> drive_ for alert metrics 2023-12-01 13:58:17 -08:00
b3e259b6e6 Further clarify SNSD + 0 parity mode access 2023-11-28 19:25:58 -05:00
072b82c1e4 Fixing default values for RRS storage class 2023-11-28 16:46:53 -05:00
3a8768e85f DOCS-1071: mc.RELEASE.2023-11-15T22-45-58Z PARTIAL (#1075)
Partially addresses #1071 

Just documenting `mc alias import` and `mc alias export`, the former of
which we seem to have missed a year or so back.

Staged: 


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-import.html


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-export.html
2023-11-22 14:21:55 -05:00
0741f57013 Quickfix: Guidance on firewall + port access 2023-11-21 14:17:05 -05:00
ad24bc3f74 Adds section on supported browsers to the MinIO Console page (#1074)
Closes #1070
2023-11-17 18:10:35 -05:00
76438cc17f Improve guidance on AD/LDAP interaction with MinIO IDP 2023-11-17 11:07:24 -05:00
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
bef64557eb Add info on grafana with KES/KMS (#1072)
Closes #1057 .
2023-11-17 09:59:01 -05:00
8b7448cb95 Fixup to NodePort range for Operator 2023-11-16 17:00:09 -05:00
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
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
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
d3439a3b65 Updates for mc RELEASE.2023-11-06T04-19-23Z (#1068)
- Adds additional mc environment variables.
- Updates `mc support diag` example output.
2023-11-14 15:28:02 -05:00
3b5663ce54 Update for mc RELEASE.2023-11-10T21-37-17Z (#1067)
Adds `--anonymize flag` to `mc support diag`.

Not linked to an issue.

Staged at
http://192.241.195.202:9000/staging/mc-11-10-23/linux/reference/minio-mc/mc-support-diag.html
2023-11-14 13:26:04 -05:00
abee6a35d6 Updates for two Oct 2023 mc releases (#1066)
Updates for October 2023 MinIO Client releases
    
- Adds output sample for `mc support top locks`
- Adds `mc idp ldap accesskey` and subcommands
    
Closes #1056
    
- Adds environment variables for most global flags
- Adds --retry flag to mc mirror
- Adds --bucket-bandwidth flag to mc admin replicate update
    
Partially addresses #1045

- Removes unsupported `--noncurrent-transition-newer` flags from
commands.
2023-11-10 14:05:07 -05:00
bb03238c77 Add default background color for images (#1063)
**Issue**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 29"
src="https://github.com/minio/docs/assets/13393018/2832944a-74a5-4e24-968d-1a3069812c2b">

**Fix**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 20"
src="https://github.com/minio/docs/assets/13393018/69305855-d384-4f58-8a1c-a6f3d3dfbebe">
2023-11-07 18:35:41 -05:00
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
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
6d2ecc2b8a Restore previous Go SDK install command (#1058)
Now that I know why. The additional context to do go get in a project
directory doesn't fit in the format of this page, but it's in the
Quickstart update.
2023-11-02 07:15:15 -06:00
31db10bcf9 Make it easier to find play login (#1054)
The login info for `play` is buried in the MinIO Console page. Link to
it (and info about Console) from the top level page.

Staged
http://192.241.195.202:9000/staging/play-link/linux/index.html
2023-10-31 06:47:22 -06:00
2a10ceabdc remove out of context doc (#1053) 2023-10-30 15:50:31 -04:00
6763b86c3c DOCS-1050: Fix error in mc cp docs 2023-10-27 14:33:06 -04:00
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
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
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
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
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
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
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
69e291fa6e DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025)
Closes #1007
2023-10-10 16:45:06 -04:00
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
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
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
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
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
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
3b5a7537a4 Update publish-events-to-elasticsearch.rst
Closes #971
2023-10-04 18:01:34 -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
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
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
b13c87d20f Add checklist item for perf-impacting system services 2023-09-29 11:28:30 -04:00
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
22919dbbe0 Updates for console 0.38 (#1012)
Add description of access key table.

Closes #989
2023-09-27 11:37:24 -04:00
a5d432729e Warn against using profiles using cpuio or trace 2023-09-25 16:30:51 -04:00
10a34e1656 Update setup-nginx-proxy-with-minio.rst 2023-09-25 11:54:17 -04:00
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
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
535c1ed36b DOCS-998: Tiering requires source and remote (#1008)
Closes #998
2023-09-21 11:44:38 -04:00