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

Add Helm use case intro page #1255

Merged
merged 3 commits into from
Apr 22, 2021
Merged

Add Helm use case intro page #1255

merged 3 commits into from
Apr 22, 2021

Conversation

scottrigby
Copy link
Member

What is the simplest way to explain how Flux works with Helm to existing Helm users?

There's a lot more we can say, but is there anything critical we think should go into an intro that I'm missing?

See fluxcd/website#120

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

@scottrigby I think we could add a section on secrets management and explain how valuesFrom work with secrets decrypted by kustomize-controller. Another thing that's missing from here is the automated upgrade feature (semver range) and automated rollback.

docs/use-cases/helm.md Outdated Show resolved Hide resolved
@dholbach dholbach added the area/docs Documentation related issues and pull requests label Apr 13, 2021
@scottrigby
Copy link
Member Author

@scottrigby I think we could add a section on secrets management and explain how valuesFrom work with secrets decrypted by kustomize-controller

Should I just summarize and link to the existing doc pages on that?

@stefanprodan
Copy link
Member

Should I just summarize and link to the existing doc pages on that?

Yes, for each topic we need to explain what's the GitOps way of doing it and why it's useful, then link to each doc.

a note on how these refs changed from Flux 1 -> 2

This doc is about v2, I would not mention v1 at all.

@scottrigby
Copy link
Member Author

Another thing that's missing from here is the automated upgrade feature (semver range) and automated rollback.

While there's a note about the feature here https://toolkit.fluxcd.io/components/helm/controller/, and the API pages have details, the best description for this is currently in the Helm Operator -> Controller migration doc https://toolkit.fluxcd.io/guides/helm-operator-migration/#defining-a-rollback-uninstall-configuration and https://toolkit.fluxcd.io/guides/helm-operator-migration/#automated-rollbacks.

Perhaps the bulk of this should be moved to the helm use case intro page, and that section could be linked to from the operator->controller migration page instead of the info living there.

@stefanprodan
Copy link
Member

Perhaps the bulk of this should be moved to the helm use case intro page, and that section could be linked to from the operator->controller migration page instead of the info living there.

Let’s copy and adapt the rollback info in this doc. I want to avoid sending people from the migration guide to other places. The audience for this document is very different to the migration one, so duplicating some info is fine.

@scottrigby
Copy link
Member Author

scottrigby commented Apr 19, 2021

@stefanprodan WDYT? Trying to cover bases with simple examples, while duplicating as little as possible from other areas of the docs. I did follow your suggestion about copying adapt and rollback.

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks @scottrigby 🏅

@stefanprodan stefanprodan added the area/helm Helm related issues and pull requests label Apr 21, 2021
scottrigby and others added 3 commits April 22, 2021 14:19
Signed-off-by: Scott Rigby <scott@r6by.com>
Signed-off-by: Scott Rigby <scott@r6by.com>

Co-authored-by: Stefan Prodan <stefan.prodan@gmail.com>
…e plus SOPS, semver range policies, and auto uninstalls and rollbacks

Signed-off-by: Scott Rigby <scott@r6by.com>
Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

This is awesome, thank you very much @scottrigby 💯 🥇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests area/helm Helm related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants