minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-11-03 05:13:12 +03:00
Code Activity
657 Commits 17 Branches 0 Tags
2488541cd0d2c22c358684d47e726baf4dfc35a3
Commit Graph

117 Commits

Author SHA1 Message Date
Daryl White
2488541cd0 MinIO Server releases and other fixes (#1172) 
## Server release  RELEASE.2024-03-26T22-10-45Z 

- Adding info about node dashboard for Grafana.
- Also updates links to JSON files for other dashboards that were
incorrect.

*no related docs issue*

## Not a server release, but fixes:

- Corrects information about JSON policy file size limits.
- Adds information about limit on tags per object.
    
Closes #1134

## Server RELEASE.2024-03-21T23-13-43Z
    
- Adds new `user` envvar and config for REDIS notifications
- Simplifies and updates discussion of encryption keys for SSE
    
Closes #1169

## Staging info

- [SSE encryption key
simplification](http://192.241.195.202:9000/staging/server-updates/linux/administration/server-side-encryption.html)
- [Node Grafana metrics & JSON
links](http://192.241.195.202:9000/staging/server-updates/linux/operations/monitoring/grafana.html#minio-node-metrics-dashboard)
- [Policy size
limit](http://192.241.195.202:9000/staging/server-updates/linux/administration/identity-access-management/policy-based-access-control.html#policy-document-structure)
- [Object
tagging](http://192.241.195.202:9000/staging/server-updates/linux/administration/object-management.html#object-tagging)
- [mc tag
set](http://192.241.195.202:9000/staging/server-updates/linux/reference/minio-mc/mc-tag-set.html)
- [REDIS
User](http://192.241.195.202:9000/staging/server-updates/linux/reference/minio-server/settings/notifications/redis.html#user)
 2024-03-27 17:54:37 -04:00
Andrea Longo
6e52ebf0dd Clarify mc support inspect usage (#1170) 
If a customer's SUBNET issue requires information from `mc support
inspect` we will give them the correct command to run.

Staged:

http://192.241.195.202:9000/staging/mc-support-inspect/linux/reference/minio-mc/mc-support-inspect.html
 2024-03-25 16:06:18 -06:00
Andrea Longo
3c2258375b Add --action for mc undo (#1133) 
Document new option for `mc undo` to restrict the command to reverse
either `DELETE` or `PUT` operations, not both.

Staged

http://192.241.195.202:9000/staging/DOCS-1113/linux/reference/minio-mc/mc-undo.html

Fixes https://github.com/minio/docs/issues/1113
 2024-03-22 10:15:22 -06: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
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
Justin Griffin
ba3b7769ee Doc update for supporting --endpoint arg with Azure remote tier (#1146) 
This is the documentation update associated with PR
https://github.com/minio/minio/pull/19188 that adds the support for
expressing the `--endpoint` arg for a custom Azure blog storage backend.
This is useful for targeting Azure Gov Cloud, which has a different URL.

See https://github.com/minio/minio/pull/19188
 2024-03-08 11:18:10 -05: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
Daryl White
47c09b7d31 Change instances of --JSON flag to --json (#1149) 
Continues the work of #1148 to change all other instances of `--JSON` to
`--json`.
 2024-03-06 08:59:17 -05:00
Andrea Longo
08eb7770dc Small docs fixes and cleanups (#1138) 
Many small fixes:
- Clarify that `mc legalhold set --recursive` applies to current objects
only. Go back and do it again if you want it to apply to newly created
objects.
- Clean up inconsistent capitalization of "legal hold."
- Fix a bunch more `:required:` and `:optional:`
- Add a resync step to the restore site replication instructions

Staged:

http://192.241.195.202:9000/staging/small-clarifications/linux/index.html
 2024-02-23 11:37:53 -07:00
Ravind Kumar
113cb2b75c Typo in minio client settings 2024-02-15 18:19:51 -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
Andrea Longo
2d00cf06e5 Doc updates for mc RELEASE.2024-01-05T05-04-32Z (#1112) 
Doc updates for these `mc` changes:

- New option for `mc mirror`: `--summary`
- Clarify `mc sql --json-input` also works with `.ndjson`

NDJSON clarified with a discussion in `mc sql` and an example of setting
`content-type` in `mc cp`.

Staged:

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-mirror.html#mc.mirror.-summary


http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-sql.html#mc.sql.-json-input

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-sql.html#input-formats

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-cp.html#add-a-content-type-value

Fixes https://github.com/minio/docs/issues/1104
 2024-01-23 08:58:14 -07:00
Andrea Longo
1e1c4c73f8 Doc updates for mc RELEASE.2024-01-11T05-49-32Z (#1110) 
Doc updates for the following:

- Document alias naming requirements, including new minimum length rules
- `mc tag set --exclude-folders` modifies the behavior of `--recursive`

Staged:

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-alias-set.html#mc.alias.set.ALIAS

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-tag-set.html#mc.tag.set.-exclude-folders

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

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2024-01-18 16:14:24 -07:00
mozafar
6367e30fb4 Update mc share download syntax (#1109) 
In following page the syntax section is not for download:

https://min.io/docs/minio/linux/reference/minio-mc/mc-share-download.html#syntax
This PR will changes syntax from upload  to download
 2024-01-16 17:19:39 -05:00
Andrea Longo
00f1c7f6c4 Clarify several small items in the mc reference (#1103) 
A few opportunistic text updates:

- `mc mirror` recommends `mc replicate` and `mc admin replicate` for
other use cases. Mention what they are for.
- Clarify that `mc version` creates a null version id for existing
unversioned objects when bucket versioning is enabled.


http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-mirror.html

http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-version.html#bucket-versioning-with-existing-data

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2024-01-05 09:38:16 -07:00
Andrea Longo
c5b43238d6 Remote tier needs DeleteObjectVersion if remote bucket is versioned (#1089) 
If the remote tier bucket is versioned, MinIO requires additional
permissions to successfully transition objects. But it is not
recommended, as each object version becomes a distinct object on the
remote tier.

This is not new, it was omitted from the docs. Mention, but discourage.

Staged:

http://192.241.195.202:9000/staging/DOCS-1016/linux/reference/minio-mc/mc-ilm-tier.html#transition-permissions

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

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2024-01-03 16:52:11 -07:00
Ravind Kumar
a065b7a29f DOCS-1083: MinIO Server Release RELEASE.2023-12-02T10-51-33Z (#1097) 
# Summary

Closes #1083 

Also reorganizes the batch framework pages. Could use additional
refinement, but considering that out of scope for now.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2024-01-02 14:25:04 -05:00
Daryl White
69315f3810 PowerShell commands and a request type for access management fix (#1100) 
- Fixes a request type in an access management table

Closes #1064

- Adds an admonition about PowerShell commands to Healthcheck API page

Closes #1086

Staged:
- [Request type
fix](http://192.241.195.202:9000/staging/cleanups/windows/administration/identity-access-management/policy-based-access-control.html#userpolicy.writeonly)
- [Healthcheck
API](http://192.241.195.202:9000/staging/cleanups/windows/operations/monitoring/healthcheck-probe.html)
 2024-01-02 13:25:39 -05:00
Daryl White
22d576bc79 Updates related to three MinIO Client Dec 2023 releases (#1098) 
Updates for three December 2023 MinIO Client releases.

1. mc RELEASE.2023-12-02T02-03-28Z
- Enable/disabe ilm expiration rule replication in site replication
config
    - New size filters for ilm rule add
    - Make STS related envvars alias specific
2.  mc RELEASE.2023-12-14T00-37-41Z
- Adds flags to `mc ilm rule add` to support service principals for
Azure tiers.
3.  mc RELEASE.2023-12-23T08-47-21Z  
    - Adds new `mc idp ldap accesskey create` command
    - Updates other `mc idp ldap accesskey` commands
    - Updates `mc license registe` command
    - Adds `--license` flag to `mc license reigster` command
    
Closes #1096
Closes #1088
Closes #1082
 2023-12-27 17:55:08 -05:00
jingsam
d97d63ae90 Use 9001 as the default console address port (#1081) 
As state in
https://github.com/minio/minio/pull/18561#issuecomment-1833303435 ,
consistent use 9001 as the console port， to avoid confusion for new
users.
 2023-12-26 10:20:14 -05:00
Daryl White
14e0a02d65 Changes for mc RELEASE.2023-12-20T07-14-22Z (#1091) 
Update one command for mc
[RELEASE.2023-12-20T07-14-22Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-12-20T07-14-22Z).

- Updates `mc ilm tier add` with new options.

Not staged.
Does not address any open issues.
 2023-12-20 10:52:46 -05:00
Will
36a4eff258 Fixes for mc-share-upload docs. (#1087) 
Hopefully this meets the current voice standards for docs. Main changes
are clarification of language around file vs. object and syntax fixes
for uploads.

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2023-12-13 13:25:40 -05:00
Ravind Kumar
dfa398f674 DOCS-1085: Typo in mc share 2023-12-12 12:38:49 -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
d3439a3b65 Updates for mc RELEASE.2023-11-06T04-19-23Z (#1068) 
- Adds additional mc environment variables.
- Updates `mc support diag` example output.
 2023-11-14 15:28:02 -05:00
Daryl White
3b5663ce54 Update for mc RELEASE.2023-11-10T21-37-17Z (#1067) 
Adds `--anonymize flag` to `mc support diag`.

Not linked to an issue.

Staged at
http://192.241.195.202:9000/staging/mc-11-10-23/linux/reference/minio-mc/mc-support-diag.html
 2023-11-14 13:26:04 -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
Ravind Kumar
6763b86c3c DOCS-1050: Fix error in mc cp docs 2023-10-27 14:33:06 -04:00
Daryl White
3769dd0173 Batch replication requires realtime tier (#1010) 
Based on discussion of https://github.com/minio/minio/pull/18044, adding
info to the batch replication doc about requiring a realtime tier for
replication.

Not staged.
 2023-10-04 10:46:30 -04:00
Daryl White
20124c9a59 Updates for mc RELEASE.2023-09-20T15-22-31Z (#1015) 
- Deprecates mc admin heal flags
- Adds info about healing colors
- Adds mc mirror --exclude-storageclass flag
    
Closes #1009
Closes #1005
 2023-09-29 17:47:55 -04:00
Ravind Kumar
a5d432729e Warn against using profiles using cpuio or trace 2023-09-25 16:30:51 -04:00
Daryl White
01606fbfa1 Updates for MinIO Server release 2023-08-04 (#1000) 
Updates for release 2023-08-04T17-40-21Z
    
- Adds info on new 10,000 version limit to appropriate pags
- Updates Grafana with site replication info

Closes #938
 2023-09-16 20:35:13 -04:00
Daryl White
28e415fd8c Updates for mc RELEASE.2023-08-29T22-55-06Z (#979) 
mc
[RELEASE.2023-08-29T22-55-06Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-08-29T22-55-06Z)
has changes that impact the docs:

- Adds `list` command to `mc admin kms key`
- Adds new group of `scanner` event types

There is no issue to track this release.
 2023-08-31 09:53:21 -05:00
Daryl White
9dabf28246 Add additional context for what local means in the batch context (#975) 
Closes #924
 2023-08-29 16:27:40 -05: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
aac614d083 Updates for Minio Server and mc releases (#958) 
Updates for mc and MinIO server releases
    
- Adds `client` command to mc support perf
- Adds new metrics
- Corrects typos and minor issues in metric related docs
    
Closes #955
Closes #956
 2023-08-21 13:02:04 -05:00
Andrea Longo
9ea539b8ab Restructure/expand mc idp ldap reference pages (#959) 
Improve the AD/LDAP reference docs:

- Break up `mc idp ldap` and `mc idp ldap policy` into parents/children.
- Add commands from the `identity_ldap` configuration key to `mc idp
ldap add` and `mc idp ldap update`.
- Update links from relevant envvars to `mc idp ldap` instead of
`identity_ldap`
- Fix stuff that needs fixing.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap.html

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap-policy.html
Fixes https://github.com/minio/docs/issues/940

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-08-18 13:50:15 -06:00
Andrea Longo
8f598693f0 Updated LDAP docs (#939) 
Update the AD/LDAP configuration instructions, including adding details
about configuring with Console.

Includes reformatting some existing content.

Questions:
- What, exactly, is the status of the `mc admin config identity_ldap`
settings? Deprecated? There, but not recommended for new configurations?
- Are the "all settings" examples correct and appropriate? I'm not clear
if `mc idp ldap` supports the same settings with the same names as
`identity_ldap`.

Staged:

http://192.241.195.202:9000/staging/DOCS-919/linux/html/operations/external-iam/configure-ad-ldap-external-identity-management.html

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

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-08-10 09:44:12 -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
Andrea Longo
6227f8b736 Fix syntax in mc version reference page (#917) 
Fix incorrect commands syntax detail.

Includes a general reformat. For just the items noted in the issue, see
the first commit.

Staged:

http://192.241.195.202:9000/staging/DOCS-916/linux/html/reference/minio-mc/mc-version.html
Fixes  https://github.com/minio/docs/issues/916
 2023-07-14 16:20:45 -06: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
Andrea Longo
f5643ea7a5 mc ping --exit and mc admin user svcacct add/edit --expiry (#901) 
Doc updates from [mc
RELEASE.2023-05-30T22-41-38Z](https://github.com/minio/docs/issues/870):

[x] New --exit option for mc ping 
[x] Expiration date can be set when adding or editing a service account

Staged:

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc/mc-ping.html#mc.ping.-exit

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html#mc.admin.user.svcacct.add.-expiry

http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html#mc.admin.user.svcacct.edit.-expiry

Fixes https://github.com/minio/docs/issues/870
 2023-06-29 15:11:52 -06: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
874b56eaeb Partial update for mc RELEASE.2023-05-26T23-31-54Z (#877) 
Update reference docs for recent changes:

* `mc admin user svcacct ls` service account expiration date
* `mc ilm rule ls`  `updateAt` policy mod time

Staged:

http://192.241.195.202:9000/staging/DOCS-866/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-list.html

file:///Users/andrealongo/repos/docs/build/DOCS-866/linux/html/reference/minio-mc/mc-ilm-rule-ls.html#show-policy-modification-time

Partially addresses https://github.com/minio/docs/issues/866
 2023-06-09 14:51:19 -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
Daryl White
7f200b96b6 Correcting build warning messages (#875) 
This corrects several build errors that had accrued in the docs.
 2023-06-07 15:01:25 -05: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
Fredrik Carlbom
9f95069315 DOCS-855 - Fix spelling of 'Configured' (#856) 
Co-authored-by: Fredrik Carlbom <fredrik.carlbom@sectra.com>
 2023-05-17 10:43:22 -04:00
Daryl White
947b16155a Updates docs of mc release RELEASE.2023-04-12T02-21-51Z (#850) 
- Adds info to `mc ilm restore` about using `mc stat`
- Adds additional flag to `mc admin replicate update` syntax
- Adds metadata tags flags to `mc find`, plus examples

Closes #815
 2023-05-12 11:36:19 -05:00