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

214 Commits

Author SHA1 Message Date
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
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
afc7a03071 Docs 860 part1: max policy document size, webhook metrics (#882) 
Docs updates for two items from [MinIO
RELEASE.2023-05-18T00-05-36Z](https://github.com/minio/docs/issues/860):

* Max policy size of 2KiB for service accounts
I _think_ this change now means json policy documents have the same max
size in all cases. The limit wasn't documented previously. This change
adds max size info throughout, not only for service accounts.
* Webhook usage metrics

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-policy-create.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/administration/identity-access-management/policy-based-access-control.html#policy-document-structure


Partly addresses https://github.com/minio/docs/issues/860

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-06-14 15:32:03 -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
Daryl White
7f200b96b6 Correcting build warning messages (#875) 
This corrects several build errors that had accrued in the docs.
 2023-06-07 15:01:25 -05: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
7a852def87 DOCS-763 part 2: Eco feedback (#853) 
Context:
89bc154bbf



Responding to Eco's review points.


Staged: http://192.241.195.202:9000/staging/DOCS-763-2/linux/index.html
 2023-05-23 17:30:36 -04:00
Ravind Kumar
a6d554acdc DOCS-807, DOCS-846, Misc. Bug fixes (#861) 
Closes #807 
Closes #846 


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-05-23 17:29:48 -04: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
ceff634882 Minor update to reference hardware 2023-05-16 16:48:49 -04:00
Ravind Kumar
283e18cf5f Minor typo cleanups 2023-05-12 12:51:37 -04:00
Daryl White
947b16155a Updates docs of mc release RELEASE.2023-04-12T02-21-51Z (#850) 
- Adds info to `mc ilm restore` about using `mc stat`
- Adds additional flag to `mc admin replicate update` syntax
- Adds metadata tags flags to `mc find`, plus examples

Closes #815
 2023-05-12 11:36:19 -05: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
d293a50ab9 Adds changes for MinIO RELEASE.2023-04-28T18-11-17Z. 
- Adds note to removed metric
- Adds note to an existing  metric now available on the console's metric dashboard

Closes #840
 2023-05-11 12:44:19 -07: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
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
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
Daryl White
579540ae5c Updates for MinIO RELEASE.2023-04-13T03-08-07Z (#824) 
- Adds example output to mc admin info command
- Adds new metric

Closes #814
 2023-04-19 18:30:10 -05:00
Daryl White
d91d752273 Adds notes about expiration output for some mc commands (#819) 
Adds info to `mc admin user svcacct` and `mc admin user sts` about
exposing expiration for accounts.

Fixes some build errors from the troubleshooting doc.

Closes #786
 2023-04-14 15:45:21 -05: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
eaca36720d Adds information for command history and airgap version requirements. (#811) 
- Updates troubleshooting doc for airgap registration
- Updates `mc license register` doc with airgap registration and command
history
- Updates `mc support diag` with command history

Closes #804
 2023-04-14 09:51:11 -05:00
Daryl White
d86463cba1 Adds Call Home information to the troubleshooting doc (#801) 
Closes #751
 2023-04-12 11:01:09 -05: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
Andrea Longo
a2f3f5d8da Add minio_bucket_objects_version_distribution to metrics list (#808) 
Add a new metric to the list of object and bucket metrics.
`minio_bucket_objects_version_distribution`, similar to the existing
`minio_bucket_objects_size_distribution`, is a histogram of object
version counts. (As in: "How many objects in this bucket have between 10
and 100 versions?")

Adding the new one following the established pattern, more comprehensive
info about each metric is a future task.

Staged:

http://192.241.195.202:9000/staging/DOCS-756/linux/html/operations/monitoring/metrics-and-alerts.html#object-and-bucket-metrics

Fixes https://github.com/minio/docs/issues/756
 2023-04-12 08:03:28 -06:00
Ravind Kumar
a432637298 Adding more EDU videos (#803) 2023-04-10 16:36:35 -04:00
Ravind Kumar
8caa50e3d1 General work on releases (#797) 
Closes #750 
Closes #736 
Partially Address #767
 2023-04-10 16:03:13 -04:00
Daryl White
ab49b29916 Correcting mc admin policy command links (#802) 
Missed some references to deprecated commands during an mc release doc
update (PR #799).
This fixes those references to the new commands.
 2023-04-05 16:46:28 -05:00
Ravind Kumar
f6538cadd9 DOCS-779: Fix permission set for MinIO on KES (#793) 2023-04-04 09:36:35 -04: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
Daryl White
086fb8c327 Adding an upgrades and version support section to troubleshooting (#765) 
Adds Version Support section to troubleshooting doc.
Includes info on license support.
Includes information on aligning versions across operator, minio, and mc
products.

Closes #762
 2023-03-27 14:08:11 -05:00
Ravind Kumar
b32d6167db DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Daryl White
ca60d1f3c1 Adds changes for minio release from Feb 27 2023 (#774) 
- updates list of metrics to add new IDP plugin metrics
- Adds info about expiring sts tokens

Depends on two topics added in PR #735  for internal links.

Closes #746
 2023-03-24 12:10:33 -05: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