1
0
mirror of https://github.com/minio/docs.git synced 2025-04-30 20:44:55 +03:00

218 Commits

Author SHA1 Message Date
Ravind Kumar
7732ef45c7 one more drive by fix 2025-02-25 17:33:53 -05:00
Ravind Kumar
97c35f87b9 Removing mention of Apple M1/M2 on Linux ARM instructions 2025-02-25 17:26:04 -05:00
Ravind Kumar
51d5f9c215 fixup to redhat ocp support language 2025-02-18 18:50:36 -05:00
Allan Roger Reid
2208441e31
Specify RFC3339 and not ISO-8601 data and time (#1419)
MinIO uses RFC3339 data and time formatting and not ISO-8601. RFC3339
requires that there be a `T` as part of the data and time separation.
ISO-8601 allows a space.
The documentation also currently refers to using a date in the batch
framework; this should be a RFC3339 date and time.
e.g.
```
mc batch start play expire.yaml
mc: <ERROR> Unable to start job. We encountered an internal error, please try again.: cause(parsing time "2006-01-02 15:04:05.00Z" as "2006-01-02T15:04:05Z07:00": cannot parse " 15:04:05.00Z" as "T").

```

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2025-02-18 14:25:57 -05:00
Jennifer Rondeau
340444e205
correct parent flag for mkdir in installation content (#1417)
Flag is lower case, not upper case.

Caught while testing

Not (manually) staged.
2025-02-13 11:22:52 -05:00
Ravind Kumar
265af648e2
Removing references to openshift container platform, bumping CRD (#1415)
# Summary

We removed support for deploying via OpenShift operatorhub / marketplace
a few months back. The burden of maintaining the certifications/process
required was sufficient to pull that feature set out moving forward and
migrate it to AIStor as part of a more complete enterprise offering.

For now we need to remove references to the operator hub / marketplace.
It is possible that the Openshift Kubernetes Engine may work w/ our
stock kubernetes installation paths, but we do not have resources to
test.

So for the immediate term, we're just going to pull whats outdated.

Also throwing in a fixup to the CRDs - I ran into a weird issue where I
had to `pip3 install asciidoc` before the sync-operator-crd-docs job
worked, am looking into that separately.

Staged:
http://192.241.195.202:9000/staging/openshift-fixup/openshift/index.html
2025-02-11 14:00:44 -05:00
Daryl White
b68915278c
Install page quickstarts generated multiple H1s (#1411)
Include files for quickstarts had a page title that resulted in a
duplicate H1. This removes the duplicate and moves the links for video
to the index.rst page.

Opportunity fix of an unrelated build error.

Closes #1408
2025-02-07 11:26:50 -05:00
Daryl White
3fd12ad26e
Correct upgrade command (#1401)
Per internal discussion, the command to update MinIO in an airgapped
environment should point to `minio.sha256sum`.
2025-01-30 08:38:29 -05:00
Allan Roger Reid
c9db0b63e5
Update common-installation.rst (#1389)
See https://miniohq.slack.com/archives/C03VDE2R9ED/p1734487467518789

The admonition in
https://min.io/docs/minio/linux/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#storage-requirements
should read:
`MinIO limits the size used per drive to the smallest drive in the
pool.`
instead of
`MinIO limits the size used per drive to the smallest drive in the
deployment.`
2024-12-18 07:44:49 -07:00
Daryl White
cfaedc843c
Minor fixes for several smaller issues (#1380)
- Adds missing config settings throughout storage class page.
    
  Closes #1349
    
- Adds instructions for adding certificates for connecting by sftp.
    
  Closes #1354
    
- Corrects information about which key to use for self-signed CAs.
    
  Closes #1358
    
- Moves `context` to optional for batch key rotate jobs.
    
  Closes #1356

- clean up missing ref links causing build warnings.
2024-12-04 11:17:52 -05:00
Andrea Longo
48feb40740
Remove references to various ex MinIO Console features (#1373)
UI for the following has been removed from MinIO Console:

- Lifecycle and tiering
- Site replication
- SUBNET

Waiting for merge of https://github.com/minio/console/pull/3472

Staged:

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/minio-console.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/bucket-replication.html

http://192.241.195.202:9000/staging/DOCS-1372/linux/operations/install-deploy-manage/multi-site-replication.html#id4


fixes https://github.com/minio/docs/issues/1372

---------

Co-authored-by: Jennifer Rondeau <Bradamant3@users.noreply.github.com>
2024-11-26 14:17:12 -07:00
Guillaume Michaud
0b1d9a7751
Fix console port number (#1370) 2024-11-20 16:57:18 -05:00
Andrea Longo
0747c9a191
mention that tiny files are not compressed, also other typos (#1357)
Came up in a customer issue. Specifically the threshold is 4 kb and
there is no configuration option. (Nor does Klaus want one.)

Worth adding? With how much detail? The threshold choice is because of
typical block size on disk. You will use at least that much anyway so
why bother compressing.

Staged:


http://192.241.195.202:9000/staging/dont-compress-small-objects/linux/administration/object-management/data-compression.html#excluded-file-types

Drive-by fix tacked onto this PR: correct typos in some `mc anonymous`
examples.

Staged:

http://192.241.195.202:9000/staging/dont-compress-small-objects/linux/reference/minio-mc/mc-anonymous.html

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Ravind Kumar <ravind@min.io>
2024-10-25 14:52:33 -06:00
Ravind Kumar
f3f32063ce Remove outdated reference 2024-10-25 10:55:04 -04:00
Daryl White
b79934f11d
Bug fixes for two issues related to LDAP and site replication (#1348)
Corrects docs to state that when expanding a site replication peer set,
you must list all existing peers.

Closes #1340 

Adds information that when adding Distinguished Names as search
parameters, multiple DNs must be separated with a semi-colon.

Closes #1341
2024-10-10 16:22:00 -04:00
Daryl White
07a1569e87
Adds language about having write permission to use mc admin update (#1346)
Closes #1301

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-10-09 11:04:26 -04:00
Jennifer Rondeau
fd2a339d48
Correct instructions for single-node single-drive deploy on linux (#1338)
Common include for single-node deployments describes multi-drive, which
is wrong for single-drive. Replaced include with inline content that
specifies only a single drive everywhere.

Incidentally fixed list indentation in override, copied fix into include
as well.

Fixes: 

https://github.com/minio/docs/issues/1330

Staged:

[Deploy MinIO: Single-Node
Single-Drive](http://192.241.195.202:9000/staging/DOC-1330/linux/operations/install-deploy-manage/deploy-minio-single-node-single-drive.html)

(edited include not available to review on staging -- applies to macos
or docker/container -- but checked locally)
2024-10-04 13:40:40 -04:00
Daryl White
36f5bea8ea
Updating encryption pages for KES API (#1333)
Our preferred method for authenticating from MinIO to KES is with an API
identity. This PR updates encryption docs to reflect this.

Closes #1280
2024-10-03 12:38:10 -04:00
Daryl White
ca34aa7e43
Add cert-manager documentation (#1317)
Adds cert-manager docs for Kubernetes outputs.

Closes #1245 

Partially addresses #1273
2024-10-01 16:06:37 -04:00
Krutika Dhananjay
04ff269e7c
Add missing alias name in mc-alias-set example command (#1329)
Go to
https://min.io/docs/minio/linux/operations/install-deploy-manage/deploy-minio-single-node-multi-drive.html#connect-to-the-minio-service
Under the tab MinIO CLI (mc):
The command for creating mc alias is displayed as `mc alias set
http://localhost:9000 myminioadmin minio-secret-key-change-me`. Note
that the parameter for alias-name is missing here. This PR adds the
missing alias name.

---------

Co-authored-by: Krutika Dhananjay <krutika@minio.io>
2024-09-23 09:02:09 -04:00
Ravind Kumar
2285c68f1e Catchup to 6.0.3 release 2024-09-09 13:20:06 -04:00
Ravind Kumar
76e5e35ab3
DOCS-1191: Updating SSE params, general fixups (#1295)
Closes #1191 

# Summary

Finally getting around to this mc release

- Added docs for enc-c, enc-s3, enc-kms
- Some docs are making assumptions around behavior that needs to be
fixed _first_
- Drive-by linker fixes

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

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-08-26 11:54:49 -04:00
Daryl White
f7509c1ac9
Updates related to Operator 6.0.0 release (#1290)
Partially addresses #1273.

- Secrets no longer stored in tenant
- Changes to the sidecar container, including moving envvars
2024-08-14 18:27:09 -04:00
Ravind Kumar
b05ae61a55
DOCS-1291: Removing trailing operator console references, fixing broken refs (#1292)
Closes #1291 

Missed a few log lines referencing Operator Console.

Also cleaning up some broken refs and further simplifying references to
the Console when in context of Tenant/MinIO Object Store.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-08-05 16:06:55 -04:00
Ravind Kumar
23253dd71c
DOCS-1273: Operator 6.0.0 Deploy/Upgrade docs, removing Console references (#1284)
Addresses #1273 

# Summary

This pass does three things:

1. Updates all tutorials related to Operator/Tenant deployment for
Kustomize and Helm
2. Removes references to Operator Console + updates to reference
Kustomize/Helm wherever possible
3. Slightly tidies up old or dangling references

This pass does not do these things:

- Link out heavily to Kubernetes docs (for later)
- Clean up organization (singleplat build handles this)
- Addresses OpenShift, Rancher, etc.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Allan Roger Reid <allanrogerreid@gmail.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-08-01 15:51:39 -04:00
Daryl White
529e67dc7e
Changes for several issues related to SFTP and LDAP (#1252)
- Adds info the docs about recent changes to LDAP and SFTP
authentication
- Adds new config/envvar parameter
- Adds new sftp option for server
- Adds new example for forcing ldap or sa auth to SFTP
- Adds new example for using certificate authority for auth to SFTP

Closes #1240
Closes #1229
Closes #1226
Closes #1208
2024-07-15 14:30:19 -04:00
Andrea Longo
511aa87da4
Clarify pool ordering for add after decom (#1267)
If you decommission one pool from a multiple pool deployment, you can't
reuse the same node (hostname) sequence for a new pool. If you are using
expansion notation to define a set of hostnames for the pool, each new
pool must continue the numerical sequence even if some pools were
decommissioned along the way.


Staged

linux

http://192.241.195.202:9000/staging/DOCS-1250/linux/operations/concepts.html#can-i-change-the-size-of-an-existing-minio-deployment

k8s

http://192.241.195.202:9000/staging/DOCS-1250/k8s/operations/install-deploy-manage/modify-minio-tenant.html#decommission-a-tenant-server-pool

Fixes https://github.com/minio/docs/issues/1250
2024-07-11 16:08:58 -06:00
Daryl White
a51f0fa6b5
Corrects missing alias in alias set command (#1254)
A [user on
Mastodon](https://hachyderm.io/@thisismissem/112570163970900508) noted
that the instructions for connecting a container deploy to MC were
missing the alias in the `mc alias set` command.

This fixes that.

Not staged.
2024-06-24 13:31:52 -04:00
Andrea Longo
e90efa5527
Regenerate sample batch framework config YAML (#1242)
Per @shtripat and @vadmeste , the indentation was off. Fixed by
generating new examples with
- `mc batch generate play/ replicate`
- `mc batch generate play/ keyrotate`

The `expire` example is identical to current `mc batch generate play/
expire` output.

Error reported by a customer.
2024-06-11 11:43:53 -06:00
Andrea Longo
c30bdaec84
fix additional build warnings (#1239)
Fix more build warnings. This includes removing references to
`MINIO_KMS_KES_ENCLAVE`
2024-06-07 14:32:07 -06:00
Andrea Longo
b173e7bb6e
Fix build warnings for Operator pages (#1238)
Fix build warnings from https://github.com/minio/docs/pull/1219 

Some are broken refs that need to point elsewhere.

Some are because `openshift`, `eks`, `gke`, `aks` can't see a target
that's on a `k8s` page, apparently due to how
`operations/installation.rst` is structured. These we are still
investigating.
2024-06-07 13:37:24 -06:00
Andrea Longo
d17c896f75
attempt to remove plugin from docs (#1219)
The Kubernetes plugin is gone, this PR replaces the procedures that use
`kubectl minio` in all its various forms. The plugin was referenced on
many pages and for many purposes so there is _a lot_ of restructuring
involved.

Some procedures no longer have CLI instructions, which can be addressed
in subsequent PRs. Everything should have at least one working method,
even if it's to use Operator Console.

- Remove references to plugin, except for pre-4.5.8 upgrade paths
- Move pre-4.5.8 upgrade paths to new child page (currently hidden from
TOC, linked in page)
- Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:
- [Operator
deploy](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/installation.html)
- [Operator
upgrade](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/install-deploy-manage/upgrade-minio-operator.html)
- [Deploy and manage
Tenants](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/deploy-manage-tenants.html)

Fixes https://github.com/minio/docs/issues/1213
2024-06-07 09:05:39 -06:00
Daryl White
52e66839f1
Updates for MinIO Server 2024-05-10 release (#1234)
Updates for MinIO Server RELEASE.2024-05-10T01-41-38Z
    
- Removes references to `MINIO_SERVER_URL` envvar.
- Updates KMS and KES related envvar settings to add KMS as an option.
- Also differentiates KMS and KES related envvar into three groups,
which are mutually exclusive.
    
Closes #1214
2024-06-06 17:33:02 -04:00
voldikss
63d0482a63
Fix typos (#1236) 2024-06-06 12:30:10 -04:00
danickblouin
ab3bebe567
Fixed typo in container documentation (#1232) 2024-05-30 16:05:55 -04:00
Ravind Kumar
775e99d47b
DOCS-1190: RELEASE.2024-04-18T19-09-19Z (#1215)
Partially addresses #1190 

No staged build unless someone requests it.

# Summary

After some thinking, we've leaned towards just making a note of the
upgrade step and calling it done. We do not typically make extended
discussion of backward-breaking changes at this time, and have no where
to keep that sort of guidance.

Maybe in the future or as part of a larger re-arch we can consider where
we would best keep that kind of guidance.

As far as the rest:

- We are not covering s3zip today, so that's a no-op. We should leave
the ticket open in the event we have bandwidth to document the feature
later
- No changes to Console that need documentation at this time
- Added a quick callout on the warning behavior to the Versioning page
- Metrics v3 is also still In progress, come back to this once the
project is fully baked.
2024-05-10 18:16:49 -04:00
Andrea Longo
7013fc3723
Kustomize deployment instructions (#1202)
New page with Kustomize Operator deployment instructions, as a sibling
to the existing Helm page. Includes some matching updates to the Helm
page, for consistency.

Replacing the Krew instructions (numerous locations) will be a separate
PR.

Staged

http://192.241.195.202:9000/staging/DOCS-1125/k8s/operations/install-deploy-manage/deploy-operator-kustomize.html

See also: https://github.com/minio/operator/pull/1947

Fixes https://github.com/minio/docs/issues/1125
2024-05-09 13:11:40 -06:00
Andrea Longo
748f1e075d
Typo in exclusive volume access admonition (#1197)
oops typo
2024-04-25 14:32:39 -04:00
Daryl White
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
Daryl White
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
Ravind Kumar
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
Daryl White
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
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
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
Allan Roger Reid
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
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
Daryl White
77be96d492
Corrects the description for an envvar. (#1145)
Closes #1132
2024-03-04 16:51:53 -05:00