1
0
mirror of https://github.com/minio/docs.git synced 2025-04-21 08:05:59 +03:00

210 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
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
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
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
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
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
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
Daryl White
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
Andrea Longo
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
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
Ravind Kumar
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
Furkan Sahin
24d445c35a
Replace mc admin console references with mc admin logs (#1198)
mc admin console command is depreciated, users should start using mc
admin logs instead.
2024-05-06 14:31:40 -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
96c0d232f8
Updates for several releases and issues (#1179)
Updates for server RELEASE.2024-03-30T09-41-56Z
    
- Adds information that SSE-C encrypted objects can now replicate.
    
Closes #1177

- Adds information on operator renewal of tenant certificates
    
Closes #1167

- Corrects a description for `ilm restore` function
    
Closes #1175

Updates for Console release 0.45.0
    
- Removes healing references
- Updates headings and subheadings for the current Console UI
    
Closes #1107
2024-04-05 16:43:32 -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
Harshavardhana
b7e08de9eb
metrics must show relevant yaml per tab selection (#1163) 2024-03-19 16:38:28 -04:00
Ravind Kumar
a335fd7495 Dropping admonitions, review and revisit later 2024-03-18 15:50:11 -04:00
Ravind Kumar
67e81ce2f8
Multiple SERVER Releases (#1141)
MinIO SERVER RELEASE.2024-01-05T22-17-24Z - added new metrics to
github.com/minio/minio for later sync

MinIO SERVER RELEASE.2024-01-28T22-35-53Z - MinIO preallocates memory,
mc update compresses binary in transit MinIO SERVER
RELEASE.2024-02-06T21-36-22Z -

MinIO adds condition key for restricting STS AssumeRoleWithWebIdentity
duration at policy level

Closes #1124 , 

Partially addresses #1116 
Partially Addresses #1105


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-03-11 10:06:46 -04:00
Daryl White
54584b290c
Adds recommended metrics to Prometheus procedure (#1147)
Partially addresses #1135

To consider:
I added the tabs as part of step 3 of the procedure, but we might want
to consider having a recommended alerts section separate from the
procedure, perhaps above the "Dashboards" heading. Let me know your
thoughts.
2024-03-08 12:29:40 -05:00
Daryl White
1ccef6501b
Fix cert directory in TLS doc (#1151)
Quick fix per internal discussion.
2024-03-07 17:25:12 -05:00
Daryl White
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
Daryl White
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
Andrea Longo
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
Ravind Kumar
0a03ca0b38 Minor update to thresholds 2024-02-14 13:49:48 -05:00
Ravind Kumar
3203cf7c3e
OPTIMIZATION: Storage, Capacity, and Prerequisites (#1118)
No related issue here, just freewheeling from an internal request.

This started with the request to change our recommendation around
label/uuid-based drive mounting to a requirement.

Looking at the pages I feel like our pre-req and considerations are a
little long in the tooth, and are at least slightly duplicative of what
is on the checklist pages (hardware, software)

This is at least a first swing at tidying things up. I think in a second
pass I'll move more of the pre-reqs into the Hardware/Software/Security
checklist pages, and keep the on-tutorial sections as simple defnlists
so that the page flows more easily. We can push users to the details if
they want it while keeping the high level requirements there.

Noting this does **not** yet address the new features related to
non-sequential hostname support. That has to come later.

---------

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-02-14 13:09:59 -05:00
Ravind Kumar
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
Daryl White
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
Ravind Kumar
31bd45f20f
DOCS-1084: Fix deployment menus for Windows, macos, containers, Add s… (#1108)
…cript for xfs settings to Linux"

Closes #1084 

Accomplishing a few things here:

1. General tidy-up of the installation pages so Windows/Container/MacOS
only display the appropriate deployment topos
2. Better admonitions/guidance on when to use what distribution
3. Added a section on Storage + XFS Settings to resolve an ongoing
customer request


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-23 14:12:11 -05:00
Peter Stolz
e7d76fd1db
Change port to 9090 for port forward command for helm minio-operator (#1114)
Installing the latest minio operator helm chart sets the console port to
9090 not 9001. I fixed the port in the port-forward command.
```
k get svc -n minio-operator 
NAME       TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
console    ClusterIP   10.97.140.40    <none>        9090/TCP,9443/TCP   21m
operator   ClusterIP   10.106.20.115   <none>        4221/TCP            21m
sts        ClusterIP   10.106.182.83   <none>        4223/TCP            21m
```
2024-01-22 13:16:34 -05:00
Ravind Kumar
7c8e761fd3 Fixup for node restart -> server process restart 2024-01-12 10:40:29 -05:00
Daryl White
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
jingsam
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
Ravind Kumar
e30a2ac1bc
Addressing hardware checklist critical feedback (#1080)
We're getting a lot of repeated requests during
inbounds on sizing VMs specifically.

Our baremetal and K8s checklists are slightly generic to this and imply
a baseline that may be uncommon within a virtualized context

This attempts to bring together a slightly wider band while emphasizing
that our high-watermark is intended for high performance, while the low
watermark is a bare minimum.


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-12-08 16:01:42 -05:00