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

810 Commits

Author SHA1 Message Date
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
3f9a46bcbe Update upgrade-minio-operator.rst 2024-10-01 15:30:35 -04:00
79cf400125 Updates for the 2024-09-09 releases of the server and mc (#1331)
- adds new config options for webhook events
- adds new subcommands to mc idp ldap accesskey
- adds info about new output during iam import

Closes #1316
2024-09-23 15:29:29 -04:00
9171ccc58f Mention Invalid Login error on MINIO_SERVER_URL (#1312)
The MinIO Console currently does not warn the user if the MinIO server
is not reachable. MinIO Console will just say "Invalid Login" when the
MINIO_SERVER_URL is not reachable which is misleading in the sense that
will make think most people that the username/password/access key is
incorrect so I think it should be mentioned in the documentation that
Invalid Login could be just due to connectivity between console and
server.

Related to https://github.com/minio/console/issues/3428 and
https://github.com/minio/console/issues/3427

@marktheunissen

---------

Co-authored-by: Ruben Laguna <ruben.laguna@tele2.com>
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2024-09-23 15:09:28 -04:00
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
c67d446bac Minor fixes to address multiple small issues (#1326)
A few quick fixes noted in several issues:

- Literal reference in mc batch generate pointed to the wrong include
   Closes #1318 
- Lingering reference to an "unregister" function removed
  Closes #1324
- Adds admonition about root credentials required, even with KES
  Closes #1325 
- Adds mc batch cancel to list of commands on batch framework overview
page
   Closes #1310
- Updates mc client page S3 link to avoid possible copy/paste confusion
  Closes #1311
2024-09-20 11:25:14 -04:00
b8a62baa90 Fixing links to videos missing a : (#1321)
Found a few more links for videos missing a `:` after the `http`.
This fixes those.
2024-09-17 10:05:24 -04:00
5f5fc42530 Fix the recommended video URLs on the Object Locking page (#1320) 2024-09-17 10:01:34 -04:00
1e64bf8f6b Updates for mc RELEASE.2024-09-16T17-43-14Z (#1319)
- Adds new `--output` flag to `mc admin cluster iam export`
- Corrects encryption flags for `mc mv` command noted during build

Does not track a docs issue.
2024-09-16 16:59:31 -04:00
af6811de3a Update data-compression.rst
Fixing typo
2024-09-13 13:38:24 -04:00
2285c68f1e Catchup to 6.0.3 release 2024-09-09 13:20:06 -04:00
d87eb665c9 COMPLIANCE functionally equiv to S3 COMPLIANCE mode (#1309)
This seems to be a copy error, based on my comparison of the COMPLIANCE
LOCK and S3's Compliance mode (vs S3's Governance mode).

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-08-28 16:54:40 -04:00
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
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
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
11a3bd8ae9 Make port numbers consistent in the port assignment chapter (#1306) 2024-08-23 17:33:49 -04:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
bda0b09ee4 Empty commit to force Operator version number update 2024-07-15 14:34:48 -06: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