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
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
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
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
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
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
684217cdf9 Minor fixes for remote storage names (#1275)
Swapping `_` for `-` in remote class names for S3.
2024-07-22 08:22:58 -04:00
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
23cc0544ac Temporarily fixing Operator version to 5.0.15 until 6.0.0 docs are ready 2024-07-18 14:04:25 -04:00
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
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
7ffa8b61b2 Fixing build error 2024-07-12 20:21:03 -04:00
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
5173a10569 Update software.rst 2024-07-12 16:20:46 -07:00
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
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
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
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
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
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
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
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
492a08756d Make Ipv6 support more visible (#1248)
Keeping it simple to start.
2024-06-14 13:01:39 -04:00
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
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
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
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
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
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
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
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
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
63d0482a63 Fix typos (#1236) 2024-06-06 12:30:10 -04:00
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
ab3bebe567 Fixed typo in container documentation (#1232) 2024-05-30 16:05:55 -04:00
c407fec6ed Adds erasure code video to doc (#1230)
Added EC video as a recommended video in the right nav on the EC
overview page.

Closes #1228
2024-05-29 16:23:27 -04:00
344e6560c1 Adds three new sets of algorithm definitions for sftp (#1225)
Partially addresses #1201
2024-05-24 17:12:46 -04:00
c2736b10a3 Glossary typo (#1224)
Fix server pool entry. Incorrect indentation truncates first char of
second paragraph.
2024-05-24 10:12:48 -06:00
91f16cedd2 Adds disable pager global flag and envvar (#1223)
Closes #1200
2024-05-22 17:35:57 -04:00
9b0a2e6eb9 Adds updated command output to include EC value. (#1222)
For mc RELEASE.2024-05-03T11-21-07Z.

Closes #1209
2024-05-22 15:02:32 -04:00
76b5bb0333 Adds information about tiering rules and exclusive access (#1220)
Adds info to the object management page.
Does not restructure the docs at this time.

Partially addresses #1207
2024-05-22 13:57:37 -04:00
c1bbe71ceb Adds mc ready to reference docs (#1221)
Closes #1188
2024-05-22 13:52:25 -04:00
9374fb56e4 Aggregate information on deleting objects (#1218)
Creates a new object management page to aggregate information on
deleting objects.
Links to the page from other docs throughout.

Intentionally leaves most delete information where it is in existing
docs.
    
Closes #741
2024-05-17 16:28:45 -04:00
1933043f7e quote the kubectl apply -k command (#1217)
By request, for readability and also apparently it will then work on
other platforms too.

---------

Co-authored-by: Ramon de Klein <mail@ramondeklein.nl>
2024-05-15 14:00:28 -06:00
80a28862e7 Fix white-space behaviour of inline code blocks (#1205) 2024-05-13 17:49:12 -04:00
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
2953b54ecd correct NATS endpoint syntax (#1212)
NATS endpoints should be specified with hostname and port, not a URL. 

Staged

http://192.241.195.202:9000/staging/nats-endpoint-fix/linux/reference/minio-server/settings/notifications/nats.html

http://192.241.195.202:9000/staging/nats-endpoint-fix/linux/administration/monitoring/publish-events-to-nats.html

Fixes https://github.com/miniohq/engineering/issues/1966
2024-05-10 07:36:52 -06:00
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
64923e3c1b DOCS-1159: RELEASE.2024-03-15T01-07-19Z (#1211)
Partially addresses #1159 

Excluding Metrics v3 since that work is ongoing, and it's not fully
baked as of yet.

All changes are effectively config level.

Also fixed up some format/hierarchy issues while I was at it.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html#compression-extensions
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/core.html#maximum-object-versions
-
http://192.241.195.202:9000/staging/DOCS-1159/linux/reference/minio-server/settings/storage-class.html#parity-retention-optimization

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-05-09 14:38:07 -04:00
9c8c089342 FIXUP: Existing object replication is on by default (#1206)
# Summary

We some time ago updated bucket replication to perform existing object
replication by default. Not entirely sure when, but long enough that we
can just make the change.

Also fixed one out-of-band syntax error.

# Staged


http://192.241.195.202:9000/staging/REPLFIX/linux/administration/bucket-replication.html#replication-of-existing-objects
2024-05-07 20:41:32 -04:00
3399695e18 Remove deprecated heal options, add two trace call types (#1203)
Remove several `mc admin heal` options from the reference docs. These
were previously deprecated and are now hidden.

Also add two `mc admin trace` call types from the same PR, noted in the
relevant GitHub docs: `batch-keyrotation` and `ilm`.

Staged

http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-heal.html

http://192.241.195.202:9000/staging/DOCS-1029/linux/reference/minio-mc-admin/mc-admin-trace.html#mc.admin.trace.-call

Fixes https://github.com/minio/docs/issues/1029
2024-05-06 12:34:08 -06:00