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

add tutorial which discusses automation, annotations, locks #1675

Merged
merged 4 commits into from
Jan 21, 2019

Conversation

dholbach
Copy link
Member

Closes: #1309

This tutorial aims to show step-by-step to set up Flux and drive it by using locks, annotations and automation. The idea was to keep it simple but have a practical example to look at with clear instructions and clear outcomes.

Feedback is very welcome. Let me know if I missed anything.

We also have instructions for doing the same with Helm, I'm just not sure how to best implement it. Maybe offer 'alternate' setup steps?

	closes: #1309

Signed-off-by: Daniel Holbach <daniel@weave.works>
@dholbach dholbach added the docs Issue or PR relates to documentation label Jan 18, 2019
@dholbach dholbach self-assigned this Jan 18, 2019
Signed-off-by: Daniel Holbach <daniel@weave.works>
@stefanprodan
Copy link
Member

Installing operators in the default namespace is bad practice in my opinion.

After each fluxctl command I would put a snippet with the annotations it created and I would mention that you don't need fluxctl for all those operations, doing the changes in Git works the same.

@dholbach
Copy link
Member Author

Installing operators in the default namespace is bad practice in my opinion.

Mh, ok. I take your point. It's just a bit clunky to have to type --k8s-fwd-ns for every single time you call fluxctl.

After each fluxctl command I would put a snippet with the annotations it created and I would mention that you don't need fluxctl for all those operations, doing the changes in Git works the same.

Will do. Good idea.

@dholbach dholbach changed the title add tutorial which discusses automation, annotations, locks WIP: add tutorial which discusses automation, annotations, locks Jan 18, 2019
@dholbach
Copy link
Member Author

Installing operators in the default namespace is bad practice in my opinion.

Mh, ok. I take your point. It's just a bit clunky to have to type --k8s-fwd-ns for every single time you call fluxctl.

For this I'd either need to

  1. add a step in which the non-Helm setup changes flux-account.yaml (then both sections can use --k8s-fwd-ns in every step) - which I still feel is a bit clunky.
  2. differ in the post-setup steps of the two types of install

I'd obviously prefer to go with 1).

Another option would be to go with default on this one. And then in a separate issue discuss where we want the example deploy to go and if fluxctl can automatically use that namespace. WDYT?

@dholbach dholbach changed the title WIP: add tutorial which discusses automation, annotations, locks add tutorial which discusses automation, annotations, locks Jan 21, 2019
@stefanprodan
Copy link
Member

stefanprodan commented Jan 21, 2019

@dholbach you could mention that for simplifying the demo we use the default namespace but outside testing one should deploy Flux in its own namespace, and that fluxctl has a k8s-fwd-ns.

@dholbach
Copy link
Member Author

Sounds good!

@dholbach dholbach merged commit 7edcb64 into master Jan 21, 2019
@dholbach dholbach deleted the annotations-tutorial branch January 21, 2019 11:34
@2opremio
Copy link
Contributor

2opremio commented Jan 21, 2019

Maybe, it would be nice to have a config file and contexts like kubectl.

This would allow for specifying an implicit namespace, so that you don't need to do it in the command line.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Issue or PR relates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants