1
0
mirror of https://github.com/minio/docs.git synced 2025-04-22 19:02:57 +03:00

718 Commits

Author SHA1 Message Date
Daryl White
008cd9acba
Drive by fix noted by end user (#1308)
Just a quick change to replace "two" with the "three" it was supposed to
be.
2024-08-27 16:46:32 -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
c37ff313cb
Updating legacy k8s upgrade doc (#1305)
The legacy upgrade doc had some unclear and confusing references in the
upgrade path. This updates the upgrade chart on the page to include
latest stable. Fixes references to 6.0.2 that should have been 5.0.15.

Not tied to a docs issue.

Staged:

- [Legacy upgrade
doc](http://192.241.195.202:9000/staging/k8s-update/k8s/operations/install-deploy-manage/upgrade-minio-operator-4.5.7-earlier.html#minio-k8s-upgrade-minio-operator-to-5-0-15)
2024-08-23 22:46:30 -04:00
Philipp Henkel
11a3bd8ae9
Make port numbers consistent in the port assignment chapter (#1306) 2024-08-23 17:33:49 -04:00
Daryl White
08f2da3343
Changes for MinIO Server releases (#1302)
- Updates references for licensing to use "Enterprise" branding
- Updates the mc idp ldap policy entities command with flags and changes
to groups
- Deprecates OpenID envvar

Closes #1271
2024-08-21 14:18:33 -04:00
Daryl White
31367cf36c
Updates for mc mirror parameters (#1300)
Closes #1270

- Adds some missing parameters to the syntax list.
- Adds the `--active-active` parameter.
2024-08-16 15:20:04 -04:00
Daryl White
f27c16f30a
Updates for MinIO Server and MC releases on 2024-07-03/04 (#1299)
- Adds info about tracking batch job status for completed jobs
- Deprecates `mc license update`
- Adds flags for updating Azure credentials in `mc ilm tier update`

Closes #1260
2024-08-15 17:12:18 -04:00
Daryl White
f7c397c636
Changes for two mc releases (#1296)
[`RELEASE.2024-07-31T15-58-33Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-07-31T15-58-33Z)

- adds new flags to `mc idp ldap accesskey list`


[`RELEASE.2024-08-13T05-33-17Z`](https://github.com/minio/mc/releases/tag/RELEASE.2024-08-13T05-33-17Z)

- adds new flags to `mc stat`
- adds new global flag for custom DNS mapping

Does not track an outstanding docs issue.
2024-08-15 11:57:56 -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
Daryl White
762b942009
Changes for MinIO Server RELEASE.2024-08-03T04-33-23Z (#1297)
MinIO Server
[RELEASE.2024-08-03T04-33-23Z](https://github.com/minio/minio/releases/tag/RELEASE.2024-08-03T04-33-23Z)
adds a v2 for the batch job replicate API.

This new version supports including multiple prefixes on the source for
replication.

Not linked to a docs issue.
2024-08-14 17:32:09 -04:00
Andrea Longo
5865c3b93d
deprecate mc quota (#1294)
Bucket quotas don't work the way people think they work, as they cannot
enforce hard limits. Deprecate in docs while we sort out what to do with
the commands.

The future replacement is MinIO Enterprise Catalog.

Staged:

http://192.241.195.202:9000/staging/deprecate-bucket-quota/linux/reference/minio-mc-deprecated.html

See:
https://github.com/minio/mc/pull/5011
https://github.com/minio/mc/pull/5012
2024-08-08 14:58:54 -06: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
Andrea Longo
343e54d402
Metrics v3 (#1289)
Add metrics v3 to the Metrics and Alerts page and other relevant
locations, deprecate metrics v2.

- Updated the metrics extract script to parse the [list of v3 metrics
from
GitHub](https://github.com/minio/minio/blob/master/docs/metrics/v3.md).
- Remove references to MinIO Console metrics.
- Make `:mc-release:` show friendly release name text like
`:minio-release:` does.

Staged:

Linux

http://192.241.195.202:9000/staging/DOCS-1266/linux/operations/monitoring/metrics-and-alerts.html

k8s

http://192.241.195.202:9000/staging/DOCS-1266/k8s/operations/monitoring/metrics-and-alerts.html

fixes https://github.com/minio/docs/issues/1266
2024-08-02 17:58:59 -06: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
Pavel Anni
7722414e1b
DOCS-1287: fix broken links to ARN reference (#1288)
Change broken links to ARN reference to
`<IAM/latest/UserGuide/reference-arns>`

Co-authored-by: Pavel Anni <pavel@minio.io>
2024-07-30 12:03:18 -04:00
Andrea Longo
63e44aff1c
additional feedback for mc stat examples (#1286)
More improvements to `mc stat` examples following
https://github.com/minio/docs/pull/1285

Staged:

http://192.241.195.202:9000/staging/mc-stat-example-2/linux/reference/minio-mc/mc-stat.html#examples
2024-07-26 16:31:02 -06:00
Andrea Longo
daa7f32d59
add better examples to mc stat page (#1285)
Replace the abstract examples on the `mc stat` page with some that show
meaningful output. Including how to get the count of objects in a
bucket. Opportunistically update text flow throughout.

Staged:

http://192.241.195.202:9000/staging/mc-stat-example/linux/reference/minio-mc/mc-stat.html

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-07-26 14:39:41 -06:00
Daryl White
848b5b7d34
Updates for mc RELEASE.2024-06-20T14-50-54Z (#1279)
Updates for mc release 2024-06-20T14-50-54Z
    
- Adds info about requiring Raw Base64 or Hex keys
- Updates links for KES docs on encryption pages
- Updates encryption pages to use ventilated prose (one sentence per
line)
- Adds new flag for `mc get`
- Updates `mc put` with enc-# flags
    
Closes #1253
2024-07-25 12:31:28 -04:00
Andrea Longo
cb658261c8
Typo in deprecated mc ilm import page (#1282)
Hopefully nobody tries to use this deprecated command anymore, but fix
the example typo anyway.
2024-07-24 13:02:37 -06:00
Rushan
5c138befa0
Fix table width (#1281)
This PR addresses the issue where the table occasionally renders
narrower than the body width.

![Screenshot 2024-07-22 at 16 17
17](https://github.com/user-attachments/assets/b2c93990-019d-4007-b287-2edc1daffacb)
2024-07-24 13:56:34 -04:00
Rushan
2f0fb0aa3d
Add filter to exclude non-docs domains from search results (#1277)
As part of [min.io issue
#2136](https://github.com/miniohq/min.io/issues/2136), the crawler now
includes results from domains such as blog.min.io and resource.min.io.
By default, the search returns results from all these sources. This
update adds a filter to exclude results from domains other than
docs.min.io.

Also, added some minor CSS changes to fix the gray color palette
variables.
2024-07-23 16:34:05 -04:00
Daryl White
3e5df481f0
Storage class (#1276)
Missed saving a file, so missed a few fixes on the storage class name
`_` to `-` switch.
2024-07-22 11:16:35 -04:00
Daryl White
684217cdf9
Minor fixes for remote storage names (#1275)
Swapping `_` for `-` in remote class names for S3.
2024-07-22 08:22:58 -04:00
Daryl White
b48a8bcd42
Adds example of deleting delete markers to mc ilm rule add page (#1274)
Drive-by fixes to one example on the rule add page.
Adds an example for delete markers.

Closes #1262
2024-07-19 15:03:26 -04:00
Ravind Kumar
23cc0544ac Temporarily fixing Operator version to 5.0.15 until 6.0.0 docs are ready 2024-07-18 14:04:25 -04:00
Rushan
2de24f8c1e
Add Docsearch facet attribute for search feature (#1272)
We're exploring the possibility of adding a global search feature
(including docs, blog, etc.) on the main min.io website. As part of
this, we are adding a higher-level facet to filter results based on the
given site. This is for experimental purposes. If it doesn't work as
expected, we will send a PR in the future to remove this meta attribute.

Part of https://github.com/miniohq/min.io/issues/2136
2024-07-17 13:23:08 -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
Ravind Kumar
7ffa8b61b2 Fixing build error 2024-07-12 20:21:03 -04:00
Ravind Kumar
aa7bb5802c Apply suggestions from code review
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-07-12 16:20:46 -07:00
Ravind Kumar
5173a10569 Update software.rst 2024-07-12 16:20:46 -07: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
Andrea Longo
62124720a5
fix ref typos for mc admin prometheus generate (#1268)
Fix broken refs that were causing build warnings on some platforms. Not
staged.
2024-07-11 15:55:32 -06:00
Andrea Longo
e75fcbce65
typo in grafana.rst (#1261)
Quick grammar fix for the list of Grafana dashboards.

Not staged.
2024-07-08 14:04:19 -06:00
Andrea Longo
7c4261d99f
broken refs from DOCS-1255 (#1257)
Sphinx why u no warn _before_ merge??

cf. https://github.com/minio/docs/pull/1256
2024-06-28 14:01:11 -06:00
Andrea Longo
697b851a5d
Rework mc admin prometheus reference page (#1256)
Split the `mc admin prometheus` page into subpages and add missing docs
for `mc admin prometheus metrics`.

Staged

http://192.241.195.202:9000/staging/DOCS-1255/linux/reference/minio-mc-admin/mc-admin-prometheus.html

Fixes https://github.com/minio/docs/issues/1255

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-06-28 07:35:22 -06:00
Mark Theunissen
af031f77a7
Remove unbalanced quotes in MINIO_OPTS var, clarify how it is used (#1249)
- Please click "Ignore Whitespace" when reviewing, my editor stripped
out all the trailing whitespace.
- Removes an extra `"` quote 
- Try to explain how MINIO_OPTS works, does that sound right?
- Add missing `:` in front of port number

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Ravind Kumar <ravind@min.io>
2024-06-25 12:07:45 -04: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
Ravind Kumar
9fa014a073
Add MINIO_SERVER_URL to deprecated command list (#1251)
For reference by support w/ customers running older MinIO versions

Mostly need this because it sometimes comes up via support, and this
lets us reference it while also pushing users to upgrade to versions
where this kind of behavior is handled automatically.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-06-20 12:32:37 -04:00
Ravind Kumar
492a08756d
Make Ipv6 support more visible (#1248)
Keeping it simple to start.
2024-06-14 13:01:39 -04:00
Daryl White
0c5dc28687
MinIO removed the version limit in a prior version (#1244)
This removes references to version limits and suggests using object
expiration rules to manage unneeded noncurrent versions.

There is no doc issue to track this.
2024-06-13 10:37:37 -04:00
Andrea Longo
df011dc263
Can't resize server pools (#1246)
Explicitly note in the concepts page that you can't change the size of a
server pool after it's created.

Not staged
2024-06-12 15:56:23 -06:00
Daryl White
fa8c73d584
Updates for server and mc releases on 2024-06-10 (#1243)
For mc RELEASE.2024-06-10T16-44-16Z

- Updates `mc admin info` to add the `--offline` flag

For MinIO Server RELEASE.2024-06-11T03-13-30Z

- Adds to note to object management page about avoiding the `:`
character on Windows
- Adds info that directory objects (0-byte, end in `/`) do not tier

These releases do not have doc repo issues to track them.
2024-06-11 16:32:40 -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
Daryl White
d3eac20f2b
Updates for mc 2024-06-04 release (#1241)
Corrects mc batch examples
Closes #1235

Applies changes to the mc admin trace --stat flag in mc
RELEASE.2024-06-05T18-13-30Z. That change has no tracking docs issue.
2024-06-11 13:02:46 -04: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
Andrea Longo
b422c71bd9
Change scrape_interval in metrics scraping example (#1231)
The examples show `15s`, which is too short for a typical deployment.
`60s` is recommended. Also note that this value may need to be increased
if there are too many metrics to collect in the specified amount of
time. Each scraping operation should complete before the next begins.

Staged

http://192.241.195.202:9000/staging/scrape_interval/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html#generate-the-scrape-configuration
2024-06-05 16:49:58 -06:00