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

751 Commits

Author SHA1 Message Date
24d445c35a Replace mc admin console references with mc admin logs (#1198)
mc admin console command is depreciated, users should start using mc
admin logs instead.
2024-05-06 14:31:40 -04:00
7be620fd13 Deprecates the long-dead mc admin console command (#1204)
Corrects most references to point to the current command.

Additional references to deprecated command fixed by PR #1198 .
We should merge 1198 at the same time we merge this one.
2024-05-06 14:30:36 -04:00
72e56b4d98 Note that mc support perf suspends other S3 API calls for testing (#1199)
Add information about queuing requests for `drive` and `net` options.

See https://github.com/minio/minio/pull/19634

Staged:

http://192.241.195.202:9000/staging/mc-support-perf-s3-api/linux/reference/minio-mc/mc-support-perf.html#description
2024-05-03 08:13:54 -06:00
748f1e075d Typo in exclusive volume access admonition (#1197)
oops typo
2024-04-25 14:32:39 -04:00
96224468c4 Add concept pages for Scanner and Healing (#1192)
Adds concept pages for healing and the scanner.
Updates other related files for better context.
    
Adds ref links and other related updates.
    
Closes #1168
2024-04-25 14:27:25 -04:00
c676da2376 Adds an admonition for exclusive drive access (#1196)
Admonition added as an include, then put in many files throughout the
docs.
Where it is included, it's the same admonition and text.

It's worth making sure where I placed the include makes sense.

Closes #1186
2024-04-25 14:19:30 -04:00
8b24974faf Fix remove references (#1195)
@allanrogerr Noticed that our `mc cp` page had references to removing
objects, almost certainly due to a copy/paste error. This fixes those
references.
2024-04-24 15:09:12 -04:00
85ef20c21a Fix typos (#1189) 2024-04-17 17:57:48 -04:00
e71bbe9040 Quick Fix: KES Guidance (#1187)
We already state on one page that you cannot undo KES once configured.

This ensures we make that statement on all other relevant pages.

Staged:

-
http://192.241.195.202:9000/staging/QUICKFIX/linux/operations/server-side-encryption.html
- SSE-KMS and SSE-S3 tabs
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/operations/server-side-encryption/configure-minio-kes.html
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption.html
SSE KMS and SSE-S3 Tabs
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption/server-side-encryption-sse-kms.html#quickstart
-
http://192.241.195.202:9000/staging/QUICKFIX/linux/administration/server-side-encryption/server-side-encryption-sse-s3.html#quickstart
2024-04-15 14:58:26 -04:00
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
0739fc8e43 Replace dead URL (#1184)
The URL we were using for StartTLS is no longer valid.
This replaces that with a link to the specification that covers StartTLS
and mentions the specific section to go to.
2024-04-12 09:47:37 -04:00
24cde64392 Changing admonition for erasure set to warning 2024-04-11 12:07:23 -04:00
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
f9614765a8 Removing deprecated or irrelevant APIs 2024-04-10 16:50:16 -04:00
51a24f92bd Update top navigation (#1182)
This commit adds the Architecture and Equinix pages to the top
navigation.
2024-04-10 11:09:50 -04:00
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
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
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
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
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
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
c9505be39d Revert "MinIO Server releases and other fixes (#1172)"
This reverts commit 2488541cd0.
2024-03-27 18:00:59 -04:00
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
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
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
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
b7e08de9eb metrics must show relevant yaml per tab selection (#1163) 2024-03-19 16:38:28 -04:00
a335fd7495 Dropping admonitions, review and revisit later 2024-03-18 15:50:11 -04:00
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
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
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
ceb3efbf33 Fix footer img 2024-03-13 22:44:42 -07:00
417f77a603 Custom deployments are required to edit YAML manually (#1156)
Custom deployments are required to edit YAML manually to fulfill certain
requirements or limitations such as those on resource requests.

Fixes https://github.com/minio/operator/issues/1204

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2024-03-13 14:57:56 -07:00
7b355d14de Update top navigation to match the parent site (#1154) 2024-03-13 11:15:57 -04:00
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
54584b290c Adds recommended metrics to Prometheus procedure (#1147)
Partially addresses #1135

To consider:
I added the tabs as part of step 3 of the procedure, but we might want
to consider having a recommended alerts section separate from the
procedure, perhaps above the "Dashboards" heading. Let me know your
thoughts.
2024-03-08 12:29:40 -05:00
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
1ccef6501b Fix cert directory in TLS doc (#1151)
Quick fix per internal discussion.
2024-03-07 17:25:12 -05:00
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
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
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
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
77be96d492 Corrects the description for an envvar. (#1145)
Closes #1132
2024-03-04 16:51:53 -05:00
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
b4d0a36c71 Allow links into closed tabs (#1126)
JS update to allow a link into a closed tab. 

Tested with 
```
:mc-conf:`~browser.hsts_seconds`
```
which goes to a tab in [this
section](https://min.io/docs/minio/linux/reference/minio-server/settings/console.html#strict-transport-security)

@rushenn Ravind and Andrea came up with this, need a JS intervention to
ensure it's actually reasonable. 🙏🏻

Staged

http://192.241.195.202:9000/staging/link-into-tab/linux/reference/minio-server/settings/console.html#strict-transport-security

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
Co-authored-by: Rushan <rushenn123@gmail.com>
2024-02-23 11:40:26 -07:00
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
68cc210ed4 Fix nav color on dark mode (#1139) 2024-02-23 09:58:05 +04:00
3fcd2ee7a1 Update top-navigation as per the new min.io design specs (#1137)
Part of https://github.com/miniohq/min.io/issues/2000
2024-02-22 12:06:44 -05:00
113cb2b75c Typo in minio client settings 2024-02-15 18:19:51 -05:00
75574cf03f Typo caught 2024-02-15 11:07:57 -05:00