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

149 Commits

Author SHA1 Message Date
Daryl White
c591983d4a
Correct process for registering an airgapped deployment for subnet (#740)
The steps for registering an airgapped deployment for subnet have
changed.
This PR updates the steps to the current process.
2023-02-24 10:08:34 -06:00
Daryl White
38bf361add
mc admin speedtest and mc ping updates (#723)
- Adds `mc ping` doc

Closes #538 

- Deprecates `mc admin speedtest` to `mc support perf`

Closes #678
2023-02-15 11:37:11 -06: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
238888d765
Updates to docs for mc RELEASE.2023-01-28T20-29-38Z (#718)
Updates related to [mc
RELEASE.2023-01-28T20-29-38Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-01-28T20-29-38Z)

- new `--comment` flag for `mc admin user add` service accounts
- new `--airgap` flag for `mc license unregister`
- new `--encrypt-key` flag for `mc ilm restore`
- removed `--duration` flag for `mc support perf`
- new `--api-key` flag for `mc license register`

No doc issue for tracking this release.

Closes #715 for ilm restore flag
2023-02-02 14:27:43 -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
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
3559267dea
DOCS-699: improve documentation on storage classes for remote targets (#700)
Closes #699
2023-01-12 15:14:13 -05: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
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
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
35d575f6c3
Updates mc replicate commands (#692)
- Dec 24 2022 mc release moves `mc admin bucket remote` commands to mc
replicate
- Updates `mc replicate add | update | ls | rm | status` commands
- Adds pointers from `mc admin bucket remote` command to relevant new
pages

Closes #681

Partially addresses #691

- Corrects minor formatting error in glossary to address build errors
2023-01-04 16:57:03 -06: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
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
9db99342d4
MinIO Nov 2022 releases updates (#658)
Updates docs for various releases through November 2022.

## Updates for mc RELEASE.2022-11-17T21-20-39Z
    
- Creates `mc admin idp ldap policy entities` section
- Corrects incorrect `--tier` flag in `mc ilm add`
- Adds info to `mc ilm ls` about new tabular format of output
    
Closes #645
    
- Adds info about modifying endpoints for distributed endpoits.
    
Partially addresses #644

## Updates for Bugfix [minio
RELEASE.2022-11-29T23-40-49Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-11-29T23-40-49Z)
    
- Adds information about the --remove flag dropping data directories as
well and running on a per-drive basis [PR
16122](https://github.com/minio/minio/pull/16122)
- Adds note that MinIO only supports one JWT based OpenID provider [PR
#16145](https://github.com/minio/minio/pull/16145)
    
Note: There was no Docs issue to track this release.
    
## Other fix:
- Minor correction to Admin Trace
- Clarifies that mc admin idp ldap policy entities command is
cumulative, not exclusive when using multiple flags

## Add additional `mc admin config` commands

- Adds three additional commands. 
- Notes under several commands that environment variables override
config keys.

Closes #653
2022-12-06 17:41:33 -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
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
422d0d915f
Update docs for mc release 2022-10-01 (#643)
Closes #602

- Revises the note about mc support commands requiring SUBNET
registration
- Moves note to the top of each `mc support` subcommand page
2022-11-16 16:03:57 -06:00
Daryl White
e2f30fb5fd
Adds mc batch commands to the docs (#620)
Closes #605

- Adds the five `mc batch` subcommands
- Adds a batch framework page to the Administration section of docs
2022-11-14 17:40:21 -06:00
Ravind Kumar
82c6d38278 Minor fixes 2022-10-20 17:57:16 -04:00
Daryl White
b88a29a223
Update docs of mc release 2022-08-23 (#611)
Updates for mc release 2022-08-23
    
Closes #536

- Thoroughly updated the `mc ilm add` reference page and added --prefix and --newer** flags.
- Updates the `mc ilm edit` reference page to add the --prefix, --disable, and --enable flags.
- Adds `mc od` command
- Adds `--with-versioning` flag to `mc mb`
- Adds `--api-key` to `mc support diag`
- Adds clarification to --airgap flag on `mc license` and `mc support` topics that flag is not required if the local device has network access, even if the deployment is airgapped.
2022-10-18 13:22:33 -05:00
Daryl White
bf471f3e8c
Adds mc replicate diff command (#600)
Closes #599
mc replicate diff was missing. This adds it.
2022-10-12 11:21:36 -05:00
Daryl White
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
Harshavardhana
4e391920ba
rename 'mc policy' -> 'mc anonymous' deprecated command (#597)
Co-authored-by: Ravind Kumar <ravind@min.io>
2022-10-04 15:13:37 -04:00
Daryl White
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
Ravind Kumar
2344cb304e Cleaning up build errors 2022-09-20 12:35:05 -04:00
Daryl White
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
Daryl White
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
Ravind Kumar
d815aa9ce8
Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Preeti Bhat
1f6acf1f75 Fixed typo for creating directory on local filesystem 2022-08-12 17:18:21 -04:00
Ravind Kumar
3909311e30 Cleaning up typo, incorrect reference 2022-08-12 17:17:28 -04:00
Daryl White
1ef454bf05 Adding kubectl ref docs 2022-06-15 13:34:04 -05:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
Ravind Kumar
bedb656de7 DOCS-493: Single-Node Single-Drive XL Backend 2022-06-02 19:40:25 -04:00
Daryl White
6e4422b029 Add mc support commands and a new support section with SUBNET info 2022-05-20 16:59:31 -05:00
Daryl White
4ceeaa191d Fixing The Command command with references to intended command 2022-05-16 09:29:25 -05:00
jfaldanam
016f12a080 Fix several typos 2022-04-27 10:36:24 -04:00
ravindk89
d92f9d4a2e DOCS-412: Add replication resynchronization procedure
Includes refinements to other replication procedures and single sourcing
2022-04-08 18:27:20 -04:00
Daryl White
3d7d122aea Closes #346
Created common bucket notification for includes
Add include to the bucket notification `Publish Events to <service>` files.

Wording update, numbering fixes for bucket notifications

Adding .DS_Store to `gitignore`.

Ignoring .DS_Store

Delete .DS_Store
2022-03-28 12:05:45 -04:00
dwhitelf
b824e36e65 docs- #377 Adds text to clarify overwrite, remove, and watch flags for mc mirror
Additional cleanup
2022-03-18 16:35:45 -05:00
Ravind Kumar
64369f6b1d Fixing typo on mc rm --non-current 2022-03-17 19:17:01 -04:00
Ravind Kumar
c50d4140c1 Missed fixing option on mc mb 2022-03-04 12:38:13 -05:00
Ravind Kumar
93c9b00cb0 additional cleanups after merge 2022-03-03 16:36:57 -05:00
Ravind Kumar
74e55a6ded Update minio.py and mc references for simplified structure 2022-03-03 15:21:25 -05:00
ravindk89
1448614a07 More minor fixups 2022-01-05 15:30:32 -05:00
ravindk89
2175f83970 DOCS-380: Additional cleanups 2022-01-05 15:16:22 -05:00
ravindk89
ef30821063 DOCS-380: Refactor CLI reference 2022-01-04 19:11:15 -05:00