Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1021: Adding helm information #1060

Merged
merged 9 commits into from
Nov 16, 2023
Merged

DOCS-1021: Adding helm information #1060

merged 9 commits into from
Nov 16, 2023

Conversation

ravindk89
Copy link
Collaborator

Closes #1021
Closes #1055
Closes #968
Closes #943

This is technically dependent on minio/operator#1827 merging to complete the automation.

As a final pass, the values.yaml files will be removed, gitignored, and pulled in dynamically at build-time.

Summary

Two main goals here:

  1. Pull in values.yaml for use with Sphinx Autoyaml so we have a web-based docs to reference here
  2. Update Helm installation procedures overall
  3. Add in upgrade procedure guidance, at least at a high level
  4. Tidy up the network/TLS settings a bit

Out of Scope

A larger treatment of Helm, including creating more subpages and removing some of the overloaded upgrade sections for Operator - that requires some careful rearchitecture I cannot quite wrap my head around right now

Staged

Linux:

K8s:

@ravindk89 ravindk89 self-assigned this Nov 3, 2023
@ravindk89 ravindk89 added the Review Assigned Reviewers Must LGTM To Close label Nov 3, 2023
@ravindk89
Copy link
Collaborator Author

@mjminio I can't add you as a reviewer until you're in the MinIO member org, but I can tag you to take a look!

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
@ravindk89 ravindk89 requested a review from feorlen November 6, 2023 18:06
Copy link
Collaborator

@feorlen feorlen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

@pjuarezd
Copy link
Member

pjuarezd commented Nov 6, 2023

On this sentence

You can specify a path for the MinIO server to search for certificates using the [minio server --certs-dir](http://192.241.195.202:9000/staging/DOCS-1021/linux/reference/minio-server/minio-server.html#minio.server.-certs-dir) or -c parameter.

I am not sure the flag -c works, Tried local and got this

minio server -c /Users/pedro/certs --console-address=":9090" --address=":9000" minio-data
Incorrect Usage: flag provided but not defined: -c

I think the flag is -S?

(sorry for close the PR, fat finger clicked the wrong button)

@pjuarezd pjuarezd closed this Nov 6, 2023
@pjuarezd pjuarezd reopened this Nov 6, 2023
@ravindk89
Copy link
Collaborator Author

ravindk89 commented Nov 6, 2023

On this sentence

You can specify a path for the MinIO server to search for certificates using the [minio server --certs-dir](http://192.241.195.202:9000/staging/DOCS-1021/linux/reference/minio-server/minio-server.html#minio.server.-certs-dir) or -c parameter.

I am not sure the flag -c works, Tried local and got this

minio server -c /Users/pedro/certs --console-address=":9090" --address=":9000" minio-data
Incorrect Usage: flag provided but not defined: -c

(sorry for close the PR, fat finger clicked the wrong button)

Thought I caught all these - it should be -S, not -c.

minio server --help                                                                                               
NAME:
  minio server - start object storage server

...

  --certs-dir value, -S value  path to certs directory (default: "/home/ravindkminio/.minio/certs")

@pjuarezd fixed.

ravindk89 and others added 2 commits November 7, 2023 14:07
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
Co-authored-by: Pedro Juarez <pjuarezd@users.noreply.github.com>
@ravindk89
Copy link
Collaborator Author

@pjuarezd staging updated. Thank you for your review!

@ravindk89 ravindk89 requested a review from pjuarezd November 7, 2023 19:16
@pjuarezd
Copy link
Member

pjuarezd commented Nov 7, 2023

All of this is awesome! It's really going to make the difference with the helm chart users, thank you @ravindk89 @feorlen

@ravindk89
Copy link
Collaborator Author

minio/operator#1827 once this closes I'll complete the work on this.

DO NOT MERGE THIS PR YET!

@ravindk89 ravindk89 merged commit c770ba9 into main Nov 16, 2023
@ravindk89 ravindk89 deleted the DOCS-1021 branch November 16, 2023 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Review Assigned Reviewers Must LGTM To Close
Projects
None yet
3 participants