1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Commit Graph

530 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
9f5be8878b fix link in deploy-operator-helm (#871)
Yay @djwfyi  had the correct syntax
2023-06-05 17:59:20 -06:00
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
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
4345552d7f Broken link to decommission page (#862)
Corrects a link that resulted in a 404 from K8s tenant page to
decommission page.
2023-05-25 13:29:35 -05:00
7a852def87 DOCS-763 part 2: Eco feedback (#853)
Context:
89bc154bbf



Responding to Eco's review points.


Staged: http://192.241.195.202:9000/staging/DOCS-763-2/linux/index.html
2023-05-23 17:30:36 -04: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
423e38315e Fix admonition toggle button padding (#858)
Fixes https://github.com/minio/docs/issues/857
2023-05-18 10:03:22 -05: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
ceff634882 Minor update to reference hardware 2023-05-16 16:48:49 -04:00
840bd073cc DOCS-854: Typo in include 2023-05-16 14:22:46 -04:00
7132e8ed02 Errant TOC entry in administration/concepts.rst 2023-05-12 12:58:02 -04:00
283e18cf5f Minor typo cleanups 2023-05-12 12:51:37 -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
b3fdcef007 DOCS-763: Update pool, availability, resiliency, and erasure code docs (#843) 2023-05-12 12:19:45 -04: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
d293a50ab9 Adds changes for MinIO RELEASE.2023-04-28T18-11-17Z.
- Adds note to removed metric
- Adds note to an existing  metric now available on the console's metric dashboard

Closes #840
2023-05-11 12:44:19 -07: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
6c5d694756 Add info about time sync (#847)
Adds a checklist item to software about configuring time
synchronization. Adds a prereq to the multi-node deployment about time
sync.

Closes #778
2023-05-09 09:56:13 -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
dbb34f4b3e Adds STS info for Operator (#841)
Creates a new page for STS tokens specifically for Operator.

Closes #792

Staged:
http://192.241.195.202:9000/staging/k8s-sts/developers/sts-for-operator.html
2023-05-04 14:51:44 -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
6c6a1d49db Increase left nav width (#839) 2023-05-01 16:50: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
1a0905f70e Include port number for the example MINIO_SERVER_URL (#831)
The example environment variable setup does not include port 9000. As a
new user this tripped me up.

---------

Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
2023-04-25 10:30:29 -04:00
8ddbea3439 correcting alias order (#834)
### Objective:

To correct the alias order
2023-04-25 10:27:52 -04:00