1
0
mirror of https://github.com/minio/docs.git synced 2025-06-30 17:42:04 +03:00

37 Commits

Author SHA1 Message Date
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
69e291fa6e DOCS-1007: Create sync pattern to pull in the CRD during releases (#1025)
Closes #1007
2023-10-10 16:45:06 -04:00
62e1447422 Document OpenShift service certificates for Operator deployments (#1002)
MinIO Operator on OpenShift may require manual configuration of TLS cert
management via the OpenShift `service-ca` Operator. (For deployments
that are _not_ done through Red Hat OperatorHub.)

Document the needed envvars, `volumes`, and `volumeMounts` to enable
`service-ca` and avoid the need to manually renew certs.

~Note: This presumes kustomize, additional research/testing required to
determine configuration for Helm chart deployments.~

Staged

http://192.241.195.202:9000/staging/DOCS-991/openshift/operations/installation.html#procedure

See also:
https://github.com/minio/wiki/wiki/Besides-MINIO_OPERATOR_RUNTIME-what-else-is-needed-in-Operator%3F

Fixes https://github.com/minio/docs/issues/991 (remaining item for
v5.0.8)

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-09-25 11:27:06 -04:00
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
76099f5cda Style Quick Steps section on quickstart pages (#977)
The section can be styled by adding the container class `.. rst-class::
section-next-steps`


<img width="798" alt="Screenshot 2023-08-30 at 13 52 07"
src="https://github.com/minio/docs/assets/13393018/7ff22195-1d2a-454f-9736-ea89a58a7515">
2023-08-30 10:59:19 -05:00
756d9f1799 Correct mc admin user example, fix warnings (#969)
A few small things:

* find/replace error from https://github.com/minio/docs/pull/950
* build warnings

Thank you @bendem!
https://github.com/minio/docs/pull/950#discussion_r1303044374
2023-08-23 16:04:32 -06:00
2908b2f9ee Optional custom init container (#967)
Operator 5.0.6+ allows custom init containers, should your pod require
additional initialization. Add a brief mention in the Operator install
page and link to the k8s docs.

Staged

http://192.241.195.202:9000/staging/DOCS-900-2/k8s/operations/installation.html#minio-operator-components

Partially addresses https://github.com/minio/docs/issues/900
2023-08-23 14:59:21 -06:00
3669b54fcf Operator supports PSA restricted namespaces (#965)
Add a mention in the Operator docs that MinIO supports the `restricted`
policy for [Pod Security
admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/)

Staged:

http://192.241.195.202:9000/staging/DOCS-900-1/k8s/operations/installation.html#kubernetes-version-1-19-0

Partly addresses https://github.com/minio/docs/issues/900
2023-08-23 12:01:19 -06:00
fbee736485 Fix a bunch of incorrect commands for attaching policies (#950)
Found many incorrect commands for creating/attaching policies to users
and groups.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-3-admin-policy/k8s/html/index.html

This is additional follow-up from
https://github.com/minio/docs/issues/919 and also SUBNET docs feedback.
2023-08-14 10:15:12 -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
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
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
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
a432637298 Adding more EDU videos (#803) 2023-04-10 16:36:35 -04:00
b32d6167db DOCS-476: OIDC, Keycloak, Dex, and Policy Variables (#735) 2023-03-24 18:39:50 -04:00
7e5831c5da Update changed location of crd doc file in Operator repo (#753) 2023-03-10 12:01:45 -06:00
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
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
9ae1e87c75 Fixing issues after multiple large merges 2023-01-10 17:44:40 -05:00
9b7a95d2b2 K8S-RELEASE: Adding EKS, GKS, AKS (#696) 2023-01-10 17:16:21 -05:00
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
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
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
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
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
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
f191fd7c10 Remove operator upgrade from TOC until procedure is written 2022-10-04 10:50:48 -04:00
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
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
d815aa9ce8 Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
40cd778e5b Completion of SSE-KMS doc rewrite (#539) 2022-09-06 17:38:08 -04:00
2376fa9924 DOCS-IA: Platformize SSE Docs. Hashicorp Pass (#518)
* Platformization of Data Encryption Docs: Hashicorp Pass

* Platformization of Data Encryption Docs: Hashicorp Pass

* Big pass, CR changes + K8s
2022-08-15 12:53:08 -04:00
1c416561ef Cleaning up Network Encryption pages 2022-07-05 16:43:55 -04:00
79e342b6d4 Adding create tenant CLI tutorial for K8s docs to the deploy tenant file. 2022-06-27 15:38:46 -05:00
ffeff0365e Migrate Tenant Deployment/management guides 2022-06-16 15:41:56 -04:00
1ef454bf05 Adding kubectl ref docs 2022-06-15 13:34:04 -05:00
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00