feat(k8s): add support for patching manifests #5187
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
eysi09
force-pushed
the
k8s-patch-resources
branch
7 times, most recently
from
888cfdc
to
c90e4f3
Compare
eysi09
commented
Oct 5, 2023
| export interface KubernetesPatchResource { | ||
| name: string | ||
| // TODO @eysi: Can we get a better type here? | ||
| kind: string |
There was a problem hiding this comment.
I just went for a string type here instead of listing all K8s object types.
There was a problem hiding this comment.
I think that makes sense because a user could also patch a custom resource.
eysi09
force-pushed
the
k8s-patch-resources
branch
from
c90e4f3
to
b4f1464
Compare
eysi09
changed the title
eysi09
force-pushed
the
k8s-patch-resources
branch
4 times, most recently
from
e6eac87
to
1938ed8
Compare
This change introduces a \`patchResources\` field to the \`kubernetes\` Deploy action that allows users to overwrite the values of manifests in Garden config without modifying the manifest itself. This enables users to drop Garden into existing K8s projects without making any other changes to code or config. Under the hood, Garden uses the `kubectl patch` command. The behaviour is documented here: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
eysi09
force-pushed
the
k8s-patch-resources
branch
from
1938ed8
to
c185074
Compare
twelvemo
previously approved these changes
Oct 6, 2023
| export interface KubernetesPatchResource { | ||
| name: string | ||
| // TODO @eysi: Can we get a better type here? | ||
| kind: string |
There was a problem hiding this comment.
I think that makes sense because a user could also patch a custom resource.
twelvemo
previously approved these changes
Oct 6, 2023
Co-authored-by: Anna Mager <78752267+twelvemo@users.noreply.github.com>
eysi09
force-pushed
the
k8s-patch-resources
branch
from
d67ea23
to
32955f2
Compare
twelvemo
approved these changes
Oct 6, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
What this PR does / why we need it:
From the commit message:
I also added an example project that demonstrates this functionality and updated the k8s-deploy-config-templates example to use the same pattern.
To do:
Update docs on Kubernetes action types (we can do that in a follow up PR if needed)I started writing the docs on a different branch to keep things simple.
Which issue(s) this PR fixes:
Fixes #5082
Special notes for your reviewer:
The large number of line changes is due to the example projects. The main feature is pretty simple.