Implement automation via kyaml setters2 #23
Merged
Conversation
This file contains 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
This is the means for telling the controller to use kyaml setters, per the design in fluxcd/flux2#107 (comment)
This rearranges the test file a little, so that the different strategies can share some setup.
(this test fails, since the implementation is still a stub)
Previously: replace the YNode (yaml.Node) with a new one which is just the replacement string. Now: change the value of the YNode, and set it back in place.
|
@squaremo I can't tell from code, can we use a setter to update tags that are not in the same node as the image? e.g. apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- deployment.yaml
images:
- name: fluxcd/kustomize-controller
newName: fluxcd/kustomize-controller
newTag: v0.1.0 # {"$imagepolicy": "gotk-system:control-plane"} |
That's something in the design I've not implemented yet -- separating out the bits of the latest image, so you can choose the bit you want. It would look something like this: apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- deployment.yaml
images:
- name: fluxcd/kustomize-controller
newName: fluxcd/kustomize-controller
newTag: v0.1.0 # {"$imagepolicy": "gotk-system:control-plane:tag"}(NB the |
Awesome 💯 |
In particular, insert the setter reference into the deployment file.
squaremo
force-pushed
the
use-kyaml-setters2
branch
from
e7e11f5 to
500036f
Compare
This adds another means of updating files to the package pkg/update/, in setters.go (and gives the existing file a better name). In passing, I changed the test util for comparing before/after updates, in pkg/files/, to give a little more context when comparing file contents; and, since the comparison between actual and expected is not symmetrical, I corrected the order of the args in the tests.
(and update the test to suit)
It's difficult to test the files comparison if it contains all its own assertions, since you can only test successes. This commit rewrites the helper to use a func without assertions, that can be more roundly tested.
It will be useful, for kustomizations e.g., to be able to set just the
tag or just the name (repository). This commit adds setters for those
to the schema -- they have the name of the image setter plus a suffix
of `:tag` or `:name`. For example:
newName: ubuntu # {"$imagepolicy": "ns:policy:name"}
newTag: 18.10 # {"$imagepolicy": "ns:policy:tag"}
squaremo
force-pushed
the
use-kyaml-setters2
branch
from
13f8a25 to
76da207
Compare
|
Merging, and making issues for those TODOs ... (done) |
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.
This implements the design given in fluxcd/flux2#107 (comment); briefly, you mark fields in your YAMLs with an image policy name, and the automation sets those fields (wherever they are) to the latest image for the given policy.
This works but needs some polish. It's not obvious, for example, why something doesn't get updated when you think it should. I also need to try it with a few example configs; e.g., with a kustomization, and with a custom resource.
One choice that was forced upon me: I want the markers to have both a namespace and name of the corresponding image policy, to avoid collisions, but
/is unavailable as a separator, since it's used in OpenAPI ref paths (and that's what the marker is, a ref). I've used:, but any character that's not allowed in resource names and isn't/either would do.I've adapted the instructions given in the README for trying this out.
TODO (not necessarily in this PR):
pathsfield from the specgotk