Add `fluxctl install` command #2287

2opremio · 2019-07-23T16:26:06Z

Simlarly to linkerd install, fluxctl install is meant to print out and tweak the Kubernetes manifests needed to install Flux in a cluster.

Its output is intended for piping into other commands such as:

# Install Flux and make it use Git repository git@github.com:<your username>/flux-get-started
fluxctl install --git-url 'git@github.com:<your username>/flux-get-started' | kubectl apply -f -

cmd/fluxctl/setup_cmd.go

hiddeco · 2019-07-24T09:27:00Z

My vote goes to a fluxctl setup which outputs the YAMLs to stdout, based on a released version of our Helm chart. Re-using the Helm chart means we do not have to maintain multiple templates, and a released version because:

The chart and the features it supports are on a different release schedule than fluxd and fluxctl releases. I think it is desirable to keep those on a separate release schedule, as this ensures complete freedom for both elements.
We have been talking about moving chart/ to a dedicated repository, and to split the current chart into a fluxd and Helm operator chart, this would mean you can no longer embed from chart/flux/*.

2opremio · 2019-07-24T09:56:08Z

Alright, will do. How about the command line options? Is that acceptable? I think linkerd does a more sophisticated thing, inspecting and exposing all the available chart options, but I think it's a bit overkill. I would rather keep it simple.

hiddeco · 2019-07-24T10:09:57Z

@2opremio the --extra-flux-args is going to be tricky, as the Helm chart offers an extraArgs key, but also has some defaults / dedicated keys for arguments that are missing in this command.

The Helm operator setting the default and a user supplying the argument here will have the desired effect (as Flux takes the value of the last supplied argument), but will not return a pretty YAML, which is probably a requirement.

squaremo · 2019-07-24T10:15:22Z

Yep, simple for now!

On command-line options: those you have are a good base. You can remove --git-flux-subdir, --timeout, --amend since they don't pertain to generating a config.

Since people can mess around with the output as much as they want, it's not that important to get all the bells and whistles in, or to have an escape for extra args. But looking ahead a bit, I would like to see

--git-committer (or --git-user and --git-email), since that will soon become mandatory
--git-path (as a string slice), since I expect it to be used a lot

as arguments.

squaremo · 2019-07-24T10:28:32Z

Versioning is tricky isn't it.

If you build in whatever's in the files (either the chart or example deployment) at the time of release, that's probably going to have most of the bells and whistles from fluxd in that release -- but it won't correspond to a released chart, which always comes after a fluxd release.

If you include the last released chart, in general it won't have arguments for fluxd in the same release.

If you try to use the latest chart, fluxctl has to understand, for all supported versions -- which will have to include future versions, since see above -- how to encode the arguments it's given into Helm values.

With those points in mind, here's an idea: make the deploy/ examples into very simple text templates, along with all the comments and commented-out bits, and bundle those into the fluxctl binary.

Pros:

will always (barring mistakes) be up-to-date with respect to the released fluxd
the output will retain all the useful comments and optional bits
easier to make it match the exact arguments supported by fluxctl setup

Cons:

a bit proprietary?

2opremio · 2019-07-24T10:49:46Z

With those points in mind, here's an idea: make the deploy/ examples into very simple text templates, along with all the comments and commented-out bits, and bundle those into the fluxctl binary.

How about using Kustomize as a library and use generated-patches to modify the manifests on deploy/* on the fly? This will allow us leave the the manifest files unchanged and save us from maintaining separate templates (or invent an annotation language to maintain the existing templates)

EDIT: this won't preserve comments because Kustomize doesn't support it AFAIK

2opremio · 2019-07-24T10:55:58Z

Or, we can create deploy-templates/ , a Go-templated version of deploy/ for the parameters used by fluxctl setup. We can embed those files in fluxctl and generate deploy/ with the existing values during the build.

squaremo · 2019-07-24T11:03:44Z

How about using Kustomize as a library and use generated-patches to modify the manifests on deploy/* on the fly?

Pros:

not proprietary
serves secondary purpose as an example of how to configure flux using kustomize

Cons:

will wipe out the comments and commented-out sections, so the output won't be self-documenting (but we might be able to recover that just by supplying good examples/docs elsewhere)

squaremo · 2019-07-24T11:09:44Z

Or, we can create deploy-templates/ , a Go-templated version of deploy/

I reckon (either for this or for the kustomize version) just replace it. It doesn't especially serve a purpose other than as a starting point, now -- you can't just apply what's in there, for instance.

2opremio · 2019-07-24T11:10:17Z

serves secondary purpose as an example of how to configure flux using kustomize

My idea was to apply the patches on the fly and print the patches manifests.

2opremio · 2019-07-24T11:11:59Z

It doesn't especially serve a purpose other than as a starting point, now -- you can't just apply what's in there, for instance.

I did that all the time when developing (after tweaking the git repo). Also, the guides rely on it.

squaremo · 2019-07-24T11:13:14Z

I did that all the time when developing (after tweaking the parameters). Also, the guides rely on it.

Right, you had to tweak it, i.e., edit it. You would still be able to do that, especially if it's a kustomize input.

2opremio · 2019-07-24T11:14:06Z

Ah, but you are saying there is no need for that after fluxctl install.

chart/flux/README.md

cmd/fluxctl/install_cmd.go

cmd/fluxctl/install/install.go

stefanprodan

I would undo the changes to the helm chart and restore the deploy dir. If people use Kustomize they will want the YAMLs in git see #2253

Also, fix bin/helm/update_codegen.sh when there is no GOPATH defined

deploy/flux-deployment.yaml

hiddeco

Tidy and clean, thanks Fons 🌷

squaremo · 2019-07-29T08:47:06Z

WIP: Add fluxctl setup

This could have done with a bit of a rebass before merging :-/ Never mind, done now.

now that fluxcd/flux#2287 is merged we can use upstream flux

Now that fluxcd/flux#2287 is merged we can use upstream Flux

* Add `eksctl install flux` command * Bump github/2opremio/flux * Fix typo * Refine missing pod error detection * Avoid commit error when manifests already exist * Fix missing parameter * Address code review: flux -> Flux in CLI args' help * Address code review: clearer call to action w.r.t. Flux SSH key * Use upstream Flux version Now that fluxcd/flux#2287 is merged we can use upstream Flux * gofmt -s -w pkg/ctl/install/install.go * Address code review: use CreateOrUpdate instead of kubectl * Address code review: improve use of RawExtensions and CreateOrUpdate * Address code review: improved output of eksctl help install flux * Address code review: rename import: k8serrors -> apierrors ... in order to follow the same conventions as elsewhere in the codebase. * Address code review: add more context to comments? * Address code review: clearer command description? * Address code review: explain why we return Flux's SSH key * Rename kubernetes.JoinManifest* to ConcatManifest* ... and also change ConcatManifests to become a variadic function, since more flexible to use. * Add utilities to generate Kubernetes Namespace objects (+tests) * Use kubernetes.Manifest{,YAML} utilities to install Flux * Address code review: extract check of existence of namespace + update comments * Address code review: re-read manifests once amended * Create the Flux namespace in the same way as all other resources * Fix rebase: GetCredentials -> RefreshClusterConfig * Add pkg/kubernetes/client.go#RawClient#ClientOrUpdate higher-level method This should hopefully make it easier to leverage RawClient for simpler cases.

2opremio commented Jul 23, 2019

View reviewed changes

cmd/fluxctl/setup_cmd.go Outdated Show resolved Hide resolved

2opremio force-pushed the fluxctl-setup branch 2 times, most recently from 568ba2f to 09c421b Compare July 24, 2019 12:19

squaremo reviewed Jul 24, 2019

View reviewed changes

chart/flux/README.md Outdated Show resolved Hide resolved

squaremo reviewed Jul 24, 2019

View reviewed changes

cmd/fluxctl/install_cmd.go Outdated Show resolved Hide resolved

squaremo reviewed Jul 24, 2019

View reviewed changes

cmd/fluxctl/install_cmd.go Outdated Show resolved Hide resolved

2opremio changed the title ~~[WIP] Add fluxctl setup command~~ Add fluxctl install command Jul 24, 2019

2opremio marked this pull request as ready for review July 24, 2019 15:31

2opremio requested review from hiddeco and stefanprodan July 24, 2019 15:32

2opremio force-pushed the fluxctl-setup branch from 071cbb0 to f2d0be3 Compare July 24, 2019 15:40

squaremo reviewed Jul 24, 2019

View reviewed changes

cmd/fluxctl/install/install.go Outdated Show resolved Hide resolved

stefanprodan reviewed Jul 25, 2019

View reviewed changes

2opremio force-pushed the fluxctl-setup branch 4 times, most recently from d3922e0 to c312d79 Compare July 25, 2019 14:30

2opremio mentioned this pull request Jul 26, 2019

Add eksctl install flux command eksctl-io/eksctl#1064

Merged

6 tasks

2opremio added 8 commits July 27, 2019 11:32

Move cmd/fluxctl/install to install/

5cd4970

Generate deploy/ automatically

027bcce

Make --git-email mandatory

89dc5b8

Stop exposing additional args through fluxctl install

3bd89a4

Forgot to return errors :S

e849e7f

Rename FillInInstallTemplates to FillInTemplates

07f68cd

Fix check-generated by refreshing the generated templates

179c2c6

Also, fix bin/helm/update_codegen.sh when there is no GOPATH defined

Fix tests

b4f34c8

2opremio force-pushed the fluxctl-setup branch from 26e5f01 to b4f34c8 Compare July 27, 2019 09:33

2opremio mentioned this pull request Jul 27, 2019

fluxctl install in the guides and new annotation docs #2298

Merged

2opremio commented Jul 27, 2019

View reviewed changes

deploy/flux-deployment.yaml Outdated Show resolved Hide resolved

2opremio force-pushed the fluxctl-setup branch 3 times, most recently from 8a55252 to 909b9b0 Compare July 27, 2019 10:13

Update templates

878307d

2opremio force-pushed the fluxctl-setup branch from 909b9b0 to 878307d Compare July 27, 2019 10:13

hiddeco approved these changes Jul 29, 2019

View reviewed changes

2opremio merged commit 077060e into fluxcd:master Jul 29, 2019

2opremio deleted the fluxctl-setup branch July 29, 2019 08:44

2opremio added a commit to eksctl-io/eksctl that referenced this pull request Jul 29, 2019

Stop replacling Flux

e70e28f

now that fluxcd/flux#2287 is merged we can use upstream flux

marccarre pushed a commit to eksctl-io/eksctl that referenced this pull request Jul 30, 2019

Use upstream Flux version

f00dfc2

Now that fluxcd/flux#2287 is merged we can use upstream Flux

marccarre pushed a commit to eksctl-io/eksctl that referenced this pull request Jul 31, 2019

Use upstream Flux version

7a75f0a

Now that fluxcd/flux#2287 is merged we can use upstream Flux

squaremo added this to the 1.14.0 milestone Aug 6, 2019

2opremio mentioned this pull request Aug 6, 2019

Add manifest-generating API for installation fluxcd/helm-operator#2

Merged

marccarre mentioned this pull request Aug 16, 2019

Add generation of cluster autoscaler addon's manifest eksctl-io/eksctl#1131

Closed

5 tasks

2opremio mentioned this pull request Oct 25, 2019

Add 'fluxctl install' e2e smoke test #2552

Merged

2opremio added the helm-chart label Nov 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `fluxctl install` command #2287

Add `fluxctl install` command #2287

2opremio commented Jul 23, 2019 •

edited

Loading

hiddeco commented Jul 24, 2019

2opremio commented Jul 24, 2019

hiddeco commented Jul 24, 2019

squaremo commented Jul 24, 2019

squaremo commented Jul 24, 2019

2opremio commented Jul 24, 2019 •

edited

Loading

2opremio commented Jul 24, 2019

squaremo commented Jul 24, 2019 •

edited

Loading

squaremo commented Jul 24, 2019

2opremio commented Jul 24, 2019

2opremio commented Jul 24, 2019 •

edited

Loading

squaremo commented Jul 24, 2019 •

edited

Loading

2opremio commented Jul 24, 2019

stefanprodan left a comment •

edited

Loading

hiddeco left a comment

squaremo commented Jul 29, 2019

Add fluxctl install command #2287

Add fluxctl install command #2287

Conversation

2opremio commented Jul 23, 2019 • edited Loading

hiddeco commented Jul 24, 2019

2opremio commented Jul 24, 2019

hiddeco commented Jul 24, 2019

squaremo commented Jul 24, 2019

squaremo commented Jul 24, 2019

2opremio commented Jul 24, 2019 • edited Loading

2opremio commented Jul 24, 2019

squaremo commented Jul 24, 2019 • edited Loading

squaremo commented Jul 24, 2019

2opremio commented Jul 24, 2019

2opremio commented Jul 24, 2019 • edited Loading

squaremo commented Jul 24, 2019 • edited Loading

2opremio commented Jul 24, 2019

stefanprodan left a comment • edited Loading

Choose a reason for hiding this comment

hiddeco left a comment

Choose a reason for hiding this comment

squaremo commented Jul 29, 2019

Add `fluxctl install` command #2287

Add `fluxctl install` command #2287

2opremio commented Jul 23, 2019 •

edited

Loading

2opremio commented Jul 24, 2019 •

edited

Loading

squaremo commented Jul 24, 2019 •

edited

Loading

2opremio commented Jul 24, 2019 •

edited

Loading

squaremo commented Jul 24, 2019 •

edited

Loading

stefanprodan left a comment •

edited

Loading