1
0
mirror of https://github.com/minio/docs.git synced 2025-08-05 03:41:24 +03:00
Commit Graph

742 Commits

Author SHA1 Message Date
Ravind Kumar
042d0c7145 Including Console Address in systemd envvar file 2024-01-30 12:18:31 -05:00
Ravind Kumar
5cba0951fb DOCS-1090: Document Access Management Plugin (#1115)
Closes #1090 

Simple enough - document that which was previously only on github.

Doing a minimal pass here, no core tutorial, just basics.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1090/linux/administration/identity-access-management/pluggable-authorization.html
-
http://192.241.195.202:9000/staging/DOCS-1090/linux/reference/minio-server/settings/iam/minio-access-plugin.html#

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-30 11:15:25 -05:00
Ravind Kumar
d6eca4384f Fixing trailing slash in URL 2024-01-26 12:10:31 -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
Andrea Longo
2d00cf06e5 Doc updates for mc RELEASE.2024-01-05T05-04-32Z (#1112)
Doc updates for these `mc` changes:

- New option for `mc mirror`: `--summary`
- Clarify `mc sql --json-input` also works with `.ndjson`

NDJSON clarified with a discussion in `mc sql` and an example of setting
`content-type` in `mc cp`.

Staged:

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-mirror.html#mc.mirror.-summary


http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-sql.html#mc.sql.-json-input

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-sql.html#input-formats

http://192.241.195.202:9000/staging/DOCS-1104/linux/reference/minio-mc/mc-cp.html#add-a-content-type-value

Fixes https://github.com/minio/docs/issues/1104
2024-01-23 08:58:14 -07:00
Ravind Kumar
6f00040411 Update common-minio-oidc.rst
jwt:PreferredUsername -> jwt:preferred_username
2024-01-23 10:17: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
Andrea Longo
1e1c4c73f8 Doc updates for mc RELEASE.2024-01-11T05-49-32Z (#1110)
Doc updates for the following:

- Document alias naming requirements, including new minimum length rules
- `mc tag set --exclude-folders` modifies the behavior of `--recursive`

Staged:

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-alias-set.html#mc.alias.set.ALIAS

http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-tag-set.html#mc.tag.set.-exclude-folders

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

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-01-18 16:14:24 -07:00
mozafar
6367e30fb4 Update mc share download syntax (#1109)
In following page the syntax section is not for download:

https://min.io/docs/minio/linux/reference/minio-mc/mc-share-download.html#syntax
This PR will changes syntax from upload  to download
2024-01-16 17:19:39 -05:00
Ravind Kumar
7c8e761fd3 Fixup for node restart -> server process restart 2024-01-12 10:40:29 -05:00
Andrea Longo
00f1c7f6c4 Clarify several small items in the mc reference (#1103)
A few opportunistic text updates:

- `mc mirror` recommends `mc replicate` and `mc admin replicate` for
other use cases. Mention what they are for.
- Clarify that `mc version` creates a null version id for existing
unversioned objects when bucket versioning is enabled.


http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-mirror.html

http://192.241.195.202:9000/staging/mc-mirror-clarification/linux/reference/minio-mc/mc-version.html#bucket-versioning-with-existing-data

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2024-01-05 09:38:16 -07:00
Andrea Longo
c5b43238d6 Remote tier needs DeleteObjectVersion if remote bucket is versioned (#1089)
If the remote tier bucket is versioned, MinIO requires additional
permissions to successfully transition objects. But it is not
recommended, as each object version becomes a distinct object on the
remote tier.

This is not new, it was omitted from the docs. Mention, but discourage.

Staged:

http://192.241.195.202:9000/staging/DOCS-1016/linux/reference/minio-mc/mc-ilm-tier.html#transition-permissions

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

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-01-03 16:52:11 -07:00
Ravind Kumar
a065b7a29f DOCS-1083: MinIO Server Release RELEASE.2023-12-02T10-51-33Z (#1097)
# Summary

Closes #1083 

Also reorganizes the batch framework pages. Could use additional
refinement, but considering that out of scope for now.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-01-02 14:25:04 -05:00
Daryl White
69315f3810 PowerShell commands and a request type for access management fix (#1100)
- Fixes a request type in an access management table

Closes #1064

- Adds an admonition about PowerShell commands to Healthcheck API page

Closes #1086

Staged:
- [Request type
fix](http://192.241.195.202:9000/staging/cleanups/windows/administration/identity-access-management/policy-based-access-control.html#userpolicy.writeonly)
- [Healthcheck
API](http://192.241.195.202:9000/staging/cleanups/windows/operations/monitoring/healthcheck-probe.html)
2024-01-02 13:25:39 -05:00
Ravind Kumar
faf5c8a3ef Guidance on removal of --config-dir | -C 2023-12-29 15:23:27 -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
Rushan
a47db59b39 Fix admonition font-size (#1099) 2023-12-27 11:29:32 -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
Tsuzuki Tsuchiya
2acf572489 Fix the name of RoleArn param in AssumeRoleWithWebIdentity requests (#1095)
In `AssumeRoleWithWebIdentity` requests, the RoleArn form paramter is
designated to specify the role to be assumed. It is crucial to note that
the correct key is RoleArn, not RoleARN.

When I used the "RoleARN" form key instead of "RoleArn," I encountered
an error similar to the following:
```xml
<ErrorResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"><Error><Type></Type><Code>InvalidParameterValue</Code><Message>Role arn:minio:iam:::role/dummy-internal does not exist</Message></Error><RequestId>XXX</RequestId></ErrorResponse>
```

Despite this, certain documentation erroneously employs RoleARN. To
rectify this inconsistency, I have replaced the instances of RoleARN
with the correct RoleArn. However, for other documents that use RoleARN
without specifying the form parameter, no modifications have been made.

Ref:
ba245c6c46/cmd/sts-handlers.go (L50C2-L50C12)
2023-12-26 10:18:04 -05:00
Daryl White
ed2553efc8 Add DirectPV docs link to dropdown switcher (#1094)
- Adds the DirectPV docs to the doc switcher
- Adds a external links reference for the DirectPV Docs

Staged:
http://192.241.195.202:9000/staging/directpv-docs-link/linux/index.html
2023-12-21 12:30:51 -05:00
Rushan
790af1ad67 Add Training link (#1093)
Fixes https://github.com/minio/docs/issues/1092
2023-12-21 10:15:24 -05:00
Daryl White
14e0a02d65 Changes for mc RELEASE.2023-12-20T07-14-22Z (#1091)
Update one command for mc
[RELEASE.2023-12-20T07-14-22Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-12-20T07-14-22Z).

- Updates `mc ilm tier add` with new options.

Not staged.
Does not address any open issues.
2023-12-20 10:52:46 -05:00
Will
36a4eff258 Fixes for mc-share-upload docs. (#1087)
Hopefully this meets the current voice standards for docs. Main changes
are clarification of language around file vs. object and syntax fixes
for uploads.

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-12-13 13:25:40 -05:00
Ravind Kumar
dfa398f674 DOCS-1085: Typo in mc share 2023-12-12 12:38:49 -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
Harshavardhana
6e35feaadf Rename disk_ -> drive_ to match with server changes 2023-12-01 14:01:19 -08:00
Ravind Kumar
b3e259b6e6 Further clarify SNSD + 0 parity mode access 2023-11-28 19:25:58 -05:00
Ravind Kumar
072b82c1e4 Fixing default values for RRS storage class 2023-11-28 16:46:53 -05:00
Ravind Kumar
3a8768e85f DOCS-1071: mc.RELEASE.2023-11-15T22-45-58Z PARTIAL (#1075)
Partially addresses #1071 

Just documenting `mc alias import` and `mc alias export`, the former of
which we seem to have missed a year or so back.

Staged: 


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-import.html


http://192.241.195.202:9000/staging/DOCS-1071/linux/reference/minio-mc/mc-alias-export.html
2023-11-22 14:21:55 -05:00
Ravind Kumar
0741f57013 Quickfix: Guidance on firewall + port access 2023-11-21 14:17:05 -05:00
Daryl White
ad24bc3f74 Adds section on supported browsers to the MinIO Console page (#1074)
Closes #1070
2023-11-17 18:10:35 -05:00
Ravind Kumar
76438cc17f Improve guidance on AD/LDAP interaction with MinIO IDP 2023-11-17 11:07:24 -05:00
Allan Roger Reid
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
Daryl White
bef64557eb Add info on grafana with KES/KMS (#1072)
Closes #1057 .
2023-11-17 09:59:01 -05:00
Ravind Kumar
8b7448cb95 Fixup to NodePort range for Operator 2023-11-16 17:00:09 -05:00
Ravind Kumar
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
Daryl White
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
Daryl White
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
Daryl White
d3439a3b65 Updates for mc RELEASE.2023-11-06T04-19-23Z (#1068)
- Adds additional mc environment variables.
- Updates `mc support diag` example output.
2023-11-14 15:28:02 -05:00
Daryl White
3b5663ce54 Update for mc RELEASE.2023-11-10T21-37-17Z (#1067)
Adds `--anonymize flag` to `mc support diag`.

Not linked to an issue.

Staged at
http://192.241.195.202:9000/staging/mc-11-10-23/linux/reference/minio-mc/mc-support-diag.html
2023-11-14 13:26:04 -05:00
Daryl White
abee6a35d6 Updates for two Oct 2023 mc releases (#1066)
Updates for October 2023 MinIO Client releases
    
- Adds output sample for `mc support top locks`
- Adds `mc idp ldap accesskey` and subcommands
    
Closes #1056
    
- Adds environment variables for most global flags
- Adds --retry flag to mc mirror
- Adds --bucket-bandwidth flag to mc admin replicate update
    
Partially addresses #1045

- Removes unsupported `--noncurrent-transition-newer` flags from
commands.
2023-11-10 14:05:07 -05:00
Rushan
bb03238c77 Add default background color for images (#1063)
**Issue**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 29"
src="https://github.com/minio/docs/assets/13393018/2832944a-74a5-4e24-968d-1a3069812c2b">

**Fix**:
<img width="793" alt="Screenshot 2023-11-07 at 11 53 20"
src="https://github.com/minio/docs/assets/13393018/69305855-d384-4f58-8a1c-a6f3d3dfbebe">
2023-11-07 18:35:41 -05:00
Daryl White
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
Daryl White
ca23b065b2 Correcting mc-conf errors (#1061)
Corrects errors from `mc-conf` references not noticed until after
merging #1028 .

No issue to track it.
2023-11-03 14:13:08 -04:00
Daryl White
eb94513104 Breaking up envvars and config settings into separate settings pages (#1028)
- Creates a slew of folders and pages nested under the mc-server page to store settings.
- Breaks up all of the environment variable options formerly in the mc-server page into these separate pages.
- Moves the config settings formerly in the mc admin config page to the appropriate new settings pages.
- Adds a MiniO Client settings page and document `mc-host-<alias>`

Closes #1017
2023-11-03 07:55:22 -04:00
Andrea Longo
6d2ecc2b8a Restore previous Go SDK install command (#1058)
Now that I know why. The additional context to do go get in a project
directory doesn't fit in the format of this page, but it's in the
Quickstart update.
2023-11-02 07:15:15 -06:00
Andrea Longo
31db10bcf9 Make it easier to find play login (#1054)
The login info for `play` is buried in the MinIO Console page. Link to
it (and info about Console) from the top level page.

Staged
http://192.241.195.202:9000/staging/play-link/linux/index.html
2023-10-31 06:47:22 -06:00
Harshavardhana
2a10ceabdc remove out of context doc (#1053) 2023-10-30 15:50:31 -04:00
Ravind Kumar
6763b86c3c DOCS-1050: Fix error in mc cp docs 2023-10-27 14:33:06 -04:00
Ravind Kumar
f2d61b2bee DOCS-1040: Clarify behavior with name conflicts on prefixes (#1052)
Closes #1040 

Tried to keep this simple:

1. Use better examples
2. Try to use more clear language
3. Keep the consequence clear.

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2023-10-27 14:13:39 -04:00