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

58 Commits

Author SHA1 Message Date
Daryl White
ca34aa7e43 Add cert-manager documentation (#1317)
Adds cert-manager docs for Kubernetes outputs.

Closes #1245 

Partially addresses #1273
2024-10-01 16:06:37 -04:00
Andrea Longo
d17c896f75 attempt to remove plugin from docs (#1219)
The Kubernetes plugin is gone, this PR replaces the procedures that use
`kubectl minio` in all its various forms. The plugin was referenced on
many pages and for many purposes so there is _a lot_ of restructuring
involved.

Some procedures no longer have CLI instructions, which can be addressed
in subsequent PRs. Everything should have at least one working method,
even if it's to use Operator Console.

- Remove references to plugin, except for pre-4.5.8 upgrade paths
- Move pre-4.5.8 upgrade paths to new child page (currently hidden from
TOC, linked in page)
- Fill in with new Kustomize, kubectl, and/or Operator Console steps.

A handful of old screen captures still to be updated

Staged:
- [Operator
deploy](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/installation.html)
- [Operator
upgrade](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/install-deploy-manage/upgrade-minio-operator.html)
- [Deploy and manage
Tenants](http://192.241.195.202:9000/staging/DOCS-1213-upstream/k8s/operations/deploy-manage-tenants.html)

Fixes https://github.com/minio/docs/issues/1213
2024-06-07 09:05:39 -06:00
Ravind Kumar
e4f76ba1cf DOCS-1178: Add S3 API Compatibility List (#1180)
Closes #1178 

This covers the S3 APIs which we directly support - reference
minio/minio/cmd/api-router.go

Any APIs which are marked as 'dummy' internally are considered
'unsupported'
Admin APIs are out of scope here
MinIO API extensions are out of scope as well

We are not doing any detailed reference - just pointing out to S3

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2024-04-05 17:28:43 -04:00
Daryl White
fa4e28f78c Splits the helm chart reference page (#1142)
Internal request to split the Operator and Tenant helm chart into
separate pages.

This adds a replacement link in default-conf to automate updating the
operator version in the URL.
2024-03-06 09:29:08 -05:00
Ravind Kumar
a7acdcdfe8 DOCS-1076: Operator v5.0.11 Release (#1117)
Closes #1076 

Smaller than I expected, and a few things I don't think we need to
document.

Staged:

-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/developers/sts-for-operator.html
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-create.html#kubectl.minio.tenant.create.-kes-image
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/kubectl-minio-plugin/kubectl-minio-tenant-delete.html#kubectl.minio.tenant.delete.-retain-namespace
-
http://192.241.195.202:9000/staging/DOCS-1076/k8s/reference/operator-environment-variables.html

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-31 19:17:57 -05:00
Ravind Kumar
31bd45f20f DOCS-1084: Fix deployment menus for Windows, macos, containers, Add s… (#1108)
…cript for xfs settings to Linux"

Closes #1084 

Accomplishing a few things here:

1. General tidy-up of the installation pages so Windows/Container/MacOS
only display the appropriate deployment topos
2. Better admonitions/guidance on when to use what distribution
3. Added a section on Storage + XFS Settings to resolve an ongoing
customer request


---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-01-23 14:12:11 -05:00
Ravind Kumar
c770ba9d76 DOCS-1021: Adding helm information (#1060)
Closes #1021 
Closes #1055 
Closes #968 
Closes #943 


---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
2023-11-16 12:56:20 -05:00
Andrea Longo
31db10bcf9 Make it easier to find play login (#1054)
The login info for `play` is buried in the MinIO Console page. Link to
it (and info about Console) from the top level page.

Staged
http://192.241.195.202:9000/staging/play-link/linux/index.html
2023-10-31 06:47:22 -06:00
Ravind Kumar
69e291fa6e DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025)
Closes #1007
2023-10-10 16:45:06 -04:00
Andrea Longo
1aea92b141 SFTP access for Operator Tenants (#993)
Document SFTP access for Operator Tenants, from Operator v5.0.7.
https://github.com/minio/operator/pull/1685
https://github.com/minio/operator/pull/1692

The new Operator SFTP text and the not-Operator version it is based on
were converted to includes rather than have a mess of conditionals in a
single file.

Staged

http://192.241.195.202:9000/staging/DOCS-943-2/k8s/developers/file-transfer-protocol.html

http://192.241.195.202:9000/staging/DOCS-943-2/linux/developers/file-transfer-protocol.html

Partially addresses https://github.com/minio/docs/issues/943
2023-09-08 12:45:29 -06:00
Andrea Longo
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
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
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
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
Ravind Kumar
a432637298 Adding more EDU videos (#803) 2023-04-10 16:36:35 -04: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
96cda9c385 DOCS-728: Dropping Windows cruft (#729)
Closes #728
2023-02-10 14:21:42 -05: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
Ravind Kumar
9b7a95d2b2 K8S-RELEASE: Adding EKS, GKS, AKS (#696) 2023-01-10 17:16:21 -05:00
Ravind Kumar
094d0df6b8 Proof of Concept on right-nav video links via RST + JS (#682) 2022-12-27 13:46:55 -05:00
Daryl White
e2f30fb5fd Adds mc batch commands to the docs (#620)
Closes #605

- Adds the five `mc batch` subcommands
- Adds a batch framework page to the Administration section of docs
2022-11-14 17:40:21 -06:00
Daryl White
1963d67a64 Changes to get Algolia crawler to pull OpenShift docs (#613)
Algolia's crawler is not picking up the OpenShift docs.
This has fixes to get the sitemap to build correctly so the OpenShift
docs can be crawled.
2022-10-17 14:38:29 -05: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
Ravind Kumar
6501f7abd1 Fixing conditional for K8s operator version 2022-09-20 12:53:35 -04:00
Ravind Kumar
b099ffb149 Removing redundant licensing section 2022-09-20 12:33:06 -04:00
Ravind Kumar
1cc507564c Initial work for git-managed redirects (#556)
This is the initial work for what should be a git-managed set of nginx
configs we can include into the Nginx Docs server.

The idea here is we manage redirects in git, and either chron-copy them
to a location we can include via the sites-available/<file>, *or* we
just include them from the git path (if nginx tolerates that)

I can't really _test_ these right now since they are using live URLs. if
we move forward with the soft-launch, we'll have a few opportunities to
maybe test a subset of these URLs and see what happens.

Please let me know if there is anything *obviously* wrong here.

ToDo: The Legacy Docs redirects
2022-09-20 12:27:40 -04:00
Ravind Kumar
d815aa9ce8 Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Daryl White
ac7f725e43 Adding concept docs for operation and administration sections (#519)
Creates an administration/concepts.rst file.
Adds content to the operation/concepts.rst file stub.
2022-08-24 16:40:48 -05:00
Ravind Kumar
c783e10594 DOCS-492: Container Platform Docs
This commit also generally cleans up the Installation docs and uses /includes/<platform>/steps-*.rst as a pattern for storing platform-specific tutorials within a single root URL.

Finally, due to API rate limits, this commit adds some Makefile magic to allow skipping of sync'ing dependencies. Pass `make BUILD_DEPENDENCIES=FALSE <platform>` to skip building any deps and use what is already in the branch.
2022-07-18 17:46:59 -04:00
Daryl White
9f6086fdc6 Adding a glossary file and updating term link color
This commit only adds the glossary to the docs.
It does not apply :term: directives throughout the rest of the docs to link to the glossary.
2022-07-13 13:23:28 -05:00
Ravind Kumar
ffeff0365e Migrate Tenant Deployment/management guides 2022-06-16 15:41:56 -04:00
Daryl White
1ef454bf05 Adding kubectl ref docs 2022-06-15 13:34:04 -05:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00
Daryl White
6e4422b029 Add mc support commands and a new support section with SUBNET info 2022-05-20 16:59:31 -05:00
Ravind Kumar
a566631be2 DOCS-448: Create new per-platform quickstart guides
Co-authored by: Ravind Kumar <ravind@min.io>
Co-authored by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2022-04-20 10:03:20 -05:00
Ravind Kumar
c61c5b16c5 Remove EOL'd docs on Gateway 2022-02-16 18:03:24 -05:00
Ravind Kumar
ea01909527 SDK import, Nav cleanups, DOCS-417 2022-02-08 16:38:35 -05:00
ravindk89
a6fb44ac60 Updating makefile to pull latest MinIO version and DEB/RPM URLS 2022-01-10 20:35:20 -05:00
ravindk89
ef30821063 DOCS-380: Refactor CLI reference 2022-01-04 19:11:15 -05:00
ravindk89
2525a0891d DOCS-370: Object Locking Feature Page
CR w/ Eco

Addressing Eco suggestions

Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>

Klaus fixups
2021-09-14 18:52:27 -04:00
ravindk89
66f21a05ac And always clear your build directory to make sure you're seeing the right data
Let these commits stand forever as a ward against hubris
2021-08-17 19:31:00 -04:00
ravindk89
13ae4eb7e1 Fixing bad syntax, always build before pushing 2021-08-17 19:26:31 -04:00
ravindk89
5ce137f608 Fixing lingering licensing issues 2021-08-17 19:24:30 -04:00
ravindk89
b80599ea54 MinIO Console Documentation 2021-08-10 14:11:15 -04:00
ravindk89
221285a64d Cleaning CSS, updating packages 2021-07-29 17:09:01 -04:00
ravindk89
773e5c67b7 Refactor the installation documentation
Refactor the installation documentation

Address Code Review comments, further refinements

More review feedback fron Kannappan

Broken ref

More fixups

Final fixups
2021-07-23 17:18:51 -04:00
ravindk89
08a38c2a71 DOCS-355: Update quickstart for Embedded Console 2021-07-07 21:49:18 -07:00
ravindk89
d4739f7db5 Fixing copyright header, minor typo 2021-05-12 10:42:08 -04:00
ravindk89
5a5a8a6908 MinIO ILM Migration + Tiering
Apply suggestions from code review + local changes

Co-authored-by: Poorna Krishnamoorthy <poornas@users.noreply.github.com>
Co-authored-by: Krishnan Parthasarathi <krisis@users.noreply.github.com>

Apply suggestions from code review

Co-authored-by: Krishnan Parthasarathi <krisis@users.noreply.github.com>
2021-05-12 10:20:29 -04:00
ravindk89
7736389e86 Fixing envvars 2021-05-12 10:10:33 -04:00