1
0
mirror of https://github.com/minio/docs.git synced 2025-06-08 18:02:00 +03:00

38 Commits

Author SHA1 Message Date
Daryl White
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
Daryl White
8b5be57ee3
Deprecated command cleanup (#1166)
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes #1164

- Moves wildcard matching from `mc mirror` to `minio-mc.rst` page and
adds ref links throughout as needed.
2024-03-28 17:13:35 -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
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
Andrea Longo
24ee2ef360
More RoleARN->RoleArn (#1128)
Replace additional occurrences of incorrect `RoleARN` with `RoleArn`.

Staged
http://192.241.195.202:9000/staging/DOCS-1102-2/linux/index.html

Remaining item, fixes https://github.com/minio/docs/issues/1102
2024-02-12 08:08:25 -07: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
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
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
Ravind Kumar
76438cc17f Improve guidance on AD/LDAP interaction with MinIO IDP 2023-11-17 11:07:24 -05:00
Andrea Longo
0b6f3e0b38
Improve TLS configuration instructions (#1037)
Update and clarify how to configure TLS for a distributed deployment.
The existing steps were out of date, and also were not clear
configuration needs to happen on each node.

I'd particularly appreciate comments on terminology. I'm a little fuzzy
about how to work with CAs, perhaps some of the phrasing can be
improved.

Staged:
- linux
-
http://192.241.195.202:9000/staging/DOCS-447/linux/operations/network-encryption.html
-
http://192.241.195.202:9000/staging/DOCS-447/linux/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#add-tls-ssl-certificates

-http://192.241.195.202:9000/staging/DOCS-447/linux/operations/install-deploy-manage/expand-minio-deployment.html#add-tls-ssl-certificates
- k8s
-
http://192.241.195.202:9000/staging/DOCS-447/k8s/operations/network-encryption.html

Closes https://github.com/minio/docs/issues/447
2023-10-18 10:39:34 -06:00
Ravind Kumar
6a1697c9f5
DOCS-1022: Use 'mc idp ldap policy' for AD/LDAP policy assignments (#1026)
---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-10-05 16:59:43 -04:00
Daryl White
01606fbfa1
Updates for MinIO Server release 2023-08-04 (#1000)
Updates for release 2023-08-04T17-40-21Z
    
- Adds info on new 10,000 version limit to appropriate pags
- Updates Grafana with site replication info

Closes #938
2023-09-16 20:35:13 -04:00
Daryl White
388cc6c9f3
Adds information about role policy and roleARN for OpenID docs. (#983)
Closes #933

- Adds envvar and config param
- Adds Role Policy openID authentication flow
2023-09-01 16:37:59 -05:00
Daryl White
870d5c9881
Batch job Permissions (#972)
Adds information to the batch job doc about available permissions.
Updates the batch job policy list to include `cancel`.

Closes #954 

Staged at
http://192.241.195.202:9000/staging/permissions/linux/administration/batch-framework.html#access-to-mc-batch
2023-08-28 17:25:08 -05:00
Daryl White
20644952de
Grafana and metric updates (#953)
- Adds a new page for Grafana to overview.
- Replaces the list of metrics in the Metrics and Alerts page with an
include to pull the list of metrics maintained in GitHub.
- Removes use of the :metric: role throughout the docs.
- Adds note about the introduction of a new bucket metric endpoint.

Partially addresses #930
Partially addresses #931
Partially addresses #898
Closes #864

Staged:
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
2023-08-17 09:01:46 -05:00
Andrea Longo
fbee736485
Fix a bunch of incorrect commands for attaching policies (#950)
Found many incorrect commands for creating/attaching policies to users
and groups.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-3-admin-policy/k8s/html/index.html

This is additional follow-up from
https://github.com/minio/docs/issues/919 and also SUBNET docs feedback.
2023-08-14 10:15:12 -06:00
Andrea Longo
8f598693f0
Updated LDAP docs (#939)
Update the AD/LDAP configuration instructions, including adding details
about configuring with Console.

Includes reformatting some existing content.

Questions:
- What, exactly, is the status of the `mc admin config identity_ldap`
settings? Deprecated? There, but not recommended for new configurations?
- Are the "all settings" examples correct and appropriate? I'm not clear
if `mc idp ldap` supports the same settings with the same names as
`identity_ldap`.

Staged:

http://192.241.195.202:9000/staging/DOCS-919/linux/html/operations/external-iam/configure-ad-ldap-external-identity-management.html

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

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-08-10 09:44:12 -06:00
Ravind Kumar
d674b2ea90
DOCS-872: Update condition key list (#935)
Closes #872 

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2023-08-07 12:33:09 -04:00
Andrea Longo
afc7a03071
Docs 860 part1: max policy document size, webhook metrics (#882)
Docs updates for two items from [MinIO
RELEASE.2023-05-18T00-05-36Z](https://github.com/minio/docs/issues/860):

* Max policy size of 2KiB for service accounts
I _think_ this change now means json policy documents have the same max
size in all cases. The limit wasn't documented previously. This change
adds max size info throughout, not only for service accounts.
* Webhook usage metrics

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/reference/minio-mc-admin/mc-admin-policy-create.html

http://192.241.195.202:9000/staging/DOCS-860-part1/linux/html/administration/identity-access-management/policy-based-access-control.html#policy-document-structure


Partly addresses https://github.com/minio/docs/issues/860

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-06-14 15:32:03 -06:00
Ravind Kumar
a6d554acdc
DOCS-807, DOCS-846, Misc. Bug fixes (#861)
Closes #807 
Closes #846 


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-05-23 17:29:48 -04:00
Ravind Kumar
3f6b8ea57d
DOCS-780: Bug Stomping (#844)
A few big things here:

- Updated to Sphinx 6.2.1 successfully. I'm using Python 3.10.10
- Upgraded to docutils 0.19, which is latest
- Upgrade myst-parser and sphinx-design to latest stable
- Fixed a bunch of warning outputs
2023-05-11 16:57:03 -04:00
Ravind Kumar
8caa50e3d1
General work on releases (#797)
Closes #750 
Closes #736 
Partially Address #767
2023-04-10 16:03:13 -04:00
Daryl White
ab49b29916
Correcting mc admin policy command links (#802)
Missed some references to deprecated commands during an mc release doc
update (PR #799).
This fixes those references to the new commands.
2023-04-05 16:46:28 -05:00
Ravind Kumar
b32d6167db
DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Daryl White
12177544ba
Correct sts API reference (#776)
MinIO User management docs pointed to an incorrect reference.
This corrects that.
2023-03-24 17:55:40 -04:00
Daryl White
ca60d1f3c1
Adds changes for minio release from Feb 27 2023 (#774)
- updates list of metrics to add new IDP plugin metrics
- Adds info about expiring sts tokens

Depends on two topics added in PR #735  for internal links.

Closes #746
2023-03-24 12:10:33 -05:00
Daryl White
00de8dbeb6
Updates to mc docs for December 2022 releases (#697)
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.

- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
    
Closes #685

- Updates ilm commands for new structure for tiers and rules
    
    - Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
    - Adds new `mc ilm rule` and six subcommands
    - Adds new `mc ilm tier` and six subcommands
    - Updates references to ilm and admin tier  commands throughout docs
    - Adds new deprecated commands page
    - Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees

- Closes #691
- Closes #662
2023-01-10 15:47:02 -06:00
Ravind Kumar
54f1fa14da BUGFIX: Multiple Issues
DOCS-676: Resource ARN "*" description misleading
DOCS-677: Site Replication Recovery requires removing failed site first
MINIO-16268: Further simplify erasure set stripe calculation docs to avoid further confusion
2022-12-16 15:06:22 -05:00
Daryl White
443e2f2a7c
Adds info about tag-based policies (#659)
Policies can now include conditions for certain types of actions. If the
object has an existing tag, the user can complete the action. Otherwise,
the user cannot.

In the Access Management doc
- Adds a section near the top about tag based policies
- In the conditional section, adds `s3.ExistingObjectTag` as an allowed
conditional for several specific actions.

Closes #604

Adds warning about weak policy condition keys.

Closes #596
2022-12-05 12:45:32 -06:00
Ravind Kumar
1cfda2e9dc
RELEASE: Multiple Issues (#647)
Closes #639 
Closes #635 
Partially Addresses #590 

- MINIO #16026 https://github.com/minio/minio/pull/16026
- MINIO #16044 https://github.com/minio/minio/pull/16044
- MINIO #16035 https://github.com/minio/minio/pull/16035
- CONSOLE #2428 https://github.com/minio/console/pull/2428

Other Fixes:

- Removes admonition about IDP interactions (multi-IDP support)
- Update Console screenshots and overview page to cover layout changes
- Partial fix for DOCS #590 (Policy now under Identity section)
2022-11-23 14:51:47 -05:00
Daryl White
2f8c5a94f6
Release updates mc RELEASE.2022-11-07T23-47-39Z (#640)
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)

- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.

Closes #636
Closes #632
2022-11-18 12:31:11 -06:00
Daryl White
e2f30fb5fd
Adds mc batch commands to the docs (#620)
Closes #605

- Adds the five `mc batch` subcommands
- Adds a batch framework page to the Administration section of docs
2022-11-14 17:40:21 -06:00
Ravind Kumar
d815aa9ce8
Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Daryl White
1cef7df283 Corrects minor issues noted in issue #492 2022-07-13 13:15:42 -05:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00