27e2f48b2d
Standardize wording of envvar/mc admin config links ( #966 )
...
This change standardizes the text for the "`foo` corresponds with `bar`"
links between the list of envvars and `mc admin config` settings.
(Thanks to @djwfyi for the suggestion.)
It also includes some opportunistic rejoining of hard wrapped lines.
Staged:
http://192.241.195.202:9000/staging/DOCS-919-5-envvar-cmd-links/linux/reference/minio-mc-admin/mc-admin-config.html
http://192.241.195.202:9000/staging/DOCS-919-5-envvar-cmd-links/linux/reference/minio-server/minio-server.html
2023-08-23 14:40:09 -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
aac614d083
Updates for Minio Server and mc releases ( #958 )
...
Updates for mc and MinIO server releases
- Adds `client` command to mc support perf
- Adds new metrics
- Corrects typos and minor issues in metric related docs
Closes #955
Closes #956
2023-08-21 13:02:04 -05:00
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
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
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
1a1c340c3c
clarify redirect_uri maybe
2023-08-15 09:55:22 -07:00
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
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
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
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
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
975cbeb5ff
DOCS-910: Updating proxy and console configurations ( #921 )
2023-07-21 17:41:51 -04:00
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
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
2c172e8bde
oops missing commit for DOCS-830: data compression ( #920 )
...
See https://github.com/minio/docs/pull/915
---------
Co-authored-by: Klaus Post <klauspost@gmail.com >
2023-07-17 12:59:58 -06:00
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
6227f8b736
Fix syntax in mc version reference page ( #917 )
...
Fix incorrect commands syntax detail.
Includes a general reformat. For just the items noted in the issue, see
the first commit.
Staged:
http://192.241.195.202:9000/staging/DOCS-916/linux/html/reference/minio-mc/mc-version.html
Fixes https://github.com/minio/docs/issues/916
2023-07-14 16:20:45 -06:00
0a1006711d
TASK: Include config backup prereq for decom and rebalance
2023-07-10 17:35:45 -04:00
d23159e386
DOCS-908: Fixing errant references to mc config subcommands
2023-07-05 10:20:51 -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
9302e4fd86
ftp call type for mc admin trace ( #905 )
...
New `ftp` call type for `mc admin trace`.
Fixes https://github.com/minio/docs/issues/879
2023-06-30 09:34:26 -06:00
f5643ea7a5
mc ping --exit and mc admin user svcacct add/edit --expiry ( #901 )
...
Doc updates from [mc
RELEASE.2023-05-30T22-41-38Z](https://github.com/minio/docs/issues/870 ):
[x] New --exit option for mc ping
[x] Expiration date can be set when adding or editing a service account
Staged:
http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc/mc-ping.html#mc.ping.-exit
http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-add.html#mc.admin.user.svcacct.add.-expiry
http://192.241.195.202:9000/staging/DOCS-870/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-edit.html#mc.admin.user.svcacct.edit.-expiry
Fixes https://github.com/minio/docs/issues/870
2023-06-29 15:11:52 -06: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
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
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
c840f368f4
mc admin user info: view inherited policies from groups ( #878 )
...
Remaining item from https://github.com/minio/docs/issues/866 :
`mc admin user info --JSON` includes the policies the user inherited
from their group membership in the `memberOf` property.
Staged:
http://192.241.195.202:9000/staging/DOCS-866-mc-admin-user-info/linux/html/reference/minio-mc-admin/mc-admin-user-info.html
Fixes https://github.com/minio/docs/issues/866
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2023-06-12 13:34:57 -06:00
874b56eaeb
Partial update for mc RELEASE.2023-05-26T23-31-54Z ( #877 )
...
Update reference docs for recent changes:
* `mc admin user svcacct ls` service account expiration date
* `mc ilm rule ls` `updateAt` policy mod time
Staged:
http://192.241.195.202:9000/staging/DOCS-866/linux/html/reference/minio-mc-admin/mc-admin-user-svcacct-list.html
file:///Users/andrealongo/repos/docs/build/DOCS-866/linux/html/reference/minio-mc/mc-ilm-rule-ls.html#show-policy-modification-time
Partially addresses https://github.com/minio/docs/issues/866
2023-06-09 14:51:19 -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
7f200b96b6
Correcting build warning messages ( #875 )
...
This corrects several build errors that had accrued in the docs.
2023-06-07 15:01:25 -05:00
626e4e4f32
svcacct doc updates from RELEASE.2023-05-18T16-59-00Z ( #868 )
...
Doc updates for `mc admin user svcacct add` and `edit`.
* `--comment` replaced with `--user` and `--description` for `add` and
`edit`.
* Add detail on length of autogenerated keys. Autogeneration was already
documented, the included change is a bug fix.
Partly addresses https://github.com/minio/docs/issues/859
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2023-06-02 14:00:08 -06:00
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
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
9f95069315
DOCS-855 - Fix spelling of 'Configured' ( #856 )
...
Co-authored-by: Fredrik Carlbom <fredrik.carlbom@sectra.com >
2023-05-17 10:43:22 -04:00
947b16155a
Updates docs of mc release RELEASE.2023-04-12T02-21-51Z ( #850 )
...
- Adds info to `mc ilm restore` about using `mc stat`
- Adds additional flag to `mc admin replicate update` syntax
- Adds metadata tags flags to `mc find`, plus examples
Closes #815
2023-05-12 11:36:19 -05:00
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
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
48d78340ff
Operator sidecar ( #838 )
...
This adds information about Operator component changes in v5.0.x.
Closes #791
Staged:
http://192.241.195.202:9000/staging/operator-sidecar/operations/installation.html
2023-05-05 10:39:13 -05:00
21e14b02f4
kubectl minio init command arguments update (#835 )
...
Documentation update
closes https://github.com/minio/operator/issues/1568
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com >
2023-05-03 10:35:03 -05:00
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
101ad648dd
Doc updates related to Operator v5.0.0 ( #837 )
...
Updates docs for most changes through v5.0.4.
Does not have changes related to sidecar containers.
Partially addresses #791
Staged: http://192.241.195.202:9000/staging/operator-5.0.0/index.html
2023-04-28 16:39:41 -05:00
1c5454955b
Expand the mc admin user docs ( #836 )
...
Restructure the existing `mc admin user` page into separate pages for
each subcommand. Also add missing details and correct errors.
Staged:
http://192.241.195.202:9000/staging/DOCS-785/linux/html/reference/minio-mc-admin/mc-admin-user.html
Fixes https://github.com/minio/docs/issues/785
2023-04-28 14:03:11 -06:00
8ddbea3439
correcting alias order ( #834 )
...
### Objective:
To correct the alias order
2023-04-25 10:27:52 -04:00
8721671838
Only mc admin update might need sudo ( #829 )
...
`sudo` note from https://github.com/minio/docs/pull/822 really should
only apply to `mc admin update`. Add there and remove from the common
include.
Staged
http://192.241.195.202:9000/staging/remove-excessive-sudo-note/linux/html/reference/minio-mc-admin/mc-admin-update.html
2023-04-21 15:51:15 -06:00
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
579540ae5c
Updates for MinIO RELEASE.2023-04-13T03-08-07Z ( #824 )
...
- Adds example output to mc admin info command
- Adds new metric
Closes #814
2023-04-19 18:30:10 -05:00
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.mdhttp://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
d91d752273
Adds notes about expiration output for some mc commands ( #819 )
...
Adds info to `mc admin user svcacct` and `mc admin user sts` about
exposing expiration for accounts.
Fixes some build errors from the troubleshooting doc.
Closes #786
2023-04-14 15:45:21 -05:00
