minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-11-03 05:13:12 +03:00
Code Activity
597 Commits 17 Branches 0 Tags
36a4eff2586966cbd793367ddf2fac6c204535e1
Commit Graph

152 Commits

Author SHA1 Message Date
Ravind Kumar
e30a2ac1bc Addressing hardware checklist critical feedback (#1080) 
We're getting a lot of repeated requests during
inbounds on sizing VMs specifically.

Our baremetal and K8s checklists are slightly generic to this and imply
a baseline that may be uncommon within a virtualized context

This attempts to bring together a slightly wider band while emphasizing
that our high-watermark is intended for high performance, while the low
watermark is a bare minimum.


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-12-08 16:01:42 -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
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
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
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
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
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
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
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
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
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
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
Andrea Longo
2908b2f9ee Optional custom init container (#967) 
Operator 5.0.6+ allows custom init containers, should your pod require
additional initialization. Add a brief mention in the Operator install
page and link to the k8s docs.

Staged

http://192.241.195.202:9000/staging/DOCS-900-2/k8s/operations/installation.html#minio-operator-components

Partially addresses https://github.com/minio/docs/issues/900
 2023-08-23 14:59:21 -06:00
Andrea Longo
3669b54fcf Operator supports PSA restricted namespaces (#965) 
Add a mention in the Operator docs that MinIO supports the `restricted`
policy for [Pod Security
admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/)

Staged:

http://192.241.195.202:9000/staging/DOCS-900-1/k8s/operations/installation.html#kubernetes-version-1-19-0

Partly addresses https://github.com/minio/docs/issues/900
 2023-08-23 12:01:19 -06:00
Ravind Kumar
ac72345962 DOCS-898: Synchronous Bucket Notifications, config API secret redaction (#960) 
Closes #898 

- Adds a short section on synchronous vs asynchronous bucket
notifications
- Adds a note on specific configs which now return redacted data on `mc
admin config get`
- Found a few new webhook lambda envvars to add
 2023-08-21 11:19:20 -04:00
Andrea Longo
9ea539b8ab Restructure/expand mc idp ldap reference pages (#959) 
Improve the AD/LDAP reference docs:

- Break up `mc idp ldap` and `mc idp ldap policy` into parents/children.
- Add commands from the `identity_ldap` configuration key to `mc idp
ldap add` and `mc idp ldap update`.
- Update links from relevant envvars to `mc idp ldap` instead of
`identity_ldap`
- Fix stuff that needs fixing.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap.html

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap-policy.html
Fixes https://github.com/minio/docs/issues/940

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-08-18 13:50:15 -06:00
Andrea Longo
1a1c340c3c clarify redirect_uri maybe 2023-08-15 09:55:22 -07: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
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
Daryl White
2ab9e51d34 Updates NATS notification docs to point to JetStream service (#937) 
Streaming configs and envvars are deprecated.

Closes #903
 2023-08-04 14:07:02 -05:00
Andrea Longo
6e3d3c56ae Document audit kafka queue config/envvars (#926) 
Add audit_kafka `queue_dir`, `queue_size`, and their corresponding
envvars.

See https://github.com/minio/docs/issues/886 and
https://github.com/minio/docs/pull/906 for related updates.

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-server/minio-server.html#envvar.MINIO_AUDIT_KAFKA_QUEUE_DIR

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-mc-admin/mc-admin-config.html#mc-conf.audit_kafka.queue_dir

Fixes https://github.com/minio/docs/issues/860 (final item)
 2023-07-20 14:03:44 -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
Andrea Longo
bb1600952e Data compression docs (#915) 
Document data compression, including security concerns with encrypting
compressed objects.

Staged:

http://192.241.195.202:9000/staging/DOCS-830/linux/html/administration/object-management/data-compression.html

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-mc-admin/mc-admin-config.html#data-compression

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-server/minio-server.html#data-compression

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
 2023-07-17 12:33:15 -06:00
Ravind Kumar
9af4c2ccdf DOCS-913: Fix MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC true -> on 2023-07-10 17:32:33 -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
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
Andrea Longo
c7a9477286 fix formatting for sample SNSD env file (#892) 
The code block indentation was off, resulting in a mangled sample
`/etc/default/minio` file in the Single Node Single Drive install docs.
 2023-06-21 15:17:28 -06:00
Andrea Longo
91ffb04078 Don't recommend /home/events for queue path (#891) 
Missing commit from https://github.com/minio/docs/pull/883
 2023-06-19 14:51:02 -06:00
Andrea Longo
45d18ddef8 Docs 860 part2: persistant queues (#883) 
Docs updates for persistent queues added in
https://github.com/minio/minio/pull/17121

Kafka bit needs additional attention, see
https://github.com/minio/docs/issues/886

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-server/minio-server.html#logging

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-mc-admin/mc-admin-config.html#http-webhook-log-target

Partly addresses https://github.com/minio/docs/issues/860
 2023-06-19 09:56:14 -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
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
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
Ravind Kumar
b3fdcef007 DOCS-763: Update pool, availability, resiliency, and erasure code docs (#843) 2023-05-12 12:19:45 -04:00
Ravind Kumar
3f6b8ea57d DOCS-780: Bug Stomping (#844) 
A few big things here:

- Updated to Sphinx 6.2.1 successfully. I'm using Python 3.10.10
- Upgraded to docutils 0.19, which is latest
- Upgrade myst-parser and sphinx-design to latest stable
- Fixed a bunch of warning outputs
 2023-05-11 16:57:03 -04: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
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
Karl Tarbet
1a0905f70e Include port number for the example MINIO_SERVER_URL (#831) 
The example environment variable setup does not include port 9000. As a
new user this tripped me up.

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
 2023-04-25 10:30:29 -04:00
Andrea Longo
8721671838 Only mc admin update might need sudo (#829) 
`sudo` note from https://github.com/minio/docs/pull/822 really should
only apply to `mc admin update`. Add there and remove from the common
include.

Staged

http://192.241.195.202:9000/staging/remove-excessive-sudo-note/linux/html/reference/minio-mc-admin/mc-admin-update.html
 2023-04-21 15:51:15 -06:00