1
0
mirror of https://github.com/minio/docs.git synced 2025-08-09 13:02:53 +03:00
Commit Graph

50 Commits

Author SHA1 Message Date
Daryl White
c67d446bac Minor fixes to address multiple small issues (#1326)
A few quick fixes noted in several issues:

- Literal reference in mc batch generate pointed to the wrong include
   Closes #1318 
- Lingering reference to an "unregister" function removed
  Closes #1324
- Adds admonition about root credentials required, even with KES
  Closes #1325 
- Adds mc batch cancel to list of commands on batch framework overview
page
   Closes #1310
- Updates mc client page S3 link to avoid possible copy/paste confusion
  Closes #1311
2024-09-20 11:25:14 -04:00
Ravind Kumar
76e5e35ab3 DOCS-1191: Updating SSE params, general fixups (#1295)
Closes #1191 

# Summary

Finally getting around to this mc release

- Added docs for enc-c, enc-s3, enc-kms
- Some docs are making assumptions around behavior that needs to be
fixed _first_
- Drive-by linker fixes

Staged: http://192.241.195.202:9000/staging/DOCS-1191/linux/index.html

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-08-26 11:54:49 -04:00
Daryl White
f7c397c636 Changes for two mc releases (#1296)
[`RELEASE.2024-07-31T15-58-33Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-07-31T15-58-33Z)

- adds new flags to `mc idp ldap accesskey list`


[`RELEASE.2024-08-13T05-33-17Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-08-13T05-33-17Z)

- adds new flags to `mc stat`
- adds new global flag for custom DNS mapping

Does not track an outstanding docs issue.
2024-08-15 11:57:56 -04:00
Andrea Longo
5865c3b93d deprecate mc quota (#1294)
Bucket quotas don't work the way people think they work, as they cannot
enforce hard limits. Deprecate in docs while we sort out what to do with
the commands.

The future replacement is MinIO Enterprise Catalog.

Staged:

http://192.241.195.202:9000/staging/deprecate-bucket-quota/linux/reference/minio-mc-deprecated.html

See:
https://github.com/minio/mc/pull/5011
https://github.com/minio/mc/pull/5012
2024-08-08 14:58:54 -06:00
Andrea Longo
d17c896f75 attempt to remove plugin from docs (#1219)
The Kubernetes plugin is gone, this PR replaces the procedures that use
`kubectl minio` in all its various forms. The plugin was referenced on
many pages and for many purposes so there is _a lot_ of restructuring
involved.

Some procedures no longer have CLI instructions, which can be addressed
in subsequent PRs. Everything should have at least one working method,
even if it's to use Operator Console.

- Remove references to plugin, except for pre-4.5.8 upgrade paths
- Move pre-4.5.8 upgrade paths to new child page (currently hidden from
TOC, linked in page)
- Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:
- [Operator
deploy](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/installation.html)
- [Operator
upgrade](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/install-deploy-manage/upgrade-minio-operator.html)
- [Deploy and manage
Tenants](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/deploy-manage-tenants.html)

Fixes https://github.com/minio/docs/issues/1213
2024-06-07 09:05:39 -06:00
Daryl White
91f16cedd2 Adds disable pager global flag and envvar (#1223)
Closes #1200
2024-05-22 17:35:57 -04:00
Daryl White
c1bbe71ceb Adds mc ready to reference docs (#1221)
Closes #1188
2024-05-22 13:52:25 -04:00
Daryl White
8b5be57ee3 Deprecated command cleanup (#1166)
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes #1164

- Moves wildcard matching from `mc mirror` to `minio-mc.rst` page and
adds ref links throughout as needed.
2024-03-28 17:13:35 -04:00
Daryl White
6cae178c36 Updates for two mc-releases (#1162)
mc RELEASE.2024-03-07T00-31-49Z

- Adds new mc support upload command.
  
Closes #1152

mc RELEASE.2024-03-03T00-13-08Z

- Adds alias options for replicate add and replicate update
- Adds exclude-bucket flag for mc mirror
    
Closes #1143
2024-03-20 17:12:18 -04:00
Ravind Kumar
a335fd7495 Dropping admonitions, review and revisit later 2024-03-18 15:50:11 -04:00
Daryl White
c29eb489f4 Updates for two mc releases (#1160)
Adds updates for mc RELEASE.2024-02-24T01-33-20Z
    
- New `mc put` command
- New `mc get` command
- New `--expire-all-object-versions` flag for the `mc ilm rule add`
command
- Adds info to the expiration of objects in versioned buckets on the
Object Lifecycle Management page
    
Closes #1140

Adds updates for mc release RELEASE.2024-01-28T16-23-14Z
    
- adds --skip-errors flag to mc mirror
- updates the mc admin service commands
    
Closes #1120
2024-03-18 13:08:59 -04:00
Phil Varner
1c0343fac6 Fixes variable placeholders "ACCESS_KEY", "SECRET_KEY", and "SESSION_TOKEN" to consistently use underscore separator. (#1150)
1. Fixes typo of variable placeholder as "SECRET KEY" to "SECRET_KEY"
2. Changes all uses of variable placeholders "ACCESS_KEY", "SECRET_KEY",
and "SESSION_TOKEN" to consistently use underscore separator.
2024-03-07 12:39:26 -05:00
opencmit2
53474232ee Update minio-mc.rst the error parameters, uppercase JSON is not avail… (#1148)
Update minio-mc.rst the error parameters, uppercase JSON is not
available。


![image](https://github.com/minio/docs/assets/112474703/893cc68e-8a57-4687-97f1-5de2c1857e6d)
2024-03-06 08:53:31 -05:00
Daryl White
a210da5f61 Adding mc version info for license add or update (#1111)
Per internal discussion, this adds some admonitions for mc license
commands and the SUBNET registration section of the troubleshooting
page. Also adds information about Client and Server version alignment.
2024-01-30 12:45:04 -05:00
Ravind Kumar
3a8768e85f DOCS-1071: mc.RELEASE.2023-11-15T22-45-58Z PARTIAL (#1075)
Partially addresses #1071 

Just documenting `mc alias import` and `mc alias export`, the former of
which we seem to have missed a year or so back.

Staged: 


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-import.html


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-export.html
2023-11-22 14:21:55 -05:00
Daryl White
abee6a35d6 Updates for two Oct 2023 mc releases (#1066)
Updates for October 2023 MinIO Client releases
    
- Adds output sample for `mc support top locks`
- Adds `mc idp ldap accesskey` and subcommands
    
Closes #1056
    
- Adds environment variables for most global flags
- Adds --retry flag to mc mirror
- Adds --bucket-bandwidth flag to mc admin replicate update
    
Partially addresses #1045

- Removes unsupported `--noncurrent-transition-newer` flags from
commands.
2023-11-10 14:05:07 -05:00
Daryl White
eb94513104 Breaking up envvars and config settings into separate settings pages (#1028)
- Creates a slew of folders and pages nested under the mc-server page to store settings.
- Breaks up all of the environment variable options formerly in the mc-server page into these separate pages.
- Moves the config settings formerly in the mc admin config page to the appropriate new settings pages.
- Adds a MiniO Client settings page and document `mc-host-<alias>`

Closes #1017
2023-11-03 07:55:22 -04: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
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
d23159e386 DOCS-908: Fixing errant references to mc config subcommands 2023-07-05 10:20:51 -04: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
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
Daryl White
48ac2437e8 Moves limit upload and limit download flags out of global list (#820)
Uses an include in case we need them for other commands later.

Closes #787

Also update mc mv to use standard optional and required formatting for
params.

Staged:
http://192.241.195.202:9000/staging/limitflags/reference/minio-mc.html#global-options
2023-04-14 15:37:31 -05:00
Daryl White
2b5c5c8f99 Cleanup license commands (#794)
Cleans up the license commands
2023-03-31 09:37:08 -05:00
Andrea Longo
1f8ce6dec2 Add reference page for mc du (#783)
Create a new reference page for `mc du` and link it in the list of `mc`
commands.

Staged:

http://192.241.195.202:9000/staging/DOCS-764/linux/html/reference/minio-mc/mc-du.html

Includes drive-by fixes to make the _Optional_ notations appear in a
more consistent manner. (Including several otherwise unrelated pages.)
There's more opportunistic fixes here than I might normally do in the
same PR, but seemed better to get it over with.

Fixes https://github.com/minio/docs/issues/764

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-03-30 13:36:41 -06:00
Daryl White
199d1eb1d4 Adds info on certificates with the MinIO Client (#782)
- Adds a new section on certificates to the MinIO Client page
- Adds a new section in Behaviors to the mc alias set page
- Minor fix to a --json flag command in version doc

Closes #781
2023-03-30 13:04:10 -05: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
Ravind Kumar
b79ac90fcf Found bug. need two links per extlink 2023-02-14 17:38:56 -05:00
Ravind Kumar
264d23f18f Adding video link to mc training 2023-02-14 17:09:41 -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
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
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
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
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
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
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
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
Daryl White
705ec2cf45 Updating global flags to point to the common list in the mc page (#541) 2022-08-31 12:46:27 -05:00
Ravind Kumar
0e63416cb1 Fixing typo 2022-08-12 17:22:18 -04:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -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
Ravind Kumar
a566631be2 DOCS-448: Create new per-platform quickstart guides
Co-authored by: Ravind Kumar <ravind@min.io>
Co-authored by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2022-04-20 10:03:20 -05:00
ravindk89
8e4d7b6971 Cleanup work for DOCS-380 2022-01-04 19:18:50 -05:00
ravindk89
ef30821063 DOCS-380: Refactor CLI reference 2022-01-04 19:11:15 -05:00