1
0
mirror of https://github.com/minio/docs.git synced 2025-06-13 03:41:40 +03:00
Commit Graph

109 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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
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
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
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
7c8e761fd3 Fixup for node restart -> server process restart 2024-01-12 10:40:29 -05:00
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
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
b3e259b6e6 Further clarify SNSD + 0 parity mode access 2023-11-28 19:25:58 -05:00
9381b113f5 Tweak helm deployment strategy (#1073)
Important @ravindk89 : the installation of the tenant will end up with
CrashLooping pods unless a Standard storageclass is previously installed
- similar to the following. Please document this where best you see fit.
```
cat <<EOF | kubectl apply -f -
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: standard
provisioner: rancher.io/local-path
reclaimPolicy: Delete
volumeBindingMode: WaitForFirstConsumer
EOF
2023-11-17 10:58:43 -05:00
8b7448cb95 Fixup to NodePort range for Operator 2023-11-16 17:00:09 -05:00
c770ba9d76 DOCS-1021: Adding helm information (#1060)
Closes #1021 
Closes #1055 
Closes #968 
Closes #943 


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
2023-11-16 12:56:20 -05:00
09ce8edb48 Updates for two October releases (#1065)
- Adds additional flag for `mc admin trace`
- Adds info about supported secret types for k8s

Closes #1039 

For the `mc admin trace --stats` flag, also adding example output.

Closes #1045
2023-11-15 11:58:16 -05:00
1af11084ec Removing reference to unsupported decom with tiering (#1069)
Per community Slack, correcting conflicting docs notes about
decommissioning when tiering is enabled.

Support for this was added in March 2023.
2023-11-14 15:35:20 -05:00
a8afbc1465 [Community request] Clarify Operator upgrade (#1062)
Operator upgrade docs for 4.2.3 to 4.5.8 had an incorrect sentence
saying the procedure could upgrade directly to latest stable.
This updates the description to clarify that upgrade should first
upgrade to 4.5.8.

This was noted by a community Slack user.
2023-11-06 10:47:05 -05:00
ed963c6506 Typo in Helm deploy docs (#1043)
Incorrect capitalization of `Tenant` in the Helm deploy page causes a
few of the example commands to fail.

Fixes https://github.com/minio/docs/issues/1041
2023-10-20 13:25:18 -06:00
71497d3072 Warn user to use XFS in EBS Volumes (#992)
### Objective:

To warn users to use XFS as File system type for MinIO Tenant.

### Docs:

* [CreateVolume
Parameters](https://github.com/kubernetes-sigs/aws-ebs-csi-driver/blob/master/docs/parameters.md)

`"csi.storage.k8s.io/fstype"` should be `xfs` NOT `ext4`

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2023-09-25 11:27:36 -04:00
77f3074081 typo fix for upgrade-minio-operator.rst 2023-09-20 12:45:05 -04:00
ada852eca3 DOCS-934: Clean up container procedures (#985)
Closes #934
2023-09-05 15:26:19 -04:00
33b28825f3 Partial updates for Operator v5.0.7 docs (#978)
The easy bits from https://github.com/minio/docs/issues/943: 

- [x] `kubectl minio tenant info` now includes tenant secret info ([PR
#1704](https://github.com/minio/operator/pull/1704))
- [x] `kubectl minio delete` now has a `--force` flag ([PR
#1687](https://github.com/minio/operator/pull/1687))

Staged:

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/reference/kubectl-minio-plugin/kubectl-minio-delete.html

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-info.html

http://192.241.195.202:9000/staging/DOCS-943-1/k8s/operations/install-deploy-manage/deploy-minio-tenant.html#persistent-volumes
2023-08-31 12:05:42 -06:00
1fae334ff3 Updates tenant upgrade instructions with prereqs (#982)
Community member noted that the prereqs were out of date in our tenant
upgrade docs.
This brings them in line with what's in Github.

Closes #963
2023-08-31 13:04:35 -05:00
c2f1181015 Discourage replication for SNSD/SNMD (#976)
It's technically possible to replicate with SNSD/SNMD configurations.
This is not safe for production environments, docs should discourage it.
(See https://github.com/minio/minio/issues/17523)

Staged

http://192.241.195.202:9000/staging/DOCS-919-6-snsd-replication-nope/linux/operations/install-deploy-manage/multi-site-replication.html#load-balancers-installed-on-each-site

Fixes https://github.com/minio/docs/issues/909
(last item to doc for that release)
2023-08-29 15:49:14 -06:00
e7e83d91b4 Documents the scanner.speed config and minio_scanner_speed envvar (#973)
Closes #796

And a few other paragraphs here there and yon.
2023-08-29 10:49:10 -05:00
756d9f1799 Correct mc admin user example, fix warnings (#969)
A few small things:

* find/replace error from https://github.com/minio/docs/pull/950
* build warnings

Thank you @bendem!
https://github.com/minio/docs/pull/950#discussion_r1303044374
2023-08-23 16:04:32 -06:00
34cf55934a Updates for several July 2023 mc releases (#964)
mc RELEASE.2023-07-18T21-05-38Z
- Replaces mc replicate diff with mc replicate backlog
- Adds mc support top net

mc RELEASE.2023-07-07T05-25-51Z
- Adds mc support perf site-replication
- Deprecates mc admin replicate --sync flag in favor of new mc admihn
replicate --mode flag
- Updates output example of mc admin user info to show authentication
info

Partially addresses  #930
2023-08-22 13:54:51 -05:00
f05a8aae32 Updates for RELEASE.2023-07-18T17-49-40Z (#962)
- Adds information about 3 attempts at site or bucket replication tasks
- Adds note about additional info for delete markers
- Updates mc admin info command example output

Partially addresses #931 .

Not staged, but can do if needed.
2023-08-21 13:07:36 -05:00
79751411a4 Updating fstab and minio.service path (#936)
Updates fstab to add `nofail`.
Modifies path for `minio.service` to be in `/lib/` instead of `/etc/`.

Closes #874 .

Staged [here](
http://192.241.195.202:9000/staging/fstab874/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#local-jbod-storage-with-sequential-mounts).

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-08-14 14:10:26 -05:00
d2e8899685 Rephrasing the Operator Support (#948)
### Objective:

To rephrase the Operator Support accordingly for single node single
drive configurations.

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2023-08-11 10:29:56 -04:00
8801c834b2 Update deploy-operator-helm.rst
Closes #928
2023-07-21 17:36:46 -04:00
2572c46cd0 Decommissioning logs skipped delete markers and expired objects (#925)
Add mention of logging skipped items

Partially addresses https://github.com/minio/docs/issues/909
2023-07-20 15:21:03 -06:00
2abd324c3a split mc version into subcommand pages (#923)
Addresses potential confusion about required/optional and the several
mutually exclusive options.

Staged:

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-enable.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-info.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-suspend.html

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

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-07-20 10:04:58 -06:00
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00
c6b87ee0ee Fixing multiple issues (#906)
DOCS-902: Add "M' and "Mi" units to --limit-upload and --limit-download
DOCS-895: Take Bucket/IAM snapshot before site replication config
DOCS-886: Add audit_kafka config settings and envvars.
2023-06-30 16:06:48 -04:00
c45ac2b0f1 DOCS-867: MINIO Server Release.2023-05-27T05-56-19Z (#904)
Partially addresses DOCS-898: MINIO Server RElease.2023-06-23T20-26-00Z
2023-06-29 16:50:46 -04:00
a6aa72c7d8 Fix docs for gateway/filesystem deployment migration (#894)
The instructions to migrate a MinIO Gateway or filesystem mode
deployment are incorrect. Separate out the steps that differ for each
into tabs and clean up where needed. Several migration steps for
filesystem mode don't apply to gateway, and tiers don't apply to either.

Staged:

http://192.241.195.202:9000/staging/DOCS-818/linux/html/operations/install-deploy-manage/migrate-fs-gateway.html

Fixes https://github.com/minio/docs/issues/818
2023-06-29 14:46:43 -06:00
7a01ca72e6 DOCS-888: prefix exclusion of versioning prevents replication (#893)
Closes #888 

# Summary

- MinIO requires versioning for replication
- We support excluding prefixes/folders in buckets selectively
- This prevents replication within those prefixes/folders

Also included in this ticket

- Added an image to the site replication page
- Fixed a broken SVG
- Minor tweaking of site replication page.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-06-23 13:19:45 -04:00
6991295fb9 Improvements to replication conceptual docs (#885) 2023-06-20 17:13:34 -04:00
e7c314ccf6 Can remove a decommissioned pool as soon as it completes (#884)
Docs update for a change in the server pool decommissioning process: you
no longer have to wait for all pools to complete before removing the
ones that are done. [Original
PR](https://github.com/minio/minio/pull/17221)

Partly addresses https://github.com/minio/docs/issues/860
2023-06-16 11:50:54 -06:00
4c735072f7 Move reference docs for mc admin idp commands to mc idp (#873)
All the `mc admin idp *` commands have been renamed `mc idp *`.
Deprecate everything under `mc admin idp` and create pages for their new
names in the MinIO Client section.

Affects the following commands and subcommands;
* `mc admin idp ldap`
* `mc admin idp openid`
*  `mc admin idp ldap policy`

The new pages maintain the existing content and page structure. New
pages for each subcommand are out of scope for this PR.

Partly addresses https://github.com/minio/docs/issues/859 and
https://github.com/minio/docs/issues/866

Staged:

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-admin.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-deprecated.html

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-06-08 11:58:22 -06:00
9f5be8878b fix link in deploy-operator-helm (#871)
Yay @djwfyi  had the correct syntax
2023-06-05 17:59:20 -06:00
65e284f453 Helm deploy docs (#851)
Document how to deploy with a Helm chart, based on [How to install MinIO
Using Helm in
Kubernetes](https://github.com/cniackz/public/wiki/How-to-install-MinIO-Using-Helm-in-Kubernetes).

This addition maintains the existing plugin instructions as the primary
path, with Helm as a child page under that. That makes room for future
deploy options.

The existing `common-install-operator-kubectl-plugin-install.rst` is now
in two parts, to allow only including the second part in the Helm
instructions. Also promoted the Upgrade page to be a sibling to Deploy.

Many of the original instructions are environment setup that enable
installing the Helm charts, starting Operator, and creating a tenant.
That will vary by the user's environment, so omitted for docs.

Staged:

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

Fixes https://github.com/minio/docs/issues/798
2023-06-05 17:45:58 -06:00