1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Commit Graph

466 Commits

Author SHA1 Message Date
ff80c86042 replace other /home/events 2023-06-19 09:48:13 -06:00
f9abc12e04 drop kafka changes for the moment 2023-06-16 16:36:21 -06:00
ac25949bcc new envvars and settings 2023-06-15 16:03:20 -06:00
0229fff937 drive by copypasta fix 2023-06-15 14:32:30 -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
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
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
e7db29ff03 Patching replication docs for version match requirement (#825) 2023-04-20 10:36:31 -04: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.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
ed88e699ab Link to systemctl update docs in rpm/deb install instructions (#822)
The update instructions in the "You are running an older version" banner
are not correct for systemd managed deployments (also the process
recommended for rpm/deb installs).

Link to the correct update procedure in the install docs. This is not
intended to be comprehensive, just pointers for future-admin who might
have forgotten.

Staged:

http://192.241.195.202:9000/staging/deb-upgrades/linux/html/operations/install-deploy-manage/deploy-minio-single-node-single-drive.html#download-the-minio-server
2023-04-19 13:56:05 -06:00
f05c657e99 Changes for Console release v0.26.0. (#821)
- Adds Audit Kafka tab to list of settings sections
- Adds info about diagnostic report uploading to SUBNET

Closes #788
2023-04-18 12:47:10 -05: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
48ac2437e8 Moves limit upload and limit download flags out of global list (#820)
Uses an include in case we need them for other commands later.

Closes #787

Also update mc mv to use standard optional and required formatting for
params.

Staged:
http://192.241.195.202:9000/staging/limitflags/reference/minio-mc.html#global-options
2023-04-14 15:37:31 -05:00
948fce19c8 Specify usage of mc in gateway migration (#817)
Fixes: https://github.com/minio/docs/issues/805
2023-04-14 13:26:55 -04:00
e7c6473394 DOCS-784: Fix Kafka TLS Client Auth reference (#816) 2023-04-14 11:49:32 -04:00
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
eaca36720d Adds information for command history and airgap version requirements. (#811)
- Updates troubleshooting doc for airgap registration
- Updates `mc license register` doc with airgap registration and command
history
- Updates `mc support diag` with command history

Closes #804
2023-04-14 09:51:11 -05:00
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