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

README confusion #19

Closed
jpds opened this issue Mar 23, 2024 · 6 comments · Fixed by #26
Closed

README confusion #19

jpds opened this issue Mar 23, 2024 · 6 comments · Fixed by #26

Comments

@jpds
Copy link
Contributor

jpds commented Mar 23, 2024

The README is confusing in that it says push and then immediately pull:

comin - Git Push NixOS Machines
comin is a deployment tool working in the pull mode.

The title should probably be changed to "GitOps for NixOS Machines":

@nlewo
Copy link
Owner

nlewo commented Mar 23, 2024

Yes, i agree this doesn't look nice :/ Thank you for this review: I need to find a better wording.

I'm actually not sure comin is GitOps, since when there is a manual change on the infra, comin doesn't detect it and doesn't reconcile it. (That's why it didn't want to use this term.)

However, comin could be close enough to GitOps to be referred as "GitOps".

Also, it would not be hard to make comin watching the deployed NixOS configuration to reconcile it in case of a manual switch. I'm however not sure it would be useful in practice, excepting to be able to claim comin is GitOps ;)

@jpds
Copy link
Contributor Author

jpds commented Mar 24, 2024

since when there is a manual change on the infra, comin doesn't detect it and doesn't reconcile it

What do you mean by "reconcile" ? https://fluxcd.io/ is the original GitOps tool and if you make a manual change to the infra - it simply looks at what's in Git and overrides the manual change made (enforcing that the Single Source of Truth is what's in the Git repo).

@nlewo
Copy link
Owner

nlewo commented Mar 24, 2024

What do you mean by "reconcile"

I mean resolving divergences between the state of the infra and the configuration. As you say, flux overrides manual changes: this is not something comin is able to do. So i considered comin doesn't have all properties of a GitOps tool.

nlewo added a commit that referenced this issue Apr 8, 2024
@nlewo nlewo mentioned this issue Apr 8, 2024
nlewo added a commit that referenced this issue Apr 9, 2024
@nlewo nlewo closed this as completed in #26 Apr 9, 2024
@nlewo
Copy link
Owner

nlewo commented Apr 9, 2024

Thank you for raising this issue: I finally updated the readme as you suggested.

@jpds
Copy link
Contributor Author

jpds commented Apr 10, 2024

flux overrides manual changes: this is not something comin is able to do

Right, the reason I asked the "reconcile" clarification was that I assumed the nixos-rebuild stage would perform this override stage.

Looks great now!

@maxkokocom
Copy link

Early flux and gitops in Kubernetes also struggled with proper reconciliation of which resources were created by whom, so I would not be afraid to use language such as "reconcile" at such an early project stage as it provides philosophical goals when technical decisions are yet to come.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants