Repository navigation
docs: finish the README: install next to Flux, Flux 2.6 minimum, Argo CD tracking - #22
Open
ilya-lesikov wants to merge 3 commits into
Open
ilya-lesikov wants to merge 3 commits into
ilya-lesikov wants to merge 3 commits into
Conversation
… tracking Signed-off-by: Ilya Lesikov <ilya@lesikov.com>
Signed-off-by: Ilya Lesikov <ilya@lesikov.com>
Signed-off-by: Ilya Lesikov <ilya@lesikov.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Finish the README so a new user can install and use nelm-operator, including how to install it next to an existing Flux, the minimum Flux version, and safe Argo CD resource tracking.
What
OCIRepositorythroughsource.toolkit.fluxcd.io/v1, which Flux added in 2.6.installFluxSourceController=true, explaining what happens otherwise: a second controller reconciles the same objects, and Nelm applies the chart's Flux CRDs over the existing ones. It also gives a command to check the Flux version.allow-egressNetworkPolicy blocks artifact downloads from other namespaces. This section adds a NetworkPolicy that lets the operator's namespace in.--server-side --force-conflictsfor theReleaseCRD and for the bundled Flux CRDs.app.kubernetes.io/instanceconflict under label tracking. The safe options are annotation tracking or a separateapplication.instanceLabelKey, followed by a re-sync.ApplyOutOfSyncOnlyneeds special handling.maxConcurrentReconciles,defaultServiceAccount) and notes that the charts do not expose other flags. Also notes that the watches stay on Flux's v1 API whatever--source-api-*says.kubectl get releaseexample,kubectl explain release.spec, and whatmake test-e2eactually does.Why
The old README covered neither the Flux coexistence risks, the Flux version floor, nor Argo CD, and it missed the NetworkPolicy needed next to a default Flux install.
Verified on a throwaway kind cluster:
allow-egresspolicy, plus thenelm-controllerchart. Artifact downloads were blocked until the README's NetworkPolicy was applied verbatim, after which the podinfo Release became Ready.