minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-27 18:36:56 +03:00
Code
594 Commits 18 Branches 0 Tags
Commit Graph

101 Commits

Author SHA1 Message Date
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
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
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
Daryl White
5c766a8008
Move thresholds page and add references (#1020) 
Per a request from @klauspost, this moves the Thresholds and Limits page
to a more logical place as a core operational concept.

Closes #1018 .
 2023-10-06 16:56:21 -04: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
Ravind Kumar
3b5a7537a4
Update publish-events-to-elasticsearch.rst 
Closes #971
 2023-10-04 18:01:34 -04:00
Daryl White
3769dd0173
Batch replication requires realtime tier (#1010) 
Based on discussion of https://github.com/minio/minio/pull/18044, adding
info to the batch replication doc about requiring a realtime tier for
replication.

Not staged.
 2023-10-04 10:46:30 -04:00
Daryl White
22919dbbe0
Updates for console 0.38 (#1012) 
Add description of access key table.

Closes #989
 2023-09-27 11:37:24 -04:00
Ravind Kumar
535c1ed36b
DOCS-998: Tiering requires source and remote (#1008) 
Closes #998
 2023-09-21 11:44:38 -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
Aofei Sheng
42efe20e4f
Correct ChaCha20Poly-1305 to ChaCha20-Poly1305 (#932) 
It's
[ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305),
not ChaCha20Poly-1305. Sorry a little bit OCD.
 2023-09-06 11:53:02 -04:00
Daryl White
4ea1289617
Adds explanation for new scanner events (#986) 
Internal discussion explained when scanner events trigger.
This adds the explanation for those two events.

No issue for this.
 2023-09-05 11:17:53 -05: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
Ravind Kumar
45092bab4b
Update bucket-notifications.rst 
Should close #984
 2023-09-01 14:49:19 -04:00
Daryl White
c8a0eb1f95
Adds notes for changes in console v0.35.0 (#980) 
Closes #944
 2023-08-31 10:08:53 -05:00
Daryl White
28e415fd8c
Updates for mc RELEASE.2023-08-29T22-55-06Z (#979) 
mc
[RELEASE.2023-08-29T22-55-06Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-08-29T22-55-06Z)
has changes that impact the docs:

- Adds `list` command to `mc admin kms key`
- Adds new group of `scanner` event types

There is no issue to track this release.
 2023-08-31 09:53:21 -05:00
Daryl White
9dabf28246
Add additional context for what local means in the batch context (#975) 
Closes #924
 2023-08-29 16:27:40 -05:00
Daryl White
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
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
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
Ravind Kumar
ac72345962
DOCS-898: Synchronous Bucket Notifications, config API secret redaction (#960) 
Closes #898 

- Adds a short section on synchronous vs asynchronous bucket
notifications
- Adds a note on specific configs which now return redacted data on `mc
admin config get`
- Found a few new webhook lambda envvars to add
 2023-08-21 11:19:20 -04: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
Daryl White
2ab9e51d34
Updates NATS notification docs to point to JetStream service (#937) 
Streaming configs and envvars are deprecated.

Closes #903
 2023-08-04 14:07:02 -05:00
Andrea Longo
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
Andrea Longo
bb1600952e
Data compression docs (#915) 
Document data compression, including security concerns with encrypting
compressed objects.

Staged:

http://192.241.195.202:9000/staging/DOCS-830/linux/html/administration/object-management/data-compression.html

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-mc-admin/mc-admin-config.html#data-compression

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-server/minio-server.html#data-compression

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
 2023-07-17 12:33:15 -06:00
Ravind Kumar
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
Andrea Longo
d64dfd146b
Clarify MINIO_SERVER_URL hostname (#889) 
`MINIO_SERVER_URL` must be the FQDN. Can't be the short name, even if it
is resolvable.

Fixes https://github.com/minio/docs/issues/876
 2023-06-19 16:26:31 -06: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
40448a5617
minor improvement to versioned delete ops (#880) 
Minor change to improve discussion around versioned delete operations
and cleanup

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-06-14 15:50:02 -04: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
79e55b4d90
DOCS-845: Updates for MinIO Server RELEASE.2023-05-04T21-44-30Z (#852) 
Closes #845 

Staged: http://192.241.195.202:9000/staging/DOCS-845/linux/index.html
 2023-05-17 17:38:27 -04:00
Ravind Kumar
840bd073cc DOCS-854: Typo in include 2023-05-16 14:22:46 -04:00
Ravind Kumar
7132e8ed02 Errant TOC entry in administration/concepts.rst 2023-05-12 12:58:02 -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
Daryl White
363e688617
Updates for MinIO RELEASE.2023-04-07T05-28-58Z (#823) 
- Adds new environment variable for ILM expiration workers
- Adds new metrics for locks
- Adds keyrotate batch job type
- Adds info about batch replicate from remote to local
    
Closes #806

Staged:
http://192.241.195.202:9000/staging/minio-2023-04-07/administration/batch-framework.html
 2023-05-01 16:42:13 -05:00
Andrea Longo
ea85cce9a9
New flag to set site replication to synchronous (#826) 
Document new flag for `mc admin replicate update` to enable/disable
synchronous site replication. Continue to recommend default async
replication due to increased write latency with sync.

Adapt/reuse the existing description of async vs sync from bucket
replication as an include.

Staged

http://192.241.195.202:9000/staging/DOCS-790/linux/html/operations/install-deploy-manage/multi-site-replication.html#synchronous-vs-asynchronous-replication

http://192.241.195.202:9000/staging/DOCS-790/linux/html/reference/minio-mc-admin/mc-admin-replicate.html#syntax

http://192.241.195.202:9000/staging/DOCS-790/linux/html/administration/bucket-replication.html#synchronous-vs-asynchronous-replication

Fixes https://github.com/minio/docs/issues/790
 2023-04-20 15:54:05 -06:00
Ravind Kumar
e7db29ff03
Patching replication docs for version match requirement (#825) 2023-04-20 10:36:31 -04:00
Daryl White
f05c657e99
Changes for Console release v0.26.0. (#821) 
- Adds Audit Kafka tab to list of settings sections
- Adds info about diagnostic report uploading to SUBNET

Closes #788
 2023-04-18 12:47:10 -05:00
Daryl White
d86463cba1
Adds Call Home information to the troubleshooting doc (#801) 
Closes #751
 2023-04-12 11:01:09 -05:00
Daryl White
a4dd7929e0
Add changes for MinIO RELEASE.2023-03-20T20-16-18Z. (#809) 
Closes #767

- Adds behavior note about decommissioning pools with tiering enabled
- Adds info about enabling/disabling LDAP IDP connection
- Adds a Windows-only note in the Object Management about not using the
\ character

Staged:
- http://192.241.195.202:9000/staging/minio-2023-03-20/index.html
- Windows at:
http://192.241.195.202:9000/staging/minio-2023-03-20/windows/administration/object-management.html#object-organization-and-planning
 2023-04-12 10:40:19 -05:00
Ravind Kumar
a432637298
Adding more EDU videos (#803) 2023-04-10 16:36:35 -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
Daryl White
199d1eb1d4
Adds info on certificates with the MinIO Client (#782) 
- Adds a new section on certificates to the MinIO Client page
- Adds a new section in Behaviors to the mc alias set page
- Minor fix to a --json flag command in version doc

Closes #781
 2023-03-30 13:04:10 -05:00
Ravind Kumar
e301ca757b
DOCS-741: Improving discussion of object deletion (#777) 2023-03-29 18:41:54 -04:00