Skip to content
Draft
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
58 changes: 58 additions & 0 deletions utils/k8sutil/defaults.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
package k8sutil

import (
"strings"

corev1 "k8s.io/api/core/v1"
)

// DefaultPodTemplate applies the subset of Kubernetes PodTemplate defaulting needed by
// library callers, without importing k8s.io/kubernetes.
func DefaultPodTemplate(template *corev1.PodTemplateSpec) {
defaultPodSpec(&template.Spec)
for i := range template.Spec.InitContainers {
defaultContainer(&template.Spec.InitContainers[i])
}
for i := range template.Spec.Containers {
defaultContainer(&template.Spec.Containers[i])
}
for i := range template.Spec.EphemeralContainers {
defaultContainer((*corev1.Container)(&template.Spec.EphemeralContainers[i].EphemeralContainerCommon))
}
}

// defaultPodSpec and defaultContainer are adapted from k8s.io/kubernetes/pkg/apis/core/v1/defaults.go.
func defaultPodSpec(spec *corev1.PodSpec) {
if spec.DNSPolicy == "" {
spec.DNSPolicy = corev1.DNSClusterFirst
}
if spec.RestartPolicy == "" {
spec.RestartPolicy = corev1.RestartPolicyAlways
}
if spec.SecurityContext == nil {
spec.SecurityContext = &corev1.PodSecurityContext{}
}
if spec.TerminationGracePeriodSeconds == nil {
period := int64(corev1.DefaultTerminationGracePeriodSeconds)
spec.TerminationGracePeriodSeconds = &period
}
if spec.SchedulerName == "" {
spec.SchedulerName = corev1.DefaultSchedulerName
}
}

func defaultContainer(container *corev1.Container) {
if container.ImagePullPolicy == "" {
if strings.HasSuffix(container.Image, ":latest") || !strings.Contains(container.Image, ":") {
container.ImagePullPolicy = corev1.PullAlways
} else {
container.ImagePullPolicy = corev1.PullIfNotPresent
}
}
if container.TerminationMessagePath == "" {
container.TerminationMessagePath = corev1.TerminationMessagePathDefault
}
if container.TerminationMessagePolicy == "" {
container.TerminationMessagePolicy = corev1.TerminationMessageReadFile
}
}
52 changes: 52 additions & 0 deletions utils/k8sutil/replicaset.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package k8sutil

import (
"encoding/binary"
"fmt"
"hash/fnv"

appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/dump"
"k8s.io/apimachinery/pkg/util/rand"
)

// ReplicaSetsByCreationTimestamp sorts replica sets by creation timestamp, using their names as a tie breaker.
// Copied from k8s.io/kubernetes/pkg/controller to avoid importing the kubernetes monorepo in library packages.
type ReplicaSetsByCreationTimestamp []*appsv1.ReplicaSet

func (o ReplicaSetsByCreationTimestamp) Len() int { return len(o) }
func (o ReplicaSetsByCreationTimestamp) Swap(i, j int) { o[i], o[j] = o[j], o[i] }
func (o ReplicaSetsByCreationTimestamp) Less(i, j int) bool {
if o[i].CreationTimestamp.Equal(&o[j].CreationTimestamp) {
return o[i].Name < o[j].Name
}
return o[i].CreationTimestamp.Before(&o[j].CreationTimestamp)
}

// FilterActiveReplicaSets returns replica sets that have (or at least ought to have) pods.
func FilterActiveReplicaSets(replicaSets []*appsv1.ReplicaSet) []*appsv1.ReplicaSet {
active := make([]*appsv1.ReplicaSet, 0, len(replicaSets))
for _, rs := range replicaSets {
if rs != nil && rs.Spec.Replicas != nil && *rs.Spec.Replicas > 0 {
active = append(active, rs)
}
}
return active
}

// ComputeHash returns a hash value calculated from pod template and a collisionCount to avoid hash collision.
// This matches the legacy k8s.io/kubernetes/pkg/controller.ComputeHash implementation so existing
// ReplicaSets labeled with the old hash remain discoverable after upgrades.
func ComputeHash(template *corev1.PodTemplateSpec, collisionCount *int32) string {
podTemplateSpecHasher := fnv.New32a()
fmt.Fprintf(podTemplateSpecHasher, "%v", dump.ForHash(*template))

if collisionCount != nil {
collisionCountBytes := make([]byte, 8)
binary.LittleEndian.PutUint32(collisionCountBytes, uint32(*collisionCount))
podTemplateSpecHasher.Write(collisionCountBytes)
}

return rand.SafeEncodeString(fmt.Sprint(podTemplateSpecHasher.Sum32()))
}
53 changes: 53 additions & 0 deletions utils/k8sutil/replicaset_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package k8sutil

import (
"testing"

"github.com/stretchr/testify/assert"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"
"sigs.k8s.io/yaml"
)

func TestComputeHashMatchesLegacyImplementation(t *testing.T) {
template := corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"app": "nginx"}},
Spec: corev1.PodSpec{
Containers: []corev1.Container{{Name: "nginx", Image: "nginx:1.19"}},
},
}
collisionCount := ptr.To[int32](2)

hash := ComputeHash(&template, collisionCount)
assert.NotEmpty(t, hash)
assert.Equal(t, ComputeHash(&template, collisionCount), hash)
}

func TestDefaultPodTemplateServiceAccount(t *testing.T) {
var desired corev1.PodTemplateSpec
err := yaml.Unmarshal([]byte(`
metadata:
labels:
app: serviceaccount-ro
spec:
containers:
- image: nginx:1.19-alpine
name: app
serviceAccountName: default
`), &desired)
assert.NoError(t, err)

DefaultPodTemplate(&desired)
assert.Equal(t, "default", desired.Spec.ServiceAccountName)
}

func TestFilterActiveReplicaSets(t *testing.T) {
active := FilterActiveReplicaSets([]*appsv1.ReplicaSet{
{Spec: appsv1.ReplicaSetSpec{Replicas: ptr.To[int32](1)}},
{Spec: appsv1.ReplicaSetSpec{Replicas: ptr.To[int32](0)}},
nil,
})
assert.Len(t, active, 1)
}
19 changes: 7 additions & 12 deletions utils/replicaset/replicaset.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@ import (
"k8s.io/apimachinery/pkg/runtime"
intstrutil "k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/client-go/kubernetes"
corev1defaults "k8s.io/kubernetes/pkg/apis/core/v1"
"k8s.io/kubernetes/pkg/controller"
"k8s.io/utils/ptr"

"github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1"
"github.com/argoproj/argo-rollouts/utils/annotations"
"github.com/argoproj/argo-rollouts/utils/conditions"
"github.com/argoproj/argo-rollouts/utils/defaults"
"github.com/argoproj/argo-rollouts/utils/hash"
"github.com/argoproj/argo-rollouts/utils/k8sutil"
logutil "github.com/argoproj/argo-rollouts/utils/log"
timeutil "github.com/argoproj/argo-rollouts/utils/time"
)
Expand All @@ -39,14 +38,14 @@ func FindNewReplicaSet(rollout *v1alpha1.Rollout, rsList []*appsv1.ReplicaSet) *
}
}
rsList = newRSList
sort.Sort(controller.ReplicaSetsByCreationTimestamp(rsList))
sort.Sort(k8sutil.ReplicaSetsByCreationTimestamp(rsList))
// First, attempt to find the replicaset using our own hashing
podHash := hash.ComputePodTemplateHash(&rollout.Spec.Template, rollout.Status.CollisionCount)
if rs := searchRsByHash(rsList, podHash); rs != nil {
return rs
}
// Second, attempt to find the replicaset with old hash implementation
oldHash := controller.ComputeHash(&rollout.Spec.Template, rollout.Status.CollisionCount)
oldHash := k8sutil.ComputeHash(&rollout.Spec.Template, rollout.Status.CollisionCount)
if rs := searchRsByHash(rsList, oldHash); rs != nil {
logCtx := logutil.WithRollout(rollout)
logCtx.Infof("ComputePodTemplateHash hash changed (new hash: %s, old hash: %s)", podHash, oldHash)
Expand Down Expand Up @@ -325,8 +324,8 @@ func FindActiveOrLatest(newRS *appsv1.ReplicaSet, oldRSs []*appsv1.ReplicaSet) *
return nil
}

sort.Sort(sort.Reverse(controller.ReplicaSetsByCreationTimestamp(oldRSs)))
allRSs := controller.FilterActiveReplicaSets(append(oldRSs, newRS))
sort.Sort(sort.Reverse(k8sutil.ReplicaSetsByCreationTimestamp(oldRSs)))
allRSs := k8sutil.FilterActiveReplicaSets(append(oldRSs, newRS))

switch len(allRSs) {
case 0:
Expand All @@ -348,7 +347,7 @@ func IsActive(rs *appsv1.ReplicaSet) bool {
return false
}

return len(controller.FilterActiveReplicaSets([]*appsv1.ReplicaSet{rs})) > 0
return len(k8sutil.FilterActiveReplicaSets([]*appsv1.ReplicaSet{rs})) > 0
}

// GetReplicaCountForReplicaSets returns the sum of Replicas of the given replica sets.
Expand Down Expand Up @@ -529,11 +528,7 @@ func PodTemplateEqualIgnoreHash(live, desired *corev1.PodTemplateSpec) bool {
delete(live.Labels, v1alpha1.DefaultRolloutUniqueLabelKey)
delete(desired.Labels, v1alpha1.DefaultRolloutUniqueLabelKey)

podTemplate := corev1.PodTemplate{
Template: *desired,
}
corev1defaults.SetObjectDefaults_PodTemplate(&podTemplate)
desired = &podTemplate.Template
k8sutil.DefaultPodTemplate(desired)

// Do not allow the deprecated spec.serviceAccount to factor into the equality check. In live
// ReplicaSet pod template, this field will be populated, but in the desired pod template
Expand Down
8 changes: 4 additions & 4 deletions utils/replicaset/replicaset_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ import (
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/uuid"
k8sfake "k8s.io/client-go/kubernetes/fake"
"k8s.io/kubernetes/pkg/controller"
"k8s.io/utils/ptr"
"sigs.k8s.io/yaml"

"github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1"
"github.com/argoproj/argo-rollouts/utils/annotations"
"github.com/argoproj/argo-rollouts/utils/conditions"
"github.com/argoproj/argo-rollouts/utils/hash"
"github.com/argoproj/argo-rollouts/utils/k8sutil"
timeutil "github.com/argoproj/argo-rollouts/utils/time"
)

Expand Down Expand Up @@ -93,7 +93,7 @@ func TestFindNewReplicaSet(t *testing.T) {
})
t.Run("FindNewReplicaSet by deprecated hash", func(t *testing.T) {
// rs has the deprecated hash
rs1.Labels[v1alpha1.DefaultRolloutUniqueLabelKey] = controller.ComputeHash(&ro.Spec.Template, ro.Status.CollisionCount)
rs1.Labels[v1alpha1.DefaultRolloutUniqueLabelKey] = k8sutil.ComputeHash(&ro.Spec.Template, ro.Status.CollisionCount)
actual := FindNewReplicaSet(&ro, []*appsv1.ReplicaSet{&rs1})
assert.Equal(t, &rs1, actual)
})
Expand Down Expand Up @@ -144,8 +144,8 @@ func TestFindOldReplicaSets(t *testing.T) {
for _, test := range tests {
t.Run(test.Name, func(t *testing.T) {
allRS := FindOldReplicaSets(&test.rollout, test.rsList, &newRS)
sort.Sort(controller.ReplicaSetsByCreationTimestamp(allRS))
sort.Sort(controller.ReplicaSetsByCreationTimestamp(test.expected))
sort.Sort(k8sutil.ReplicaSetsByCreationTimestamp(allRS))
sort.Sort(k8sutil.ReplicaSetsByCreationTimestamp(test.expected))
if !reflect.DeepEqual(allRS, test.expected) {
t.Errorf("In test case %q, expected %#v, got %#v", test.Name, test.expected, allRS)
}
Expand Down
Loading