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

92 Commits

Author SHA1 Message Date
Ravind Kumar
b3e259b6e6 Further clarify SNSD + 0 parity mode access 2023-11-28 19:25:58 -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
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
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
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
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
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
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
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
Ravind Kumar
8801c834b2
Update deploy-operator-helm.rst 
Closes #928
 2023-07-21 17:36:46 -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
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00
Ravind Kumar
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
Ravind Kumar
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
Andrea Longo
a6aa72c7d8
Fix docs for gateway/filesystem deployment migration (#894) 
The instructions to migrate a MinIO Gateway or filesystem mode
deployment are incorrect. Separate out the steps that differ for each
into tabs and clean up where needed. Several migration steps for
filesystem mode don't apply to gateway, and tiers don't apply to either.

Staged:

http://192.241.195.202:9000/staging/DOCS-818/linux/html/operations/install-deploy-manage/migrate-fs-gateway.html

Fixes https://github.com/minio/docs/issues/818
 2023-06-29 14:46:43 -06:00
Ravind Kumar
7a01ca72e6
DOCS-888: prefix exclusion of versioning prevents replication (#893) 
Closes #888 

# Summary

- MinIO requires versioning for replication
- We support excluding prefixes/folders in buckets selectively
- This prevents replication within those prefixes/folders

Also included in this ticket

- Added an image to the site replication page
- Fixed a broken SVG
- Minor tweaking of site replication page.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-06-23 13:19:45 -04:00
Ravind Kumar
6991295fb9
Improvements to replication conceptual docs (#885) 2023-06-20 17:13:34 -04:00
Andrea Longo
e7c314ccf6
Can remove a decommissioned pool as soon as it completes (#884) 
Docs update for a change in the server pool decommissioning process: you
no longer have to wait for all pools to complete before removing the
ones that are done. [Original
PR](https://github.com/minio/minio/pull/17221)

Partly addresses https://github.com/minio/docs/issues/860
 2023-06-16 11:50:54 -06:00
Andrea Longo
4c735072f7
Move reference docs for mc admin idp commands to mc idp (#873) 
All the `mc admin idp *` commands have been renamed `mc idp *`.
Deprecate everything under `mc admin idp` and create pages for their new
names in the MinIO Client section.

Affects the following commands and subcommands;
* `mc admin idp ldap`
* `mc admin idp openid`
*  `mc admin idp ldap policy`

The new pages maintain the existing content and page structure. New
pages for each subcommand are out of scope for this PR.

Partly addresses https://github.com/minio/docs/issues/859 and
https://github.com/minio/docs/issues/866

Staged:

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-admin.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-deprecated.html

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-06-08 11:58:22 -06:00
Andrea Longo
9f5be8878b
fix link in deploy-operator-helm (#871) 
Yay @djwfyi  had the correct syntax
 2023-06-05 17:59:20 -06:00
Andrea Longo
65e284f453
Helm deploy docs (#851) 
Document how to deploy with a Helm chart, based on [How to install MinIO
Using Helm in
Kubernetes](https://github.com/cniackz/public/wiki/How-to-install-MinIO-Using-Helm-in-Kubernetes).

This addition maintains the existing plugin instructions as the primary
path, with Helm as a child page under that. That makes room for future
deploy options.

The existing `common-install-operator-kubectl-plugin-install.rst` is now
in two parts, to allow only including the second part in the Helm
instructions. Also promoted the Upgrade page to be a sibling to Deploy.

Many of the original instructions are environment setup that enable
installing the Helm charts, starting Operator, and creating a tenant.
That will vary by the user's environment, so omitted for docs.

Staged:

http://192.241.195.202:9000/staging/DOCS-798/k8s/html/operations/install-deploy-manage/deploy-operator-helm.html

Fixes https://github.com/minio/docs/issues/798
 2023-06-05 17:45:58 -06:00
Daryl White
4345552d7f
Broken link to decommission page (#862) 
Corrects a link that resulted in a 404 from K8s tenant page to
decommission page.
 2023-05-25 13:29:35 -05:00
Ravind Kumar
b3fdcef007
DOCS-763: Update pool, availability, resiliency, and erasure code docs (#843) 2023-05-12 12:19:45 -04:00
Daryl White
6c5d694756
Add info about time sync (#847) 
Adds a checklist item to software about configuring time
synchronization. Adds a prereq to the multi-node deployment about time
sync.

Closes #778
 2023-05-09 09:56:13 -05:00
Daryl White
48d78340ff
Operator sidecar (#838) 
This adds information about Operator component changes in v5.0.x.

Closes #791 

Staged:
http://192.241.195.202:9000/staging/operator-sidecar/operations/installation.html
 2023-05-05 10:39:13 -05:00
Daryl White
101ad648dd
Doc updates related to Operator v5.0.0 (#837) 
Updates docs for most changes through v5.0.4.
Does not have changes related to sidecar containers.

Partially addresses #791

Staged: http://192.241.195.202:9000/staging/operator-5.0.0/index.html
 2023-04-28 16:39:41 -05:00
Andrea Longo
ea85cce9a9
New flag to set site replication to synchronous (#826) 
Document new flag for `mc admin replicate update` to enable/disable
synchronous site replication. Continue to recommend default async
replication due to increased write latency with sync.

Adapt/reuse the existing description of async vs sync from bucket
replication as an include.

Staged

http://192.241.195.202:9000/staging/DOCS-790/linux/html/operations/install-deploy-manage/multi-site-replication.html#synchronous-vs-asynchronous-replication

http://192.241.195.202:9000/staging/DOCS-790/linux/html/reference/minio-mc-admin/mc-admin-replicate.html#syntax

http://192.241.195.202:9000/staging/DOCS-790/linux/html/administration/bucket-replication.html#synchronous-vs-asynchronous-replication

Fixes https://github.com/minio/docs/issues/790
 2023-04-20 15:54:05 -06:00
Ravind Kumar
e7db29ff03
Patching replication docs for version match requirement (#825) 2023-04-20 10:36:31 -04:00
Allan Roger Reid
948fce19c8
Specify usage of mc in gateway migration (#817) 
Fixes: https://github.com/minio/docs/issues/805
 2023-04-14 13:26:55 -04:00
Daryl White
a4dd7929e0
Add changes for MinIO RELEASE.2023-03-20T20-16-18Z. (#809) 
Closes #767

- Adds behavior note about decommissioning pools with tiering enabled
- Adds info about enabling/disabling LDAP IDP connection
- Adds a Windows-only note in the Object Management about not using the
\ character

Staged:
- http://192.241.195.202:9000/staging/minio-2023-03-20/index.html
- Windows at:
http://192.241.195.202:9000/staging/minio-2023-03-20/windows/administration/object-management.html#object-organization-and-planning
 2023-04-12 10:40:19 -05:00
Ravind Kumar
d7bfff7aa2
DOCS-660: Add note for Linux gateway migration docs pointing to Container docs (#795) 2023-03-31 18:03:38 -04:00
Ravind Kumar
b32d6167db
DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Ravind Kumar
732b6c3de7
Updating Nginx Reverse Proxy documentation (#743) 
- Proxying MinIO based on subdomains of a single hostname
- Proxying MinIO based on subpath of a single hostname
- Including the websocket upload logic
 2023-03-06 12:19:44 -05:00
Daryl White
43e41fc528
Updates for Console 0.23.1 (#738) 
- Adds info about runtime configuration selector in operator docs
- Adds note about audit and monitoring disabled by default for new
tenants
- Adds info about new server certificate expiration visibility
- Renames Notifications tab to Events in the managing objects console
doc

Notifications > Events already previously changed in the managing
objects doc.

Closes #733
 2023-02-24 10:09:31 -06:00
Ravind Kumar
96cda9c385
DOCS-728: Dropping Windows cruft (#729) 
Closes #728
 2023-02-10 14:21:42 -05:00
Ravind Kumar
94d1faa9c1
Port-Forwarding cleanups (#722) 
As per https://github.com/minio/console/issues/2539 , the websocket
behavior integrated as part of Console 0.22.1
(https://github.com/minio/console/pull/2419) seems to break
port-forwarding behavior.

There's no easy fix for this. NodePorts are a workaround, but slightly
kludgy. Ingress is the better long-term solution, but requires more
work.

This is a stopgap:

- For Operator, point users towards NodePorts if port-forwarding fails
- For Tenant Console, simply drop port-forwarding entirely and point
only at Ingress/LB

Out of scope but in progress is Ingress guidance for Nginx and Traefik
so we can close the loop on this.
 2023-02-07 11:17:24 -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
0d8e510234
Final decommission listing check (#719) 
Addresses updates for [minio
RELEASE.2023-01-12T02-06-16Z](https://github.com/minio/minio/tree/RELEASE.2023-01-12T02-06-16Z)

- Adds note about decommission behavior to check list of objects at end.

Closes #706
 2023-02-02 15:27:18 -06:00