1
0
mirror of https://github.com/minio/docs.git synced 2025-07-22 23:02:06 +03:00
Commit Graph

493 Commits

Author SHA1 Message Date
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
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
7d2a162b1b Update for MinIO Server RELEASE.2023-08-23T10-07-06Z (#970)
Adds new environment variable for defining the duration of a browser
session for the MinIO Console.

Related PR: https://github.com/minio/minio/pull/17885
2023-08-24 13:44:55 -05:00
756d9f1799 Correct mc admin user example, fix warnings (#969)
A few small things:

* find/replace error from https://github.com/minio/docs/pull/950
* build warnings

Thank you @bendem!
https://github.com/minio/docs/pull/950#discussion_r1303044374
2023-08-23 16:04:32 -06:00
2908b2f9ee Optional custom init container (#967)
Operator 5.0.6+ allows custom init containers, should your pod require
additional initialization. Add a brief mention in the Operator install
page and link to the k8s docs.

Staged

http://192.241.195.202:9000/staging/DOCS-900-2/k8s/operations/installation.html#minio-operator-components

Partially addresses https://github.com/minio/docs/issues/900
2023-08-23 14:59:21 -06:00
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
3669b54fcf Operator supports PSA restricted namespaces (#965)
Add a mention in the Operator docs that MinIO supports the `restricted`
policy for [Pod Security
admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/)

Staged:

http://192.241.195.202:9000/staging/DOCS-900-1/k8s/operations/installation.html#kubernetes-version-1-19-0

Partly addresses https://github.com/minio/docs/issues/900
2023-08-23 12:01:19 -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
52f1951c8b DOCS-957: Fixed location for console location (#961)
Fixes issue with trailing slash described in #957

Closes #957
2023-08-18 11:49:56 -04: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
79751411a4 Updating fstab and minio.service path (#936)
Updates fstab to add `nofail`.
Modifies path for `minio.service` to be in `/lib/` instead of `/etc/`.

Closes #874 .

Staged [here](
http://192.241.195.202:9000/staging/fstab874/operations/install-deploy-manage/deploy-minio-multi-node-multi-drive.html#local-jbod-storage-with-sequential-mounts).

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-08-14 14:10:26 -05:00
6a3a85bc84 Update setup-nginx-proxy-with-minio.rst 2023-08-14 13:36:53 -04:00
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
20403a7464 DOCS-912: Part 1: Cleaning up Vault (#949)
Staged:
http://192.241.195.202:9000/staging/DOCS-912/linux/operations/server-side-encryption/configure-minio-kes-hashicorp.html

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-08-11 17:08:36 -04:00
d2e8899685 Rephrasing the Operator Support (#948)
### Objective:

To rephrase the Operator Support accordingly for single node single
drive configurations.

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2023-08-11 10:29:56 -04: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
d2dec0a920 Adding C++ SDK into the list (#946)
### Objective:

To add C++ SDK in the page:
https://min.io/docs/minio/linux/developers/minio-drivers.html

![Screenshot 2023-08-10 at 12 39 28
PM](https://github.com/minio/docs/assets/6667358/ed9931e0-a3ce-4de7-954a-3960a76a6f4c)

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2023-08-10 15:16:35 -04: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
a5729b78e5 Update configure-minio-kes-hashicorp.rst (#941)
Adding /v1/key/list/* in the doc instead of /v1/key/list which gives
Authentication issue .

policy:
minio:
allow:
- /v1/key/create/* # You can replace these wildcard '' with a string
prefix to restrict key names
- /v1/key/generate/ # e.g. '/minio-'
- /v1/key/decrypt/*
- /v1/key/bulk/decrypt
- /v1/key/list
- /v1/status
2023-08-10 10:03:18 -04: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
8801c834b2 Update deploy-operator-helm.rst
Closes #928
2023-07-21 17:36:46 -04:00
fd66cf5c10 Add missing word: "is" (#927)
Per title, it seemed that the word "is" was missing from the sentence.
2023-07-21 11:50:43 -04:00
2572c46cd0 Decommissioning logs skipped delete markers and expired objects (#925)
Add mention of logging skipped items

Partially addresses https://github.com/minio/docs/issues/909
2023-07-20 15:21:03 -06: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
e90d64bb32 Fix up recommendation page (#914) 2023-07-11 12:35:44 -04:00
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00
9af4c2ccdf DOCS-913: Fix MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC true -> on 2023-07-10 17:32:33 -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
dc2b67c449 Increase the font size of card content (#899)
Fixes https://github.com/minio/docs/issues/869
2023-06-27 15:23:54 -05:00
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
c7a9477286 fix formatting for sample SNSD env file (#892)
The code block indentation was off, resulting in a mangled sample
`/etc/default/minio` file in the Single Node Single Drive install docs.
2023-06-21 15:17:28 -06:00
6991295fb9 Improvements to replication conceptual docs (#885) 2023-06-20 17:13:34 -04:00
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