1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00

215 Commits

Author SHA1 Message Date
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
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
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
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
377d9659d2 Minor Fix: Remove 0-parity EC reference from EC docs 2023-01-25 11:44:16 -05:00
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
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
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
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
9ae1e87c75 Fixing issues after multiple large merges 2023-01-10 17:44:40 -05:00
9b7a95d2b2 K8S-RELEASE: Adding EKS, GKS, AKS (#696) 2023-01-10 17:16:21 -05:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
64ca9697cf DOCS-625: Removing FS Mode guidance, cleanups to deploy docs (#626)
Closes #625
2022-10-31 14:21:44 -04:00
f016fdb219 Additional fixes 2022-10-28 16:27:49 -04:00
4385d06941 Improving tenant deployment guidance for PV/PVC 2022-10-28 16:27:49 -04:00
4e4cc97f45 Major overhaul for Monitoring docs: Part 1 2022-10-28 16:27:01 -04:00
1735b77d8f Adding load balancing content for site replication (#622)
Closes #618

- Adds recommendation for pointing to a load balancer, reverse proxy, or similar for multi-node environments when creating aliases for site replication. 
- Explains that this recommendation avoids a single point of failure risk.
- Updates tabs on site replication page to be in sync when a reader selects Command Line or Console instructions.
- Adds :sync: option example to the design doc.
2022-10-27 13:10:02 -05:00
0aa9ee7e2b Add Multipart to Concepts and Glossary (#609)
Closes #595 

Applies multipart feedback in comments of PR #588.
2022-10-18 13:25:50 -05:00
21797d127b DOCS-610: Update KES procedures for KES 0.21.0, minor cleanups for Vault (#612)
Closes #610 

Did a QA pass after reports of some issues with the vault setup.

Identified an issue where my local testing was done with 0.20.0,
resulting in some errors on 0.21.0 due to dropping --mlock.

Also did a few other general tune ups as I ran end-to-ends again using
Vault + Systemd instead of vault in dev mode.

Staging views in #minio-docs channel
2022-10-18 13:15:05 -04:00
8d8e6bca29 Procedure for updating Operator (#608)
Build out Operator Upgrade Procedure

Co-authored-by: Lenin Alevski <alevsk.8772@gmail.com>
2022-10-12 12:08:30 -04:00
6e7444c812 Updates documentation for Console release 0.20.0 (#601)
Closes #535

- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
2022-10-11 16:31:04 -05:00
d83b216a82 Adds information or requeueing healing processes (#598)
Closes #529

Release RELEASE.2022-08-11T04-37-28Z optimized when site healing
requeues.
Updated bucket replication and site replication docs to reflect this
change.
2022-10-05 12:57:46 -05:00
f191fd7c10 Remove operator upgrade from TOC until procedure is written 2022-10-04 10:50:48 -04:00
c7a46b932f Updating docs for changes with Operator 0.19.5 (#592)
Closes #527

- Adds information about the new Register tab in the Operator
- Updates screenshots to show the Register tab
- Adds note about permissions when managing buckets in a tenant
- Added new FSGroupChangePolicy field to security context when creating
tenants
2022-10-03 16:41:21 -05:00
201b13324e Mc issues (#588)
Addresses five outstanding Issues in the `mc` reference docs.

- Adds `--disable-multipart` flag for `mc mv` (Closes #516 )
- Adds `mc pipe` to reference docs (Closes #517 )
- Adds `mc undo` to reference docs (Closes #520 )
- Adds `mc support top` commands to replace `mc admin top` (Closes #526)
- Updates `mc cp`, `mc mirror`, `mc replicate`, and `mc admin replicate`
to clarify the differences in what copies (Closes #532)
2022-10-03 14:45:56 -05:00
d5d3243413 DOCS-580: Fixing reported issues with Vault tutorial (#591)
@djwfyi cursory review in case I missed something.

Closes #580 

I do need to do further testing beyond the patches here. But I'm going
to handle that out-of-band.
2022-09-30 17:47:12 -04:00
32366b2a15 Adding OpenShift Platform (#577)
# Summary

This pull adds back the OpenShift docs as a full dedicated platform

The main changes are:

- Adding the conditionals for OpenShift
- Modifying the Makefile for the new platform
- Adding the tutorials back in
- Fixing up the navigation headers

This was not too much trouble, which bodes well for the future.
2022-09-29 10:37:08 -04:00
92ee087d4f Updating all references to docs.min.io URLs (#584)
Updating remaining links to the old docs site to point to the new URLs.

Closes #581
2022-09-26 14:21:29 -05:00
5a6a298132 Adds file to list steps needed after adding a new platform (#578)
General cleanups I've noticed after new docs launched.

- Creates a markdown doc for steps needed after creating a new platform
for the doc site.
- Adds min.io sitemap to the sitemap_index file.
- Fixes two links causing some crawler errors in glossary and
troubleshooting files.
2022-09-22 13:52:39 -05:00
2344cb304e Cleaning up build errors 2022-09-20 12:35:05 -04:00
aa1c677ecc Adding site recovery content (#540)
Fills out content for the site recovery stub.
Partially addresses #492 .

Also minor fixes for spelling and formatting in the site-replication
doc.
2022-09-19 16:25:52 -05:00
c483255dea Add reference docs for mc support logs (#546)
Adds four reference docs for the subcommands of `mc support logs`.
Adds a section to the troubleshooting doc for using `mc support logs` to
send error logs to SUBNET.

Closes #511 .
2022-09-19 13:54:09 -05:00
5e9bc38cd4 Add mc license to reference docs (#550)
Closes #523 

This PR 

- adds the three commands for `mc license` to the reference docs for
`mc`.
- Replaces `mc support register` with `mc license register`.
- Updates references to `mc support register` to point to `mc license
register` instead.
2022-09-19 11:47:21 -05:00