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

365 Commits

Author SHA1 Message Date
Andrea Longo
79b70ddccd
Remove underscore from webhook endpoint env var example (#761)
The webhook endpoint variable example on the Publish Events to Webhook
page has an extra underscore at the end of the variable names. (After
`<IDENTIFIER>`.) Remove them so the example is correct.

Fixes https://github.com/minio/docs/issues/744
2023-03-17 12:01:24 -06: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
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
732b6c3de7
Updating Nginx Reverse Proxy documentation (#743)
- Proxying MinIO based on subdomains of a single hostname
- Proxying MinIO based on subpath of a single hostname
- Including the websocket upload logic
2023-03-06 12:19:44 -05: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
Daryl White
43e41fc528
Updates for Console 0.23.1 (#738)
- Adds info about runtime configuration selector in operator docs
- Adds note about audit and monitoring disabled by default for new
tenants
- Adds info about new server certificate expiration visibility
- Renames Notifications tab to Events in the managing objects console
doc

Notifications > Events already previously changed in the managing
objects doc.

Closes #733
2023-02-24 10:09:31 -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
Ravind Kumar
d407d3bf52 Minor Fix: Edit Windows admon 2023-02-15 13:35:22 -05: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
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
b79ac90fcf Found bug. need two links per extlink 2023-02-14 17:38:56 -05:00
Ravind Kumar
264d23f18f Adding video link to mc training 2023-02-14 17:09:41 -05:00
Rushan
e9fe3bfee2
UI Enhancements: Recommended video section, k8s active class, mobile nav links (#726)
- Give recommended video section a makeover 
<img width="355" alt="Screenshot 2023-02-08 at 14 05 44"
src="https://user-images.githubusercontent.com/13393018/217500836-348b4063-2c54-4b23-8daa-20b127aa7d79.png">

- Fix k8s's active nav state
- Fix nav links wrapping on mobile (current behaviour on production
looks likes below)
<img width="637" alt="Screenshot 2023-02-08 at 11 50 10"
src="https://user-images.githubusercontent.com/13393018/217501024-1b8d21d6-0787-46b0-a8f4-fba8e1086f36.png">
2023-02-14 09:18:50 -06:00
Ravind Kumar
c0488b3328 Fixup: Link to Kubernetes issue on port-forwarding 2023-02-13 11:43:21 -05:00
Allan Roger Reid
33a54a2e48
User and group are no longer treated as flags (#734) 2023-02-13 10:45:33 -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
81964203ed
Corrects SSE-C command (#721)
Community request to fix a doc command.

Closes #652
2023-02-03 17:23:02 -06:00
Daryl White
6482571bf2
Update mc reference docs for improved nav structure (#717)
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc

Closes #710
2023-02-02 16:52:36 -06:00
Daryl White
0d8e510234
Final decommission listing check (#719)
Addresses updates for [minio
RELEASE.2023-01-12T02-06-16Z](https://github.com/minio/minio/tree/RELEASE.2023-01-12T02-06-16Z)

- Adds note about decommission behavior to check list of objects at end.

Closes #706
2023-02-02 15:27:18 -06:00
Daryl White
238888d765
Updates to docs for mc RELEASE.2023-01-28T20-29-38Z (#718)
Updates related to [mc
RELEASE.2023-01-28T20-29-38Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-01-28T20-29-38Z)

- new `--comment` flag for `mc admin user add` service accounts
- new `--airgap` flag for `mc license unregister`
- new `--encrypt-key` flag for `mc ilm restore`
- removed `--duration` flag for `mc support perf`
- new `--api-key` flag for `mc license register`

No doc issue for tracking this release.

Closes #715 for ilm restore flag
2023-02-02 14:27:43 -06:00
Ravind Kumar
e708f9dcda Typo, GKE strikes again 2023-01-31 15:35:20 -05:00
Ravind Kumar
9055a734dd typo in searchstring 2023-01-31 15:30:00 -05:00
Ravind Kumar
c3958eaff3
Bugfix: Broken search logic for Kubernetes Upstream (#716)
I think this will fix the incorrect URL logic for the searchbar, and
also fixes it for the newly added docs platforms.
2023-01-31 14:57:23 -05:00
Rushan
b0282bc30b
Add clickable buttons to navigate between images in the carousel (#714)
Preview:
<img width="992" alt="Screenshot 2023-01-25 at 20 03 00"
src="https://user-images.githubusercontent.com/13393018/214613411-28d2b9b9-2031-4d6a-8aac-3ddeea763199.png">

Limitations:
- Arrows are only present on the carousel and not in the Lightbox
preview. In the future, I'll investigate the options for including
arrows on the Light box. For this, we might need to replace the existing
Lightbox plugin with a modern one.
- Loop navigation is not available; instead, arrows will only be shown
when they correspond to the first and last slides.
2023-01-25 11:26:37 -06:00
Kaan Kabalak
9f2d66f1c5
Display ToC text enclosed in code tags (#713)
This commit also removes links located on certain subtitles

Fixes #703
2023-01-25 12:12:19 -05:00
Ravind Kumar
377d9659d2 Minor Fix: Remove 0-parity EC reference from EC docs 2023-01-25 11:44:16 -05:00
Daryl White
05e2452c36
Updates for minio RELEASE.2023-01-18T04-36-38Z (#711)
minio
[RELEASE.2023-01-18T04-36-38Z](https://github.com/minio/minio/releases/tag/RELEASE.2023-01-18T04-36-38Z)
affects the docs:

- Decommissioning of multiple pools [PR
#16416](https://github.com/minio/minio/pull/16416)
- Automatic SUBNET license update [PR
#16391](https://github.com/minio/minio/pull/16416)

There is no doc issue to track this update.
2023-01-20 15:20:10 -06:00
Daryl White
b3b90caabe
Console updates for 0.22.2 and 0.22.3 (#712)
Several updates for the MinIO Console docs related to 
[v0.22.2](https://github.com/minio/console/releases/tag/v0.22.2) and
[v0.22.3](https://github.com/minio/console/releases/tag/v0.22.3).

Also takes the opportunity to break up the Console doc and remove
screenshots.

- Splits MinIO Console doc into three separate pages
- Removes screenshots from console pages
- Adds toctree to MinIO Console page and references to new pages

Closes #709

- Adds OIDC and LDAP sections to console

Closes #683

- Adds details on object browser (now separated out from bucket browser)

Closes #686
2023-01-20 14:25:33 -06: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
Daryl White
46abdb4a57
Adding order of operations for expansion and decommission (#705)
- Modifies decommissioning page to mention completing any planned
expansions first.
- Modifies expand deployment page to mention completing before doing any
planned decommssions.
- Minor grammar fixes to expand tenant page.

Closes #702
2023-01-17 15:30:57 -06:00
Daryl White
b0a97ce1f4
Updates for mc RELEASE.2023-01-11T03-14-16Z (#704)
- Adds info on `mc mirror` continuing after a failed object sync [PR
4427](https://github.com/minio/mc/pull/4427)
- Adds addition call type to `mc admin trace` [PR
4416](https://github.com/minio/mc/pull/4416)
- Adds info about changed default file behavior for `mc support inspect`
[PR 4420](https://github.com/minio/mc/pull/4420)
- Concurrent upload support for `mc pipe` [PR
4435](https://github.com/minio/mc/pull/4435)
- Renames two `mc admin replicate` subcommands [PR
4383](https://github.com/minio/mc/pull/4383)
- Updates behavior of `mc license update` to no longer require license
file [PR 4429](https://github.com/minio/mc/pull/4429)
- New flag for `mc admin update` to bypass confirmation prompt [PR
4439](https://github.com/minio/mc/pull/4427)

There is no doc issue to track this update.
2023-01-17 13:19:53 -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
Daryl White
ea489b4a30
Updates for minio Dec 2022 releases (#701)
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.

Updates for Dec 2022 minio updates
    
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
    
Closes #684

Updates for Jan 2 2023 release
    
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
    
Closes #689
2023-01-12 13:57:36 -06: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
dbbfce1aeb
DOCS-677: Update site replication recovery procedure (#694)
Closes #677 

Updates the site replication recovery tutorial with slight tweaks to the multi-site expansion tutorial to account for the latest changes to MinIO/MC

Co-authored-by: Poorna <poornas@users.noreply.github.com>
2023-01-06 18:03:59 -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
35d575f6c3
Updates mc replicate commands (#692)
- Dec 24 2022 mc release moves `mc admin bucket remote` commands to mc
replicate
- Updates `mc replicate add | update | ls | rm | status` commands
- Adds pointers from `mc admin bucket remote` command to relevant new
pages

Closes #681

Partially addresses #691

- Corrects minor formatting error in glossary to address build errors
2023-01-04 16:57:03 -06:00
Daryl White
b94cd46a83
Adds a recommendation to limit prefix contents to 10k objects. (#674)
Per @klauspost we need to add info to the docs about MinIO's
recommendation to limit prefixes to no more than 10k objects.
This updates the glossary entry, object management doc, and admin
concepts to add that recommendation.

Closes #666
2023-01-03 12:17:04 -06:00
Rushan
845f0ed15c
Fix k8s search result page's pathname (#688) 2022-12-30 13:35:01 -06:00
Rushan
376f37f69e
Add search page (#687)
- Default Sphinx search page has been replaced with Algolia's 
- Enabled routing to sync the search results with URL

**Preview:**
<img width="1458" alt="Screenshot 2022-12-30 at 14 47 28"
src="https://user-images.githubusercontent.com/13393018/210061993-c906461e-87e2-426f-b956-462cfa77ed40.png">

**How to test:**
1. Click on a search result, navigate back using the browser back button
and check whether the search result modal is open and available.
2. Type a search keyword and press the enter key to navigate to the
search results page, where you can find all the results listed.

Note: You might need to start the local web server on the exact build
sub-directory to test the point number 2.
`build/[branch]/[platform]/html/` - ✔️
`build/` - 
2022-12-30 12:42:11 -06: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