1
0
mirror of https://github.com/minio/docs.git synced 2025-04-21 08:05:59 +03:00

318 Commits

Author SHA1 Message Date
Daryl White
24dd7edf49
Adding info about the MINIO_OPTS envvar (#1185)
We didn't discuss `MINIO_OPTS` anywhere.
This adds it.
2024-04-12 16:39:52 -04:00
Ravind Kumar
24cde64392 Changing admonition for erasure set to warning 2024-04-11 12:07:23 -04:00
Ravind Kumar
c06a77403e
MinIO Erasure Stripe Size (#1183)
Staged:
http://192.241.195.202:9000/staging/ERASURE_STRIPE_SIZE/linux/reference/minio-server/settings/core.html#erasure-stripe-size

# Overview

We get somewhat frequent inquiries on how to set a stripe size.

We're going to document the option, but heavily emphasize how carefully
this needs to be handled

The defaults are *almost always* the best choice.

We are not going to provide any additional guidance here.

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-04-10 17:46:08 -04:00
Ravind Kumar
f9614765a8 Removing deprecated or irrelevant APIs 2024-04-10 16:50:16 -04:00
Ravind Kumar
e4f76ba1cf
DOCS-1178: Add S3 API Compatibility List (#1180)
Closes #1178 

This covers the S3 APIs which we directly support - reference
minio/minio/cmd/api-router.go

Any APIs which are marked as 'dummy' internally are considered
'unsupported'
Admin APIs are out of scope here
MinIO API extensions are out of scope as well

We are not doing any detailed reference - just pointing out to S3

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-04-05 17:28:43 -04:00
Daryl White
96c0d232f8
Updates for several releases and issues (#1179)
Updates for server RELEASE.2024-03-30T09-41-56Z
    
- Adds information that SSE-C encrypted objects can now replicate.
    
Closes #1177

- Adds information on operator renewal of tenant certificates
    
Closes #1167

- Corrects a description for `ilm restore` function
    
Closes #1175

Updates for Console release 0.45.0
    
- Removes healing references
- Updates headings and subheadings for the current Console UI
    
Closes #1107
2024-04-05 16:43:32 -04:00
Andrea Longo
005ac5c126
missing changes from PR 1171 (#1176)
Oops did not type something correctly, this should have been included in
https://github.com/minio/docs/pull/1171
2024-04-02 09:21:34 -06:00
Andrea Longo
b0ab2be7ba
New kubectl minio flags (#1171)
New option `--volumes-per-server` for `kubectl minio tenant create` and
`kubectl minio tenant expand`.

Staged


http://192.241.195.202:9000/staging/DOCS-1129-kubectl/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.html#kubectl.minio.tenant.create.-volumes

http://192.241.195.202:9000/staging/DOCS-1129-kubectl/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-expand.html#kubectl.minio.tenant.expand.-volumes

Partly addresses https://github.com/minio/docs/issues/1129
2024-04-01 16:14:09 -06: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
Ravind Kumar
ef81b3d357
Server updates (#1173)
## 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
2024-03-28 17:07:39 -04:00
Ravind Kumar
c9505be39d Revert "MinIO Server releases and other fixes (#1172)"
This reverts commit 2488541cd0d2c22c358684d47e726baf4dfc35a3.
2024-03-27 18:00:59 -04:00
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
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
Daryl White
909178a753
Correcting envvar address for redis (#1161)
Corrects the documentation per
https://github.com/minio/minio/issues/19284.
The address should not have the `user:password` as part of it.

This matches the envvar setting for address to what we already had for
the config setting.
2024-03-18 10:01:43 -04:00
Daryl White
3a52f00cb7
Release work for two server releases (#1157)
Release work for Server RELEASE.2024-03-03T17-50-39Z
    
- Adds new NATS config
- Adds new ilm configs
- Adds info on having a KMS auto generate root credentials
 
Closes #1144

Release work for Server RELEASE.2024-03-10T02-53-48Z
    
- Corrects a missing URL excludes line for some builds
- Adds new webhook options
    
Closes #1155

Staged:
- [Webhook
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/metrics-and-logging.html#envvar.MINIO_AUDIT_WEBHOOK_BATCH_SIZE)
- [NATS
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/notifications/nats.html#user-credentials-file)
- [Root
credentials](http://192.241.195.202:9000/staging/release-work/linux/operations/install-deploy-manage/deploy-minio-single-node-single-drive.html#create-the-environment-variable-file)
- [ILM
config](http://192.241.195.202:9000/staging/release-work/linux/reference/minio-server/settings/ilm.html)
2024-03-14 17:28:29 -04:00
Ravind Kumar
67e81ce2f8
Multiple SERVER Releases (#1141)
MinIO SERVER RELEASE.2024-01-05T22-17-24Z - added new metrics to
github.com/minio/minio for later sync

MinIO SERVER RELEASE.2024-01-28T22-35-53Z - MinIO preallocates memory,
mc update compresses binary in transit MinIO SERVER
RELEASE.2024-02-06T21-36-22Z -

MinIO adds condition key for restricting STS AssumeRoleWithWebIdentity
duration at policy level

Closes #1124 , 

Partially addresses #1116 
Partially Addresses #1105


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-03-11 10:06:46 -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
fa4e28f78c
Splits the helm chart reference page (#1142)
Internal request to split the Operator and Tenant helm chart into
separate pages.

This adds a replacement link in default-conf to automate updating the
operator version in the URL.
2024-03-06 09:29:08 -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
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
cb2aa233a0
Simplify SSE tutorials and refer to KES docs (#1136)
This PR simplifies the management of KMS integrations by removing the
detailed documentation and linking out to the KES docs site instead.

There should be no mention of any specific KMS target.
Each OS/platform should have references to the correct paths, OS, and
the like.

This completes work started on the KES docs side in
https://github.com/minio/kes-docs/pull/48.

Staged:

-
[Linux](http://192.241.195.202:9000/staging/ssekms/linux/operations/server-side-encryption/configure-minio-kes.html)
-
[Windows](http://192.241.195.202:9000/staging/ssekms/windows/operations/server-side-encryption/configure-minio-kes.html)
-
[Kubernetes](http://192.241.195.202:9000/staging/ssekms/k8s/operations/server-side-encryption/configure-minio-kes.html)
-
[Containers](http://192.241.195.202:9000/staging/ssekms/container/operations/server-side-encryption/configure-minio-kes.html)
-
[MacOS](http://192.241.195.202:9000/staging/ssekms/macos/operations/server-side-encryption/configure-minio-kes.html)
2024-02-29 12:30:06 -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
Ravind Kumar
75574cf03f Typo caught 2024-02-15 11:07:57 -05:00
Ravind Kumar
4edb3f7bae
Improve documentation on MINIO_DOMAIN (#1131)
# Summary

As per a recent customer issue, our guidance on `MINIO_DOMAIN` and
path/virtual bucket lookups needs some attention.

There are two main areas to address:

1. We need to guide users to avoid namespace collision within the
`MINIO_DOMAIN` , as this causes bucket lookup issues with certain MinIO
services/features
2. We need to generally improve docs on setting `MINIO_DOMAIN` correctly

There is also a side objective from Engineering to ensure we have a
simple admonition to direct users to test wherever possible changes to
config settings before applying to production.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-02-14 17:16:58 -05:00
Andrea Longo
431675e429
Document security header envvars and config items (#1122)
New settings to configure security headers for requests returned from
MinIO Console.

- `Content-Security-Policy`
- `Strict-Transport-Security`
- `Referrer-Policy`

Staged

http://192.241.195.202:9000/staging/DOCS-1102/linux/reference/minio-server/settings/console.html#content-security-policy

Partially addresses https://github.com/minio/docs/issues/1102

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-02-09 11:12:37 -07:00
Ravind Kumar
a7acdcdfe8
DOCS-1076: Operator v5.0.11 Release (#1117)
Closes #1076 

Smaller than I expected, and a few things I don't think we need to
document.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/developers/sts-for-operator.html
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.html#kubectl.minio.tenant.create.-kes-image
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete.html#kubectl.minio.tenant.delete.-retain-namespace
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/operator-environment-variables.html

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-31 19:17:57 -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
5cba0951fb
DOCS-1090: Document Access Management Plugin (#1115)
Closes #1090 

Simple enough - document that which was previously only on github.

Doing a minimal pass here, no core tutorial, just basics.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1090/linux/administration/identity-access-management/pluggable-authorization.html
-
http://192.241.195.202:9000/staging/DOCS-1090/linux/reference/minio-server/settings/iam/minio-access-plugin.html#

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-30 11:15:25 -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
Ravind Kumar
faf5c8a3ef Guidance on removal of --config-dir | -C 2023-12-29 15:23:27 -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
072b82c1e4 Fixing default values for RRS storage class 2023-11-28 16:46:53 -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
Ravind Kumar
c770ba9d76
DOCS-1021: Adding helm information (#1060)
Closes #1021 
Closes #1055 
Closes #968 
Closes #943 


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
2023-11-16 12:56:20 -05:00