1
0
mirror of https://github.com/minio/docs.git synced 2025-04-25 17:22:39 +03:00

77 Commits

Author SHA1 Message Date
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
Daryl White
05e2452c36
Updates for minio RELEASE.2023-01-18T04-36-38Z (#711)
minio
[RELEASE.2023-01-18T04-36-38Z](https://github.com/minio/minio/releases/tag/RELEASE.2023-01-18T04-36-38Z)
affects the docs:

- Decommissioning of multiple pools [PR
#16416](https://github.com/minio/minio/pull/16416)
- Automatic SUBNET license update [PR
#16391](https://github.com/minio/minio/pull/16416)

There is no doc issue to track this update.
2023-01-20 15:20:10 -06:00
Daryl White
46abdb4a57
Adding order of operations for expansion and decommission (#705)
- Modifies decommissioning page to mention completing any planned
expansions first.
- Modifies expand deployment page to mention completing before doing any
planned decommssions.
- Minor grammar fixes to expand tenant page.

Closes #702
2023-01-17 15:30:57 -06:00
Daryl White
b0a97ce1f4
Updates for mc RELEASE.2023-01-11T03-14-16Z (#704)
- Adds info on `mc mirror` continuing after a failed object sync [PR
4427](https://github.com/minio/mc/pull/4427)
- Adds addition call type to `mc admin trace` [PR
4416](https://github.com/minio/mc/pull/4416)
- Adds info about changed default file behavior for `mc support inspect`
[PR 4420](https://github.com/minio/mc/pull/4420)
- Concurrent upload support for `mc pipe` [PR
4435](https://github.com/minio/mc/pull/4435)
- Renames two `mc admin replicate` subcommands [PR
4383](https://github.com/minio/mc/pull/4383)
- Updates behavior of `mc license update` to no longer require license
file [PR 4429](https://github.com/minio/mc/pull/4429)
- New flag for `mc admin update` to bypass confirmation prompt [PR
4439](https://github.com/minio/mc/pull/4427)

There is no doc issue to track this update.
2023-01-17 13:19:53 -06:00
Ravind Kumar
9ae1e87c75 Fixing issues after multiple large merges 2023-01-10 17:44:40 -05:00
Ravind Kumar
9b7a95d2b2
K8S-RELEASE: Adding EKS, GKS, AKS (#696) 2023-01-10 17:16:21 -05:00
Daryl White
00de8dbeb6
Updates to mc docs for December 2022 releases (#697)
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.

- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
    
Closes #685

- Updates ilm commands for new structure for tiers and rules
    
    - Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
    - Adds new `mc ilm rule` and six subcommands
    - Adds new `mc ilm tier` and six subcommands
    - Updates references to ilm and admin tier  commands throughout docs
    - Adds new deprecated commands page
    - Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees

- Closes #691
- Closes #662
2023-01-10 15:47:02 -06:00
Ravind Kumar
dbbfce1aeb
DOCS-677: Update site replication recovery procedure (#694)
Closes #677 

Updates the site replication recovery tutorial with slight tweaks to the multi-site expansion tutorial to account for the latest changes to MinIO/MC

Co-authored-by: Poorna <poornas@users.noreply.github.com>
2023-01-06 18:03:59 -05:00
Ravind Kumar
c2dacd93f2
DOCS-691: Fix replication tutorials for new syntax, other minor fixes (#693)
Partially addresses #691 

Follows up #692 

#. Summary

Updates replication tutorials to use latest syntax for `mc replicate
add`, removing references to `mc admin bucket remote add`

Includes some build output fixes for non-Linux builds.

Staged:

- [One-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-one-way-bucket-replication.html#configure-one-way-bucket-replication-using-the-command-line-mc)
- [Two-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-two-way-bucket-replication.html#configure-two-way-bucket-replication-using-the-command-line-mc)
- [Three-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.html#configure-multi-site-bucket-replication-using-the-command-line-mc)
- [Resynchronize
Bucket](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/server-side-replication-resynchronize-remote.html)
2023-01-04 21:49:26 -05:00
Daryl White
348758b807
mc updates for RELEASE.2022-12-02T23-48-47Z (#667)
Updates mc docs for
[RELEASE.2022-12-02T23-48-47Z](623de88abd)
and closes several issues:

- Adds `mc support callhome`
- Simplifies and moves `mc support logs` to `mc admin logs`
- Adds `mc support proxy` command
- Adds `mc admin replicate resync` command

Closes #655 
Closes #663
Closes #644
2022-12-08 14:09:36 -06:00
Daryl White
146cc8afa5
Updates for Console release v0.20.1 (#654)
- Adds info on multiple IDPs and logging in to the MinIO Console
- Updates Configuration section of MinIO Console to Settings
- Adds info about validation check when creating a bucket
- Adds info about adding certificates when creating a tenant in the
operator

Closes #545
2022-12-02 14:07:36 -06:00
Daryl White
e8447adc04
Updates to docs for Operator 4.5.4 and Console v0.21.0 (#651)
# Updates for Operator 4.5.0

- Add --interactive flag info to kubectl create tenant docs
- Adds flag to kubectl minio tenant create doc
- Softens wording on bucket limit to be recommended in the MinIO console
doc for PR#649
    
# Updates for Console v0.20.5
 
- Adds environment variable option to create tenant
- Creates Audit Log section to create tenant page and moves some options
there

# Updates for console v0.21.0
    
- Adding info about the tiers status column when in the console
- Reworking site replication section for new changes to the layout in
Console
- Skips documenting support for editing raw YAML for encryption page
when creating a tenant, as that seems to not be supported any longer

# Updates for operator 4.5.4
    
- Adds --pool flag to kubectl minio tenant create
- Adds --pool flag to kubectl minio tenant expand
    
Closes #634
Closes #615
Closes #590
Closes #569
2022-11-28 12:57:20 -06:00
Ravind Kumar
1cfda2e9dc
RELEASE: Multiple Issues (#647)
Closes #639 
Closes #635 
Partially Addresses #590 

- MINIO #16026 https://github.com/minio/minio/pull/16026
- MINIO #16044 https://github.com/minio/minio/pull/16044
- MINIO #16035 https://github.com/minio/minio/pull/16035
- CONSOLE #2428 https://github.com/minio/console/pull/2428

Other Fixes:

- Removes admonition about IDP interactions (multi-IDP support)
- Update Console screenshots and overview page to cover layout changes
- Partial fix for DOCS #590 (Policy now under Identity section)
2022-11-23 14:51:47 -05:00
Daryl White
0cd491c328
Mc updates for multiple releases (#642)
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
2022-11-18 12:49:03 -06:00
Daryl White
2f8c5a94f6
Release updates mc RELEASE.2022-11-07T23-47-39Z (#640)
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)

- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.

Closes #636
Closes #632
2022-11-18 12:31:11 -06:00
Daryl White
0e3ca880ca
Corrects missing part of alias set command (#641)
Fixes a missing part of the `mc alias set` command and adds formatting
to the `PATH` in the replacement list for the command.
2022-11-15 09:42:39 -06:00