minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-05-28 00:41:14 +03:00
Code
505 Commits 18 Branches 0 Tags
Commit Graph

480 Commits

Author SHA1 Message Date
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
Daryl White
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
Ravind Kumar
6a3a85bc84
Update setup-nginx-proxy-with-minio.rst 2023-08-14 13:36:53 -04: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
Ravind Kumar
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
Cesar Celis Hernandez
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
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
Cesar Celis Hernandez
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
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
bhara03021989
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
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
Ravind Kumar
8801c834b2
Update deploy-operator-helm.rst 
Closes #928
 2023-07-21 17:36:46 -04:00
Pieter Gijsbers
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
Andrea Longo
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
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
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
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
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
Andrea Longo
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
Ravind Kumar
e90d64bb32
Fix up recommendation page (#914) 2023-07-11 12:35:44 -04:00
Ravind Kumar
0a1006711d TASK: Include config backup prereq for decom and rebalance 2023-07-10 17:35:45 -04:00
Ravind Kumar
9af4c2ccdf DOCS-913: Fix MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC true -> on 2023-07-10 17:32:33 -04:00
Ravind Kumar
d23159e386 DOCS-908: Fixing errant references to mc config subcommands 2023-07-05 10:20:51 -04: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
Andrea Longo
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
Andrea Longo
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
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
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
Rushan
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
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
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
Ravind Kumar
6991295fb9
Improvements to replication conceptual docs (#885) 2023-06-20 17:13:34 -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
91ffb04078
Don't recommend /home/events for queue path (#891) 
Missing commit from https://github.com/minio/docs/pull/883
 2023-06-19 14:51:02 -06: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
Andrea Longo
e7c314ccf6
Can remove a decommissioned pool as soon as it completes (#884) 
Docs update for a change in the server pool decommissioning process: you
no longer have to wait for all pools to complete before removing the
ones that are done. [Original
PR](https://github.com/minio/minio/pull/17221)

Partly addresses https://github.com/minio/docs/issues/860
 2023-06-16 11:50:54 -06:00
Rushan
edbbe90742
Add docs switch menu (#881) 
Fixes https://github.com/minio/docs/issues/842

Also made some changes to the dark-mode/read-mode icons to maintain the
consistency with KES docs UI.

**Preview:**
<img width="627" alt="Screenshot 2023-06-15 at 14 19 32"
src="https://github.com/minio/docs/assets/13393018/708d8991-c6af-406f-a474-65449c38c06c">

<img width="627" alt="Screenshot 2023-06-15 at 14 19 36"
src="https://github.com/minio/docs/assets/13393018/63f9db43-1408-4e96-81ad-9ecb7c39b9f0">


**Updating the list:**

Edit the `docs` array in `default.conf.py@268`.
 2023-06-16 14:36:35 +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
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
Andrea Longo
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
Andrea Longo
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
Andrea Longo
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
Daryl White
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
Andrea Longo
9f5be8878b
fix link in deploy-operator-helm (#871) 
Yay @djwfyi  had the correct syntax
 2023-06-05 17:59:20 -06:00
Andrea Longo
65e284f453
Helm deploy docs (#851) 
Document how to deploy with a Helm chart, based on [How to install MinIO
Using Helm in
Kubernetes](https://github.com/cniackz/public/wiki/How-to-install-MinIO-Using-Helm-in-Kubernetes).

This addition maintains the existing plugin instructions as the primary
path, with Helm as a child page under that. That makes room for future
deploy options.

The existing `common-install-operator-kubectl-plugin-install.rst` is now
in two parts, to allow only including the second part in the Helm
instructions. Also promoted the Upgrade page to be a sibling to Deploy.

Many of the original instructions are environment setup that enable
installing the Helm charts, starting Operator, and creating a tenant.
That will vary by the user's environment, so omitted for docs.

Staged:

http://192.241.195.202:9000/staging/DOCS-798/k8s/html/operations/install-deploy-manage/deploy-operator-helm.html

Fixes https://github.com/minio/docs/issues/798
 2023-06-05 17:45:58 -06:00
Andrea Longo
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