1
0
mirror of https://github.com/minio/docs.git synced 2025-05-02 07:24:51 +03:00

82 Commits

Author SHA1 Message Date
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
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
6482571bf2
Update mc reference docs for improved nav structure (#717)
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc

Closes #710
2023-02-02 16:52:36 -06: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
Ravind Kumar
377d9659d2 Minor Fix: Remove 0-parity EC reference from EC docs 2023-01-25 11:44:16 -05: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
Daryl White
ea489b4a30
Updates for minio Dec 2022 releases (#701)
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.

Updates for Dec 2022 minio updates
    
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
    
Closes #684

Updates for Jan 2 2023 release
    
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
    
Closes #689
2023-01-12 13:57:36 -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
6d32ddcaa8
Update for early Dec 22 minio release (#671)
## Updates for `console` early Dec22 releases

- Updated the instructions for registering for SUBNET from an airgapped
Console environment
- Minor typo in IAM doc.

Closes #664

Two of the items in that issue did not actually impact the docs. One
item is just a screenshot update that will be addressed later.

## Updates for `minio` early Dec22 releases
    
- Adds info about `mc` installed with container images
- Adds new envvar for KES enclaves
    
Closes #665

- Updates `mc support inspect` to correct alias to target in command
syntax
2022-12-28 11:41:23 -06:00
Ravind Kumar
54f1fa14da BUGFIX: Multiple Issues
DOCS-676: Resource ARN "*" description misleading
DOCS-677: Site Replication Recovery requires removing failed site first
MINIO-16268: Further simplify erasure set stripe calculation docs to avoid further confusion
2022-12-16 15:06:22 -05:00
Daryl White
27b02399d7
Adding two supported KMS providers (#673)
Partially addresses #672

Adds two additional supported KMS vendors.
Does not document how to configure or use the two additional KMS
vendors.

Co-authored-by: Ravind Kumar <ravind@min.io>
2022-12-15 15:10:44 -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
f7b3b1c621
Updating links to Prometheus docs (#668)
Just a couple of link adjustments for the Prometheus doc.

- One link was broken due to a page move on the Prometheus side.
- Other is a request from Slack to add a link to Prometheus install.
2022-12-08 11:58:15 -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
0a68ca4ff9
Adding bucket limit information (#649)
- Imports the limits doc from legacy into the Checklists section
- Adds 500K limit to buckets in several places

Closes #548
2022-11-22 15:25:44 -06:00
Daryl White
bce5f8267f
Updates for minio RELEASE.2022-08-22T23-53-06Z (#648)
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
    
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts

Closes #537
2022-11-22 15:08:35 -06: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
Daryl White
46ef64ed2d
Updates the Gateway migration doc (#631)
- Utilizes mc admin cluster commands to export/import bucket and IAM
settings.
- Adds export and import to the mc admin config command reference doc.
- Applies additional feedback from #628 that was added after that PR was
merged.
2022-11-04 16:05:07 -05:00
Daryl White
b5b345ae6f
Add standalone migration procedure (#628)
Closes #624

Creates a new page under install-deploy-manage Operator docs. This page
summarizes the changes that led to the deprecation of the
Gateway/Filesystem. It overviews the steps required to create a new
Single-Node, Single-Drive deployment with the contents, settings, and
IAM policies from the old deployment.
2022-11-01 17:15:04 -05:00
Ravind Kumar
64ca9697cf
DOCS-625: Removing FS Mode guidance, cleanups to deploy docs (#626)
Closes #625
2022-10-31 14:21:44 -04:00
Ravind Kumar
f016fdb219 Additional fixes 2022-10-28 16:27:49 -04:00
Ravind Kumar
4385d06941 Improving tenant deployment guidance for PV/PVC 2022-10-28 16:27:49 -04:00
Ravind Kumar
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00