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

[Feature] Add Karpenter Do Not Disrupt policy for Karpenter 1.x migration #1209

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
apiVersion: chainsaw.kyverno.io/v1alpha1
kind: Test
metadata:
name: add-karpenter-donot-disrupt
spec:
steps:
- name: step-01
try:
- apply:
file: ../add-karpenter-donot-disrupt.yaml
- assert:
file: policy-ready.yaml
- name: step-02
try:
- apply:
file: ../.kyverno-test/resource.yaml
- apply:
file: resource-others.yaml
- name: step-03
try:
- assert:
file: ../.kyverno-test/patched01.yaml
- assert:
file: ../.kyverno-test/patched02.yaml
- assert:
file: patched03.yaml
- assert:
file: patched04.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-1
labels:
karpenter.sh/do-not-evict: "true"
karpenter.sh/do-not-disrupt: "true"
spec:
containers:
- name: nginx
image: nginx:1.14.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-2
labels:
karpenter.sh/do-not-evict: "false"
spec:
containers:
- name: nginx
image: nginx:1.14.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiVersion: kyverno.io/v1
kind: ClusterPolicy
metadata:
name: add-karpenter-donot-disrupt
status:
conditions:
- reason: Succeeded
status: "True"
type: Ready
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-1
labels:
karpenter.sh/do-not-evict: "true"
spec:
containers:
- name: nginx
image: nginx:1.14.2
---
apiVersion: v1
kind: Pod
metadata:
name: test-pod-2
labels:
karpenter.sh/do-not-evict: "false"
spec:
containers:
- name: nginx
image: nginx:1.14.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: cli.kyverno.io/v1alpha1
kind: Test
metadata:
name: add-karpenter-donot-disrupt
policies:
- ../add-karpenter-donot-disrupt.yaml
resources:
- resource.yaml
results:
- kind: Pod
patchedResource: patched01.yaml
policy: add-karpenter-donot-disrupt
resources:
- test-pod-with-evict
result: pass
rule: add-donot-disrupt-label
- kind: Pod
patchedResource: patched02.yaml
policy: add-karpenter-donot-disrupt
resources:
- test-pod-without-evict
result: skip
rule: add-donot-disrupt-label
11 changes: 11 additions & 0 deletions karpenter/add-karpenter-donot-disrupt/.kyverno-test/patched01.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-with-evict
labels:
karpenter.sh/do-not-evict: "true"
karpenter.sh/do-not-disrupt: "true"
spec:
containers:
- name: nginx
image: nginx:1.14.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-without-evict
spec:
containers:
- name: nginx
image: nginx:1.14.2
19 changes: 19 additions & 0 deletions karpenter/add-karpenter-donot-disrupt/.kyverno-test/resource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod-with-evict
labels:
karpenter.sh/do-not-evict: "true"
spec:
containers:
- name: nginx
image: nginx:1.14.2
---
apiVersion: v1
kind: Pod
metadata:
name: test-pod-without-evict
spec:
containers:
- name: nginx
image: nginx:1.14.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
apiVersion: kyverno.io/v1
kind: ClusterPolicy
metadata:
name: add-karpenter-donot-disrupt
annotations:
policies.kyverno.io/title: Add Karpenter Do Not Disrupt
policies.kyverno.io/category: Karpenter, EKS Best Practices
policies.kyverno.io/severity: medium
policies.kyverno.io/subject: Pod
kyverno.io/kyverno-version: 1.7.1
policies.kyverno.io/minversion: 1.6.0
kyverno.io/kubernetes-version: "1.23"
policies.kyverno.io/description: >-
This policy assists in migrating from Karpenter 0.x to 1.x by adding the
karpenter.sh/do-not-disrupt label to pods that have the deprecated
karpenter.sh/do-not-evict label. This ensures smooth upgrades and
maintains the intended protection against pod disruption.
spec:
rules:
- name: add-donot-disrupt-label
match:
resources:
kinds:
- Pod
realshuting marked this conversation as resolved.
Show resolved Hide resolved
preconditions:
all:
- key: '{{ request.object.metadata.labels."karpenter.sh/do-not-evict" || '''' }}'
operator: NotEquals
value: ""
realshuting marked this conversation as resolved.
Show resolved Hide resolved
mutate:
patchStrategicMerge:
metadata:
labels:
karpenter.sh/do-not-disrupt: "true"
33 changes: 33 additions & 0 deletions karpenter/add-karpenter-donot-disrupt/artifacthub-pkg.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: add-karpenter-donot-disrupt
version: 1.0.0
displayName: Add Karpenter Do Not Disrupt Label
createdAt: "2024-12-17T00:00:00Z"
description: |
This policy assists in migrating from Karpenter 0.x to 1.x by adding the
karpenter.sh/do-not-disrupt label to pods that have the deprecated
karpenter.sh/do-not-evict label. This ensures smooth upgrades and
maintains the intended protection against pod disruption during Karpenter
node termination.
install: |
```sh
kubectl apply -f https://raw.githubusercontent.com/kyverno/policies/main/karpenter/add-karpenter-donot-disrupt/add-karpenter-donot-disrupt.yaml
```
keywords:
- kyverno
- karpenter
readme: |
# Add Karpenter Do Not Disrupt Label

This policy facilitates the migration from Karpenter 0.x to 1.x by automatically
adding the new karpenter.sh/do-not-disrupt label to pods that use the deprecated
karpenter.sh/do-not-evict label.

When a pod is created with the old karpenter.sh/do-not-evict label, this policy
automatically adds the new karpenter.sh/do-not-disrupt label to ensure the pod
remains protected during node termination operations in Karpenter 1.x.

Reference for this change: https://karpenter.sh/v1.0/upgrading/v1beta1-migration/
annotations:
kyverno.io/category: Pod
kyverno.io/kubernetes-version: "1.23"
kyverno.io/subject: "Pod, Migration"
Loading