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.

Sign up for GitHub

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

Jump to bottom

Use PATCH to update ready annotation #3494

Merged
merged 1 commit into from
Nov 6, 2020
Merged

Use PATCH to update ready annotation #3494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 24 additions & 17 deletions pkg/pod/entrypoint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,19 @@ package pod

import (
"context"
"encoding/json"
"errors"
"fmt"
"log"
"path/filepath"
"strings"

"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"gomodules.xyz/jsonpatch/v2"
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/kubernetes"
)

Expand Down Expand Up @@ -166,26 +170,29 @@ func collectResultsName(results []v1beta1.TaskResult) string {
return strings.Join(resultNames, ",")
}

// UpdateReady updates the Pod's annotations to signal the first step to start
// by projecting the ready annotation via the Downward API.
func UpdateReady(ctx context.Context, kubeclient kubernetes.Interface, pod corev1.Pod) error {
newPod, err := kubeclient.CoreV1().Pods(pod.Namespace).Get(ctx, pod.Name, metav1.GetOptions{})
var replaceReadyPatchBytes []byte

func init() {
// https://stackoverflow.com/questions/55573724/create-a-patch-to-add-a-kubernetes-annotation
readyAnnotationPath := "/metadata/annotations/" + strings.Replace(readyAnnotation, "/", "~1", 1)
Copy link
Member

@pritidesai pritidesai Nov 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replacing forward slash in "tekton.dev/ready" with ~1: "tekton.dev~1ready" 😱 yup saw the linked RFC

var err error
replaceReadyPatchBytes, err = json.Marshal([]jsonpatch.JsonPatchOperation{{
Operation: "replace",
Path: readyAnnotationPath,
Value: readyAnnotationValue,
}})
if err != nil {
return fmt.Errorf("error getting Pod %q when updating ready annotation: %w", pod.Name, err)
log.Fatalf("failed to marshal replace ready patch bytes: %v", err)
}
}

// Update the Pod's "READY" annotation to signal the first step to
// start.
if newPod.ObjectMeta.Annotations == nil {
newPod.ObjectMeta.Annotations = map[string]string{}
}
if newPod.ObjectMeta.Annotations[readyAnnotation] != readyAnnotationValue {
newPod.ObjectMeta.Annotations[readyAnnotation] = readyAnnotationValue
if _, err := kubeclient.CoreV1().Pods(newPod.Namespace).Update(ctx, newPod, metav1.UpdateOptions{}); err != nil {
return fmt.Errorf("error adding ready annotation to Pod %q: %w", pod.Name, err)
}
}
return nil
// UpdateReady updates the Pod's annotations to signal the first step to start
// by projecting the ready annotation via the Downward API.
func UpdateReady(ctx context.Context, kubeclient kubernetes.Interface, pod corev1.Pod) error {
// PATCH the Pod's annotations to replace the ready annotation with the
// "READY" value, to signal the first step to start.
_, err := kubeclient.CoreV1().Pods(pod.Namespace).Patch(ctx, pod.Name, types.JSONPatchType, replaceReadyPatchBytes, metav1.PatchOptions{})
return err
}

// StopSidecars updates sidecar containers in the Pod to a nop image, which
Expand Down
30 changes: 23 additions & 7 deletions pkg/pod/entrypoint_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,24 +263,38 @@ func TestUpdateReady(t *testing.T) {
desc string
pod corev1.Pod
wantAnnotations map[string]string
wantErr bool
}{{
desc: "Pod without any annotations has it added",
desc: "Pod without any annotations fails",
pod: corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Annotations: nil,
},
},
wantErr: true, // Nothing to replace.
}, {
desc: "Pod without ready annotation adds it",
pod: corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Annotations: map[string]string{
"something": "else",
},
},
},
wantAnnotations: map[string]string{
readyAnnotation: readyAnnotationValue,
"something": "else",
readyAnnotation: "READY",
},
}, {
desc: "Pod with existing annotations has it appended",
desc: "Pod with empty annotation value has it replaced",
pod: corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Annotations: map[string]string{
"something": "else",
"something": "else",
readyAnnotation: "",
},
},
},
Expand All @@ -289,16 +303,18 @@ func TestUpdateReady(t *testing.T) {
readyAnnotation: readyAnnotationValue,
},
}, {
desc: "Pod with other annotation value has it updated",
desc: "Pod with other annotation value has it replaced",
pod: corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Annotations: map[string]string{
"something": "else",
readyAnnotation: "something else",
},
},
},
wantAnnotations: map[string]string{
"something": "else",
readyAnnotation: readyAnnotationValue,
},
}} {
Expand All @@ -307,8 +323,8 @@ func TestUpdateReady(t *testing.T) {
ctx, cancel := context.WithCancel(ctx)
defer cancel()
kubeclient := fakek8s.NewSimpleClientset(&c.pod)
if err := UpdateReady(ctx, kubeclient, c.pod); err != nil {
t.Errorf("UpdateReady: %v", err)
if err := UpdateReady(ctx, kubeclient, c.pod); (err != nil) != c.wantErr {
t.Errorf("UpdateReady (wantErr=%t): %v", c.wantErr, err)
}

got, err := kubeclient.CoreV1().Pods(c.pod.Namespace).Get(ctx, c.pod.Name, metav1.GetOptions{})
Expand Down