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
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。
2024-03-06 08:53:31 -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
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
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
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
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
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
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
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
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
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
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
072b82c1e4
Fixing default values for RRS storage class
2023-11-28 16:46:53 -05:00
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
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
09ce8edb48
Updates for two October releases ( #1065 )
...
- Adds additional flag for `mc admin trace`
- Adds info about supported secret types for k8s
Closes #1039
For the `mc admin trace --stats` flag, also adding example output.
Closes #1045
2023-11-15 11:58:16 -05:00
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
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
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
ca23b065b2
Correcting mc-conf errors ( #1061 )
...
Corrects errors from `mc-conf` references not noticed until after
merging #1028 .
No issue to track it.
2023-11-03 14:13:08 -04:00
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
2a10ceabdc
remove out of context doc ( #1053 )
2023-10-30 15:50:31 -04:00
6763b86c3c
DOCS-1050: Fix error in mc cp docs
2023-10-27 14:33:06 -04:00
1747558ffc
Doc updates for mc RELEASE.2023-10-04T06-52-56Z ( #1044 )
...
Doc updates for mc release
[2023-10-04T06-52-56Z](https://github.com/minio/docs/issues/1035 )
- [x] `resource` type for Prometheus metrics
- [x] Doc `mc admin trace --request-query`, ~maybe it and some other
should be hidden from `mc --help`?~
Staged:
http://192.241.195.202:9000/staging/DOCS-1035/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html
Fixes https://github.com/minio/docs/issues/1035
2023-10-23 15:17:50 -06:00
69e291fa6e
DOCS-1007: Create sync pattern to pull in the CRD during releases ( #1025 )
...
Closes #1007
2023-10-10 16:45:06 -04:00
d96f3ee959
Correcting Repository Link ( #1032 )
...
### Objective:
To set the correct repository in our Official Documentation.
### Related:
To fix: https://github.com/minio/operator/issues/1453
### Explanation:
TBD
2023-10-10 13:02:03 -04:00
13067accd9
Removing nonexistant flag ( #1031 )
...
### Objective:
To correct our documentation because `--default-console-image` does not
exist in our Operator plugin.
### Related:
* This is related to https://github.com/minio/operator/issues/1453 but
will partially fix the issue, there is more work to do. I will create
another PR for the missing update spot.
2023-10-10 12:37:31 -04:00
6a1697c9f5
DOCS-1022: Use 'mc idp ldap policy' for AD/LDAP policy assignments ( #1026 )
...
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2023-10-05 16:59:43 -04:00
091a321e32
Improve mc deprecated reference: cleanup, move mc admin top ( #1019 )
...
First batch of mc deprecation cleanup:
[x] Reorder section TOC: `mc` alphabetical, then `mc admin`
alphabetical.
[x] Standardize deprecation notice format and wording.
[x] Move `mc admin top` to deprecated section.
Staged
http://192.241.195.202:9000/staging/DOCS-896-cleanup-mc-admin-top/linux/reference/minio-mc-deprecated.html
Partially addresses https://github.com/minio/docs/issues/896
2023-10-05 10:29:02 -06:00
72d4eb9df9
Adds envvar for Console functionality ( #1014 )
...
Adds two new envvar
Closes #1006
Staged:
http://192.241.195.202:9000/staging/server-2023-09-16/linux/reference/minio-server/minio-server.html#envvar.MINIO_PROMETHEUS_AUTH_TOKEN
2023-10-04 16:43:20 -04:00
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
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
962835b758
Updates for mc RELEASE.2023-08-30T08-02-26Z ( #1013 )
...
Adds example output for `mc admin replicate status` to reflect expanded
output.
Closes #988
2023-09-28 14:00:23 -04:00
a5d432729e
Warn against using profiles using cpuio or trace
2023-09-25 16:30:51 -04:00
62e1447422
Document OpenShift service certificates for Operator deployments ( #1002 )
...
MinIO Operator on OpenShift may require manual configuration of TLS cert
management via the OpenShift `service-ca` Operator. (For deployments
that are _not_ done through Red Hat OperatorHub.)
Document the needed envvars, `volumes`, and `volumeMounts` to enable
`service-ca` and avoid the need to manually renew certs.
~Note: This presumes kustomize, additional research/testing required to
determine configuration for Helm chart deployments.~
Staged
http://192.241.195.202:9000/staging/DOCS-991/openshift/operations/installation.html#procedure
See also:
https://github.com/minio/wiki/wiki/Besides-MINIO_OPERATOR_RUNTIME-what-else-is-needed-in-Operator%3F
Fixes https://github.com/minio/docs/issues/991 (remaining item for
v5.0.8)
---------
Co-authored-by: Ravind Kumar <ravind@min.io >
2023-09-25 11:27:06 -04:00
