1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Commit Graph

618 Commits

Author SHA1 Message Date
dcf826d25d Adds Enterprise docs link to dropdown switcher 2024-03-11 20:34:36 -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
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
0a03ca0b38 Minor update to thresholds 2024-02-14 13:49:48 -05:00
3203cf7c3e OPTIMIZATION: Storage, Capacity, and Prerequisites (#1118)
No related issue here, just freewheeling from an internal request.

This started with the request to change our recommendation around
label/uuid-based drive mounting to a requirement.

Looking at the pages I feel like our pre-req and considerations are a
little long in the tooth, and are at least slightly duplicative of what
is on the checklist pages (hardware, software)

This is at least a first swing at tidying things up. I think in a second
pass I'll move more of the pre-reqs into the Hardware/Software/Security
checklist pages, and keep the on-tutorial sections as simple defnlists
so that the page flows more easily. We can push users to the details if
they want it while keeping the high level requirements there.

Noting this does **not** yet address the new features related to
non-sequential hostname support. That has to come later.

---------

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-02-14 13:09:59 -05:00
24ee2ef360 More RoleARN->RoleArn (#1128)
Replace additional occurrences of incorrect `RoleARN` with `RoleArn`.

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

Remaining item, fixes https://github.com/minio/docs/issues/1102
2024-02-12 08:08:25 -07:00
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
56661b54c2 typo in header for KES + Azure 2024-02-09 12:05:40 -05:00
d225451bc3 Reminder to install mc, not Midnight Commander (#1121)
Add admonition to the Linux `mc` install steps about installing the
correct binary from `dl.min.io`. If you use your native package manager,
you are very likely to get GNU Midnight Commander instead.

Staged

http://192.241.195.202:9000/staging/not-midnight-commander/linux/reference/minio-mc.html#install-mc
2024-02-06 15:58:50 -07:00
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
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
042d0c7145 Including Console Address in systemd envvar file 2024-01-30 12:18:31 -05:00
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
d6eca4384f Fixing trailing slash in URL 2024-01-26 12:10:31 -05:00
31bd45f20f DOCS-1084: Fix deployment menus for Windows, macos, containers, Add s… (#1108)
…cript for xfs settings to Linux"

Closes #1084 

Accomplishing a few things here:

1. General tidy-up of the installation pages so Windows/Container/MacOS
only display the appropriate deployment topos
2. Better admonitions/guidance on when to use what distribution
3. Added a section on Storage + XFS Settings to resolve an ongoing
customer request


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-23 14:12:11 -05:00
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
6f00040411 Update common-minio-oidc.rst
jwt:PreferredUsername -> jwt:preferred_username
2024-01-23 10:17:11 -05:00
e7d76fd1db Change port to 9090 for port forward command for helm minio-operator (#1114)
Installing the latest minio operator helm chart sets the console port to
9090 not 9001. I fixed the port in the port-forward command.
```
k get svc -n minio-operator 
NAME       TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
console    ClusterIP   10.97.140.40    <none>        9090/TCP,9443/TCP   21m
operator   ClusterIP   10.106.20.115   <none>        4221/TCP            21m
sts        ClusterIP   10.106.182.83   <none>        4223/TCP            21m
```
2024-01-22 13:16:34 -05:00
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
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
7c8e761fd3 Fixup for node restart -> server process restart 2024-01-12 10:40:29 -05:00
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
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
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
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
faf5c8a3ef Guidance on removal of --config-dir | -C 2023-12-29 15:23:27 -05:00
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
a47db59b39 Fix admonition font-size (#1099) 2023-12-27 11:29:32 -05:00
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
2acf572489 Fix the name of RoleArn param in AssumeRoleWithWebIdentity requests (#1095)
In `AssumeRoleWithWebIdentity` requests, the RoleArn form paramter is
designated to specify the role to be assumed. It is crucial to note that
the correct key is RoleArn, not RoleARN.

When I used the "RoleARN" form key instead of "RoleArn," I encountered
an error similar to the following:
```xml
<ErrorResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"><Error><Type></Type><Code>InvalidParameterValue</Code><Message>Role arn:minio:iam:::role/dummy-internal does not exist</Message></Error><RequestId>XXX</RequestId></ErrorResponse>
```

Despite this, certain documentation erroneously employs RoleARN. To
rectify this inconsistency, I have replaced the instances of RoleARN
with the correct RoleArn. However, for other documents that use RoleARN
without specifying the form parameter, no modifications have been made.

Ref:
ba245c6c46/cmd/sts-handlers.go (L50C2-L50C12)
2023-12-26 10:18:04 -05:00
ed2553efc8 Add DirectPV docs link to dropdown switcher (#1094)
- Adds the DirectPV docs to the doc switcher
- Adds a external links reference for the DirectPV Docs

Staged:
http://192.241.195.202:9000/staging/directpv-docs-link/linux/index.html
2023-12-21 12:30:51 -05:00
790af1ad67 Add Training link (#1093)
Fixes https://github.com/minio/docs/issues/1092
2023-12-21 10:15:24 -05:00
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
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
dfa398f674 DOCS-1085: Typo in mc share 2023-12-12 12:38:49 -05:00