1
0
mirror of https://github.com/minio/docs.git synced 2025-05-21 11:53:41 +03:00

99 Commits

Author SHA1 Message Date
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
Ravind Kumar
e7c6473394
DOCS-784: Fix Kafka TLS Client Auth reference (#816) 2023-04-14 11:49:32 -04:00
Ravind Kumar
a432637298
Adding more EDU videos (#803) 2023-04-10 16:36:35 -04:00
Ravind Kumar
f6538cadd9
DOCS-779: Fix permission set for MinIO on KES (#793) 2023-04-04 09:36:35 -04: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
Ravind Kumar
b32d6167db
DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
Pedro Juarez
7e5831c5da
Update changed location of crd doc file in Operator repo (#753) 2023-03-10 12:01:45 -06: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
Ravind Kumar
b1bf12145f
Improve SEO for Index + Quickstart Pages (#742)
# Summary

SEO guided towards some refinements of the H1s on the index and
quickstart pages
2023-02-24 16:46:10 -05:00
Ravind Kumar
d407d3bf52 Minor Fix: Edit Windows admon 2023-02-15 13:35:22 -05:00
Daryl White
38c06fffeb
Update for minio RELEASE.2023-02-09T05-16-53Z (#732)
Adds info about some discs being offline during start. For minio PR
[16541](https://github.com/minio/minio/pull/16541)

Closes #730
2023-02-15 11:01:09 -06:00
Ravind Kumar
c0488b3328 Fixup: Link to Kubernetes issue on port-forwarding 2023-02-13 11:43:21 -05:00
Ravind Kumar
96cda9c385
DOCS-728: Dropping Windows cruft (#729)
Closes #728
2023-02-10 14:21:42 -05:00
Ravind Kumar
94d1faa9c1
Port-Forwarding cleanups (#722)
As per https://github.com/minio/console/issues/2539 , the websocket
behavior integrated as part of Console 0.22.1
(https://github.com/minio/console/pull/2419) seems to break
port-forwarding behavior.

There's no easy fix for this. NodePorts are a workaround, but slightly
kludgy. Ingress is the better long-term solution, but requires more
work.

This is a stopgap:

- For Operator, point users towards NodePorts if port-forwarding fails
- For Tenant Console, simply drop port-forwarding entirely and point
only at Ingress/LB

Out of scope but in progress is Ingress guidance for Nginx and Traefik
so we can close the loop on this.
2023-02-07 11:17:24 -05:00
Ravind Kumar
da88409290
DOCS-690, DOCS-707: Release updates (#720)
Closes #690 

Closes #707 

Partially addresses scheduled removal of Console Audit Log and Tenant
Prometheus deployments
2023-02-03 18:27:45 -05:00
Daryl White
878e85d2db
Adds ARM64 architecture to Linux install pages (#708)
- updates Makefile to retrieve ARM URLs
- updates default-conf to create substitutes for ARM URLs
- updates linux install include to add dropdowns for each architecture

Closes #679
2023-01-17 16:53:04 -06:00
Ravind Kumar
3559267dea
DOCS-699: improve documentation on storage classes for remote targets (#700)
Closes #699
2023-01-12 15:14:13 -05:00
Ravind Kumar
9ae1e87c75 Fixing issues after multiple large merges 2023-01-10 17:44:40 -05:00
Ravind Kumar
9b7a95d2b2
K8S-RELEASE: Adding EKS, GKS, AKS (#696) 2023-01-10 17:16:21 -05:00
Daryl White
00de8dbeb6
Updates to mc docs for December 2022 releases (#697)
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.

- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
    
Closes #685

- Updates ilm commands for new structure for tiers and rules
    
    - Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
    - Adds new `mc ilm rule` and six subcommands
    - Adds new `mc ilm tier` and six subcommands
    - Updates references to ilm and admin tier  commands throughout docs
    - Adds new deprecated commands page
    - Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees

- Closes #691
- Closes #662
2023-01-10 15:47:02 -06:00
Tim Beermann
45aac689b4
added krew upgrade command (#698)
Ran into this while looking at
<https://min.io/docs/minio/kubernetes/upstream/operations/install-deploy-manage/upgrade-minio-operator.html>.
The headline of point "3" states "Download the Latest Stable Version of
the MinIO Kubernetes Plugin", but it actually includes just an
installation guide.
Therefore extended the included installation guide with guideline how to
update the plugin with krew.

Signed-off-by: Tim Beermann <beermann@osism.tech>

Signed-off-by: Tim Beermann <beermann@osism.tech>
2023-01-09 10:56:29 -05:00
Ravind Kumar
c2dacd93f2
DOCS-691: Fix replication tutorials for new syntax, other minor fixes (#693)
Partially addresses #691 

Follows up #692 

#. Summary

Updates replication tutorials to use latest syntax for `mc replicate
add`, removing references to `mc admin bucket remote add`

Includes some build output fixes for non-Linux builds.

Staged:

- [One-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-one-way-bucket-replication.html#configure-one-way-bucket-replication-using-the-command-line-mc)
- [Two-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-two-way-bucket-replication.html#configure-two-way-bucket-replication-using-the-command-line-mc)
- [Three-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.html#configure-multi-site-bucket-replication-using-the-command-line-mc)
- [Resynchronize
Bucket](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/server-side-replication-resynchronize-remote.html)
2023-01-04 21:49:26 -05:00
Daryl White
6d32ddcaa8
Update for early Dec 22 minio release (#671)
## Updates for `console` early Dec22 releases

- Updated the instructions for registering for SUBNET from an airgapped
Console environment
- Minor typo in IAM doc.

Closes #664

Two of the items in that issue did not actually impact the docs. One
item is just a screenshot update that will be addressed later.

## Updates for `minio` early Dec22 releases
    
- Adds info about `mc` installed with container images
- Adds new envvar for KES enclaves
    
Closes #665

- Updates `mc support inspect` to correct alias to target in command
syntax
2022-12-28 11:41:23 -06:00
Ravind Kumar
094d0df6b8
Proof of Concept on right-nav video links via RST + JS (#682) 2022-12-27 13:46:55 -05:00
hartraft
2fb4fb552a
Add minio client ARM64 installation step (#680)
Reference the already published arm64 binary as more users are running
on ARM64

https://github.com/minio/docs/issues/679
2022-12-19 11:24:52 -05:00
Max
390ae7bd94
Adding missing namespace in port-forward (#675)
On page about Kubernetes
(https://min.io/docs/minio/kubernetes/upstream/index.html#procedure) in
point 3, the namespace is missing.

Co-authored-by: Max Roy <max+unset@github.com>
2022-12-13 15:10:50 -05:00
Daryl White
348758b807
mc updates for RELEASE.2022-12-02T23-48-47Z (#667)
Updates mc docs for
[RELEASE.2022-12-02T23-48-47Z](623de88abd)
and closes several issues:

- Adds `mc support callhome`
- Simplifies and moves `mc support logs` to `mc admin logs`
- Adds `mc support proxy` command
- Adds `mc admin replicate resync` command

Closes #655 
Closes #663
Closes #644
2022-12-08 14:09:36 -06:00
Ravind Kumar
1cfda2e9dc
RELEASE: Multiple Issues (#647)
Closes #639 
Closes #635 
Partially Addresses #590 

- MINIO #16026 https://github.com/minio/minio/pull/16026
- MINIO #16044 https://github.com/minio/minio/pull/16044
- MINIO #16035 https://github.com/minio/minio/pull/16035
- CONSOLE #2428 https://github.com/minio/console/pull/2428

Other Fixes:

- Removes admonition about IDP interactions (multi-IDP support)
- Update Console screenshots and overview page to cover layout changes
- Partial fix for DOCS #590 (Policy now under Identity section)
2022-11-23 14:51:47 -05:00
Daryl White
bce5f8267f
Updates for minio RELEASE.2022-08-22T23-53-06Z (#648)
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
    
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts

Closes #537
2022-11-22 15:08:35 -06:00
Daryl White
0cd491c328
Mc updates for multiple releases (#642)
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
2022-11-18 12:49:03 -06:00
Daryl White
422d0d915f
Update docs for mc release 2022-10-01 (#643)
Closes #602

- Revises the note about mc support commands requiring SUBNET
registration
- Moves note to the top of each `mc support` subcommand page
2022-11-16 16:03:57 -06:00
Javier Adriel
33d5c70922
Update installation.rst (#638) 2022-11-11 10:46:38 -05:00
Javier Adriel
6228d0f56e
Fix typo in installation (#637)
Found this typo while reading the documentation. 
Not sure if this everything that is needed since i'm not familiar with
how docs are generated but hope this helps :)

Please close this PR if i'm missing something
2022-11-09 15:38:38 -06:00
Ravind Kumar
64ca9697cf
DOCS-625: Removing FS Mode guidance, cleanups to deploy docs (#626)
Closes #625
2022-10-31 14:21:44 -04:00
Ravind Kumar
af0fc05bc6 Minor fix to common-replication.rst 2022-10-28 16:27:01 -04:00
Daryl White
1735b77d8f
Adding load balancing content for site replication (#622)
Closes #618

- Adds recommendation for pointing to a load balancer, reverse proxy, or similar for multi-node environments when creating aliases for site replication. 
- Explains that this recommendation avoids a single point of failure risk.
- Updates tabs on site replication page to be in sync when a reader selects Command Line or Console instructions.
- Adds :sync: option example to the design doc.
2022-10-27 13:10:02 -05:00
Ravind Kumar
82c6d38278 Minor fixes 2022-10-20 17:57:16 -04:00
Ravind Kumar
21797d127b
DOCS-610: Update KES procedures for KES 0.21.0, minor cleanups for Vault (#612)
Closes #610 

Did a QA pass after reports of some issues with the vault setup.

Identified an issue where my local testing was done with 0.20.0,
resulting in some errors on 0.21.0 due to dropping --mlock.

Also did a few other general tune ups as I ran end-to-ends again using
Vault + Systemd instead of vault in dev mode.

Staging views in #minio-docs channel
2022-10-18 13:15:05 -04:00
Ravind Kumar
8d8e6bca29
Procedure for updating Operator (#608)
Build out Operator Upgrade Procedure

Co-authored-by: Lenin Alevski <alevsk.8772@gmail.com>
2022-10-12 12:08:30 -04:00
Ravind Kumar
f191fd7c10 Remove operator upgrade from TOC until procedure is written 2022-10-04 10:50:48 -04:00
Daryl White
c7a46b932f
Updating docs for changes with Operator 0.19.5 (#592)
Closes #527

- Adds information about the new Register tab in the Operator
- Updates screenshots to show the Register tab
- Adds note about permissions when managing buckets in a tenant
- Added new FSGroupChangePolicy field to security context when creating
tenants
2022-10-03 16:41:21 -05:00
Harshavardhana
59760ed079
download rpm as minio.rpm not minio.deb (#594) 2022-10-03 13:44:11 -04:00
Ravind Kumar
d5d3243413
DOCS-580: Fixing reported issues with Vault tutorial (#591)
@djwfyi cursory review in case I missed something.

Closes #580 

I do need to do further testing beyond the patches here. But I'm going
to handle that out-of-band.
2022-09-30 17:47:12 -04:00
Ravind Kumar
32366b2a15
Adding OpenShift Platform (#577)
# Summary

This pull adds back the OpenShift docs as a full dedicated platform

The main changes are:

- Adding the conditionals for OpenShift
- Modifying the Makefile for the new platform
- Adding the tutorials back in
- Fixing up the navigation headers

This was not too much trouble, which bodes well for the future.
2022-09-29 10:37:08 -04:00
Daryl White
92ee087d4f
Updating all references to docs.min.io URLs (#584)
Updating remaining links to the old docs site to point to the new URLs.

Closes #581
2022-09-26 14:21:29 -05:00
Ravind Kumar
33af30eb71 Fix typo in container quickstart 2022-09-23 16:11:48 -04:00
Harshavardhana
7388f4b33e
update mc/minio source installation docs (#575) 2022-09-21 13:40:06 -04:00
Daryl White
c483255dea
Add reference docs for mc support logs (#546)
Adds four reference docs for the subcommands of `mc support logs`.
Adds a section to the troubleshooting doc for using `mc support logs` to
send error logs to SUBNET.

Closes #511 .
2022-09-19 13:54:09 -05:00
Ravind Kumar
d815aa9ce8
Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Ravind Kumar
40cd778e5b
Completion of SSE-KMS doc rewrite (#539) 2022-09-06 17:38:08 -04:00