minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-05 03:41:24 +03:00
Code Activity
466 Commits 17 Branches 0 Tags
DOCS-860-part2a
Commit Graph

164 Commits

Author SHA1 Message Date
Andrea Longo
f9abc12e04 drop kafka changes for the moment 2023-06-16 16:36:21 -06:00
Andrea Longo
ac25949bcc new envvars and settings 2023-06-15 16:03:20 -06: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
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
Ravind Kumar
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
Ravind Kumar
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
Fredrik Carlbom
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
Daryl White
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
Ravind Kumar
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
Daryl White
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
Daryl White
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
Pedro Juarez
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
Daryl White
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
Daryl White
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
Andrea Longo
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
Cesar Celis Hernandez
8ddbea3439 correcting alias order (#834) 
### Objective:

To correct the alias order
 2023-04-25 10:27:52 -04:00
Andrea Longo
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
Andrea Longo
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
Daryl White
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
Andrea Longo
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
Daryl White
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
Daryl White
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
Daryl White
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
Daryl White
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
Vincent Composieux
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
Daryl White
2d900caa0f Adds new proxy argument webhook logger configuration. (#810) 
Closes #745

Also adds three other missing arguments for the webhook logger
configuration.
 2023-04-12 12:28:47 -05:00
Daryl White
d86463cba1 Adds Call Home information to the troubleshooting doc (#801) 
Closes #751
 2023-04-12 11:01:09 -05:00
Ravind Kumar
8caa50e3d1 General work on releases (#797) 
Closes #750 
Closes #736 
Partially Address #767
 2023-04-10 16:03:13 -04:00
Daryl White
ab49b29916 Correcting mc admin policy command links (#802) 
Missed some references to deprecated commands during an mc release doc
update (PR #799).
This fixes those references to the new commands.
 2023-04-05 16:46:28 -05:00
Daryl White
840417a6f7 Doc updates for mc RELEASE.2023-03-20T17-17-53Z (#799) 
- Adds note that `mc support proxy set|remove` no longer require
registration
- Adds info about stale ARNs for `mc replicate status` command
- Additional information for --dry-run flag in `mc rm`
- Thoroughly updates and restructures `mc admin policy` commands
- Adds new `mc batch cancel` command
- Updates deprecated commands for newly deprecated mc admin policy
functions
- Fixes toctree on mc admin page to allow for mc admin policy subcommand
nesting

Closes #766

Other fixes not part of the release:
- Updates `--fake` flag on `mc rm` to `--dry-run`
- Updates `--fake` flag on `mc mirror` to `--dry-run`
 2023-04-05 10:50:40 -05:00
Daryl White
2b5c5c8f99 Cleanup license commands (#794) 
Cleans up the license commands
 2023-03-31 09:37:08 -05:00
Andrea Longo
c1a84f756e Reapply missing commit from PR 783: mc du (#789) 
Small text and formatting edits. Lost due to network outage, oops.

Original PR: https://github.com/minio/docs/pull/783
Original issue: https://github.com/minio/docs/issues/764
 2023-03-30 15:06:26 -05:00
Andrea Longo
1f8ce6dec2 Add reference page for mc du (#783) 
Create a new reference page for `mc du` and link it in the list of `mc`
commands.

Staged:

http://192.241.195.202:9000/staging/DOCS-764/linux/html/reference/minio-mc/mc-du.html

Includes drive-by fixes to make the _Optional_ notations appear in a
more consistent manner. (Including several otherwise unrelated pages.)
There's more opportunistic fixes here than I might normally do in the
same PR, but seemed better to get it over with.

Fixes https://github.com/minio/docs/issues/764

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
 2023-03-30 13:36:41 -06:00
Daryl White
199d1eb1d4 Adds info on certificates with the MinIO Client (#782) 
- Adds a new section on certificates to the MinIO Client page
- Adds a new section in Behaviors to the mc alias set page
- Minor fix to a --json flag command in version doc

Closes #781
 2023-03-30 13:04:10 -05:00
Andrea Longo
31d5fbd117 Exclude prefixes or folders from versioning (#769) 
Object versioning can now be configured with certain exclusions (no
longer strictly on a per-bucket basis). Add documentation about how to
use the new options:
* `--excluded-prefixes` to exclude objects with certain prefixes
* `--exclude-folders` to exclude anything with name ending in `/`
(folders)

- [x] Exclude prefixes
- [x] Exclude folders
- [x] Wildcards/globbing
- [x] Limitations
- [x] View versioning exclusion configuration

Staged:
[Bucket
Versioning](http://192.241.195.202:9000/staging/DOCS-760/linux/html/administration/object-management/object-versioning.html)
[mc
version](http://192.241.195.202:9000/staging/DOCS-760/linux/html/reference/minio-mc/mc-version.html)

Fixes https://github.com/minio/docs/issues/760

---------

Co-authored-by: Krishnan Parthasarathi <krisis@users.noreply.github.com>
 2023-03-28 16:51:11 -06:00
Ravind Kumar
831f7b29de Removing errant debug statement 2023-03-24 18:41:01 -04:00
Ravind Kumar
b32d6167db DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Allan Roger Reid
7d15747908 MC ILM typo (#775) 
Syntax should be ALIAS/path. Also, no trailing / required.
 2023-03-24 14:24:31 -04:00
Ross Gardiner
87e4c6488a Update deprecated admin bucket remote commands (#772) 2023-03-24 10:38:13 -04:00
Ross Gardiner
6b2e89f39c Fix erroneous command for enabling versioning (#771) 2023-03-24 10:37:26 -04:00
Ross Gardiner
0b84f0353a Correct enable/disable options in mc replicate update (#773) 2023-03-24 10:36:27 -04:00
nvaatstra
09e79cba9a Add --incomplete to mc rm --incomplete example (#755) 
Current example for `Remove All Incomplete Upload Files for an Object`
shows the command for `Recursively Remove a Bucket's Contents`.

This PR adds the `--incomplete` flag to the `Remove All Incomplete
Upload Files for an Object` example.

Co-authored-by: Nico Vaatstra <nico.vaatstra@open-xchange.com>
 2023-03-14 10:36:03 -04:00
Daryl White
f37aee8416 Clean up of batch framework and mc batch docs (#749) 
- Removes bad copy paste info about ilm from batch command docs.
- Clarifies that batch files are one task only.
- Fixes source type from `s3` to `minio`.
- Cleans up indentation errors in replicate yaml example.
- Replicate task is local to remote only.

Closes #748
 2023-03-06 16:12:44 -06:00
Daryl White
c591983d4a Correct process for registering an airgapped deployment for subnet (#740) 
The steps for registering an airgapped deployment for subnet have
changed.
This PR updates the steps to the current process.
 2023-02-24 10:08:34 -06:00
Daryl White
c8e0e8a1a5 Changes for mid-February releases (#737) 
- Adds information about a new batch replication environment variable
(PR #16609)
- Adds note about metrics in `mc admin bucket remote bandwidth` moved to
`mc replicate status`

Partially addresses #736
 2023-02-21 12:13:53 -06:00
Daryl White
38bf361add mc admin speedtest and mc ping updates (#723) 
- Adds `mc ping` doc

Closes #538 

- Deprecates `mc admin speedtest` to `mc support perf`

Closes #678
 2023-02-15 11:37:11 -06:00
Ravind Kumar
b79ac90fcf Found bug. need two links per extlink 2023-02-14 17:38:56 -05:00