Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Exclude Helm manifests in get-started guide #1902

Merged
merged 1 commit into from
Apr 9, 2019

Conversation

2opremio
Copy link
Contributor

@2opremio 2opremio commented Apr 4, 2019

The get started guide uses repo github.com/weaveworks/flux-get-started
which contains HelmRelease manifests, but the guide didn't instruct
the reader to deploy the Helm operator.

Fixes #1898

@hiddeco
Copy link
Member

hiddeco commented Apr 4, 2019

I think we should make it more clear to the user that installation of the Helm operator is optional (and only required because the flux-get-started repository makes use of it).

If the user now follows these steps, but for example, has not installed Tiller on the cluster (because we did not tell them to), the apply of the HelmRelease will succeed but the roll-out of the release itself will fail (and the operator will only be logging errors).

@2opremio
Copy link
Contributor Author

2opremio commented Apr 4, 2019

That's true. Then, we either change the example repository to one without HelmReleases or we add instructions to install Tiller and indicate that helm is optional. Thoughts?

@2opremio
Copy link
Contributor Author

2opremio commented Apr 4, 2019

BTW, how could the guide have possiblly ever worked? I'll do some digging

@hiddeco
Copy link
Member

hiddeco commented Apr 4, 2019

From the git log in my head; there was a commit a while ago that just changed the repository URLs without matching the content.


Head was right: #1527

@hiddeco
Copy link
Member

hiddeco commented Apr 4, 2019

Then, we either change the example repository to one without HelmReleases or we add instructions to install Tiller and indicate that helm is optional.

I think the latter would be good, with a note saying that for demo purposes we install the operator too (and thus Tiller must be installed) but it is fine to only make use of the Flux daemon.

@dholbach
Copy link
Member

dholbach commented Apr 5, 2019

Hum. Maybe I'm missing something, but AFAICS the get started tutorial is about "flux standalone" (cf this note), whereas the helm get started tutorial is about helm: the need to install Tiller is discussed there.

@hiddeco
Copy link
Member

hiddeco commented Apr 5, 2019

AFAICS the get started tutorial is about "flux standalone"

Correct, the problem is that the repository linked in this doc (and used as an example) contains HelmRelease resources, confusing users (see linked issue).

@2opremio
Copy link
Contributor Author

2opremio commented Apr 5, 2019 via email

@dholbach
Copy link
Member

dholbach commented Apr 5, 2019

This is unfortunate. It'd be great if we could

  1. maintain just one example
  2. have a straight-forward example with clear instructions that you can easily tailor to your use-cases

It looks like we can't easily have it all this time.

My inclination would be to merge this PR, but make a note that we at least document why this is necessary in the future, and even better: make the use of the example repo here more "obvious"?

@2opremio
Copy link
Contributor Author

2opremio commented Apr 5, 2019

It looks like we can't easily have it all this time.

We can also restrict the repo to directories not including HelmReleases by configuring the flux deployment. I think I will do that.

@2opremio 2opremio changed the title Deploy helm operator in get-started guide Exclude Helm manifests in get-started guide Apr 5, 2019
@2opremio
Copy link
Contributor Author

2opremio commented Apr 5, 2019

@hiddeco @dholbach PTAL

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.

I think we got ourselves a winner 💯

@dholbach
Copy link
Member

dholbach commented Apr 5, 2019

Thanks for the fix - this looks clean. (Even if it adds another step to the "get started" experience - I guess I'll file a separate issue about this.)

Have you tried this locally? In my case the new podinfo gets deployed, but for some reason the color does not change.

@2opremio
Copy link
Contributor Author

2opremio commented Apr 5, 2019

In my case the new podinfo gets deployed, but for some reason the color does not change.

It does work for me. Do the logs show anything odd?

I don't see why any of the changes I made would cause flux not to update the deployment correctly.

@dholbach
Copy link
Member

dholbach commented Apr 5, 2019

Just started with a fresh minikube, same thing. The correct revision is deployed. Colour stays green.

@2opremio
Copy link
Contributor Author

2opremio commented Apr 8, 2019

I will take a deeper look. However I doubt that's caused by this PR. Does it work when deploying helm and the helm op?

@dholbach
Copy link
Member

dholbach commented Apr 8, 2019

The tutorials follow different paths:

  • standalone get started asks people to change PODINFO_UI_COLOR to blue in workloads/podinfo-dep.yaml - this seems not to work in either of the variants.
  • helm get started asks people to update the image rev of mongodb, this works.

@dholbach
Copy link
Member

dholbach commented Apr 8, 2019

Maybe we can just copy https://github.com/weaveworks/flux/blame/master/site/helm-get-started.md#L147 (147 and following) over to get-started.md?

@dholbach
Copy link
Member

dholbach commented Apr 8, 2019

/cc @stefanprodan on the above

@hiddeco
Copy link
Member

hiddeco commented Apr 8, 2019

I think the podinfo application no longer listens to the PODINFO_UI_COLOR environment variable (https://github.com/stefanprodan/k8s-podinfo/search?q=PODINFO_UI_COLOR&unscoped_q=PODINFO_UI_COLOR).

Or on a second thought, it should. https://github.com/stefanprodan/k8s-podinfo/blob/7d5200a78a6206c69e761be4c8791afe9427895d/cmd/podinfo/main.go#L33

@2opremio
Copy link
Contributor Author

2opremio commented Apr 8, 2019

Can me merge this and create a separate issue for the color?

@2opremio
Copy link
Contributor Author

2opremio commented Apr 8, 2019

It does work for me.

I retried and it didn't, I would had sworn it did. ¯_(ツ)_/¯

Sorry @dholbach

@dholbach
Copy link
Member

dholbach commented Apr 8, 2019

Let's copy over the Helm Get Started bits into the other tutorial in a separate issues.

@squaremo
Copy link
Member

squaremo commented Apr 9, 2019

Is this ready to merge or is it blocked on something -- I'm not clear after reading the comments 😅

@dholbach
Copy link
Member

dholbach commented Apr 9, 2019

Yes, let's do it, and fix the second part of it in a separate PR.

@2opremio 2opremio merged commit d11f2d8 into fluxcd:master Apr 9, 2019
@2opremio 2opremio deleted the helm-op-get-started branch April 9, 2019 12:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants