minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-11-03 05:13:12 +03:00
Code Activity
507 Commits 17 Branches 0 Tags
9ea539b8ab4748e1bb52bb093513f64714faded3
Commit Graph

52 Commits

Author SHA1 Message Date
Andrea Longo
9ea539b8ab Restructure/expand mc idp ldap reference pages (#959) 
Improve the AD/LDAP reference docs:

- Break up `mc idp ldap` and `mc idp ldap policy` into parents/children.
- Add commands from the `identity_ldap` configuration key to `mc idp
ldap add` and `mc idp ldap update`.
- Update links from relevant envvars to `mc idp ldap` instead of
`identity_ldap`
- Fix stuff that needs fixing.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap.html

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap-policy.html
Fixes https://github.com/minio/docs/issues/940

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
 2023-08-18 13:50:15 -06: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
1a1c340c3c clarify redirect_uri maybe 2023-08-15 09:55:22 -07:00
Andrea Longo
389d338b6f Remove sts_expiry, username_format; add srv_record_name (#947) 
Remove long-gone LDAP settings and add docs for a recent one.

Gone:
- `sts_expiry`, `MINIO_IDENTITY_LDAP_STS_EXPIRY`
- `username_format`, `MINIO_IDENTITY_LDAP_USERNAME_FORMAT`
- Username-Bind mode

Related code change: https://github.com/minio/minio/pull/13165

Recent:
- `srv_record_name` for lookup via DNS SVR records

Added in https://github.com/minio/minio/pull/16201
RELEASE.2022-12-12T19-27-27Z

Staged:

http://192.241.195.202:9000/staging/DOCS-919-2-svc-record/linux/html/reference/minio-server/minio-server.html#envvar.MINIO_IDENTITY_LDAP_SRV_RECORD_NAME

http://192.241.195.202:9000/staging/DOCS-919-2-svc-record/linux/html/reference/minio-mc-admin/mc-admin-config.html#mc-conf.identity_ldap.srv_record_name
 2023-08-10 18:53:20 -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
Ravind Kumar
940c9563c0 DOCS-911: Improving erasure coding core concepts (#929) 
Closes #911 

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
 2023-08-01 17:01:08 -04:00
Ravind Kumar
975cbeb5ff DOCS-910: Updating proxy and console configurations (#921) 2023-07-21 17:41:51 -04:00
Andrea Longo
6e3d3c56ae Document audit kafka queue config/envvars (#926) 
Add audit_kafka `queue_dir`, `queue_size`, and their corresponding
envvars.

See https://github.com/minio/docs/issues/886 and
https://github.com/minio/docs/pull/906 for related updates.

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-server/minio-server.html#envvar.MINIO_AUDIT_KAFKA_QUEUE_DIR

http://192.241.195.202:9000/staging/DOCS-860-part-n/linux/html/reference/minio-mc-admin/mc-admin-config.html#mc-conf.audit_kafka.queue_dir

Fixes https://github.com/minio/docs/issues/860 (final item)
 2023-07-20 14:03:44 -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
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
Ravind Kumar
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
Andrea Longo
45d18ddef8 Docs 860 part2: persistant queues (#883) 
Docs updates for persistent queues added in
https://github.com/minio/minio/pull/17121

Kafka bit needs additional attention, see
https://github.com/minio/docs/issues/886

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-server/minio-server.html#logging

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-mc-admin/mc-admin-config.html#http-webhook-log-target

Partly addresses https://github.com/minio/docs/issues/860
 2023-06-19 09:56:14 -06: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
Daryl White
443279c3de Adds documentation for ftp and sftp (#848) 
- Adds a new page to the developer section for File Transfer Protocol.
- Update the `minio server` command with two new flags.

Closes #828
 2023-05-11 11:44:14 -05: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
6d65d8aba2 Object Lambda docs (#800) 
Object Lambda functions to transform objects via a webhook. Expand and
refine the developer docs from


c4d71bc1a5/docs/lambda/README.md

into a new page in the user documentation.

Staged

http://192.241.195.202:9000/staging/DOCS-754/linux/html/developers/transforms-with-object-lambda.html

Notes for reviewers:

In addition to the items noted in inline comments, some general things
to confirm:
* Accurate usage/terminology? Is this how we talk about the relevant
topics?
* Any technical points that need more/more correct detail?
* What would someone need to know to go from trying this dev example to
having a real function in their production environment?

[x] Add new docs page in Developers
[x] Add envars to envar list

Fixes https://github.com/minio/docs/issues/754
 2023-04-19 15:05:48 -06:00
Daryl White
508940787b Adding webhook environment variables (#813) 
Fixes build errors due to missing environment variables for logger
webhook configs.
 2023-04-14 09:52:14 -05:00
Vincent Composieux
2ea1b14032 Fixed MINIO_ROOT_PASSWORD to be secret key (#812) 
I’ve fixed a little typo that could save some minutes to users:

The MINIO_ROOT_PASSWORD is the secret key, not the access key.
 2023-04-13 17:25:14 -05:00
Ravind Kumar
b32d6167db DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Daryl White
c8e0e8a1a5 Changes for mid-February releases (#737) 
- Adds information about a new batch replication environment variable
(PR #16609)
- Adds note about metrics in `mc admin bucket remote bandwidth` moved to
`mc replicate status`

Partially addresses #736
 2023-02-21 12:13:53 -06:00
Daryl White
ea489b4a30 Updates for minio Dec 2022 releases (#701) 
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.

Updates for Dec 2022 minio updates
    
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
    
Closes #684

Updates for Jan 2 2023 release
    
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
    
Closes #689
 2023-01-12 13:57:36 -06:00
Daryl White
6d32ddcaa8 Update for early Dec 22 minio release (#671) 
## Updates for `console` early Dec22 releases

- Updated the instructions for registering for SUBNET from an airgapped
Console environment
- Minor typo in IAM doc.

Closes #664

Two of the items in that issue did not actually impact the docs. One
item is just a screenshot update that will be addressed later.

## Updates for `minio` early Dec22 releases
    
- Adds info about `mc` installed with container images
- Adds new envvar for KES enclaves
    
Closes #665

- Updates `mc support inspect` to correct alias to target in command
syntax
 2022-12-28 11:41:23 -06:00
Ravind Kumar
0c4c7be68b BUGFIX: PostgreSQL and MySQL Bucket Notification Examples have incorrect values 2022-11-23 09:56:44 -05:00
Daryl White
0cd491c328 Mc updates for multiple releases (#642) 
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
 2022-11-18 12:49:03 -06:00
Daryl White
92ee087d4f Updating all references to docs.min.io URLs (#584) 
Updating remaining links to the old docs site to point to the new URLs.

Closes #581
 2022-09-26 14:21:29 -05:00
Ravind Kumar
d815aa9ce8 Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Ravind Kumar
0e63416cb1 Fixing typo 2022-08-12 17:22:18 -04:00
Ravind Kumar
c783e10594 DOCS-492: Container Platform Docs 
This commit also generally cleans up the Installation docs and uses /includes/<platform>/steps-*.rst as a pattern for storing platform-specific tutorials within a single root URL.

Finally, due to API rate limits, this commit adds some Makefile magic to allow skipping of sync'ing dependencies. Pass `make BUILD_DEPENDENCIES=FALSE <platform>` to skip building any deps and use what is already in the branch.
 2022-07-18 17:46:59 -04:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
Ravind Kumar
93c9b00cb0 additional cleanups after merge 2022-03-03 16:36:57 -05:00
Ravind Kumar
74e55a6ded Update minio.py and mc references for simplified structure 2022-03-03 15:21:25 -05:00
Ravind Kumar
c61c5b16c5 Remove EOL'd docs on Gateway 2022-02-16 18:03:24 -05:00
Ravind Kumar
5c090cc913 DOCS-420: Further fixes 2022-01-28 18:08:45 -05:00
Ravind Kumar
06500dcba3 DOCS-420: Incorrect Kafka SASL mechanisms 2022-01-28 17:38:54 -05:00
ravindk89
ef30821063 DOCS-380: Refactor CLI reference 2022-01-04 19:11:15 -05:00
ravindk89
955cd1b03e DOCS-311: Complete cleanup of SSE docs 
Fixups per Andreas

More CR fixes

Apply suggestions from code review

Co-authored-by: Andreas Auernhammer <hi@aead.dev>

Final pass
 2021-10-21 12:50:37 -04:00
ravindk89
b80599ea54 MinIO Console Documentation 2021-08-10 14:11:15 -04:00
ravindk89
ab25dd2059 Clean up prometheus metric collection tutorial and references 2021-07-28 12:59:31 -04:00
ravindk89
773e5c67b7 Refactor the installation documentation 
Refactor the installation documentation

Address Code Review comments, further refinements

More review feedback fron Kannappan

Broken ref

More fixups

Final fixups
 2021-07-23 17:18:51 -04:00
ravindk89
9473a65a26 Cleanup pass + reorg 2021-07-09 13:55:28 -07:00
ravindk89
92e6fc898a Migrate STS docs to next-gen, restructure/revise 2021-07-09 13:55:28 -07:00
ravindk89
00c5863642 Removing unused envvar 2021-07-08 18:29:45 -04:00
ravindk89
08a38c2a71 DOCS-355: Update quickstart for Embedded Console 2021-07-07 21:49:18 -07:00
ravindk89
9b4ec43824 Migration: Metrics and Logging 
Apply suggestions from code review via Eco

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>

Completing response to eco PR

Minor fixup

One more fixup
 2021-06-17 09:49:27 -04:00
ravindk89
b23cae7aed Adding lightboxed images, fixing typo 2021-05-20 18:34:46 -04:00
ravindk89
7736389e86 Fixing envvars 2021-05-12 10:10:33 -04:00
ravindk89
ebd4850020 Addtl fixups 2021-05-12 10:10:33 -04:00
Ravind Kumar
5fe66d4f79 Apply suggestions from code review 
Co-authored-by: Andreas Auernhammer <aead@mail.de>
 2021-05-12 10:10:33 -04:00
ravindk89
85dbf58bd9 Add new KMS encryption feature, deprecate MINIO_ACCESS_KEY and MINIO_SECRET_KEY 2021-05-12 10:10:33 -04:00