mirror of
https://github.com/fluxcd/flagger.git
synced 2026-04-15 06:57:34 +00:00
121eb767cb
Signed-off-by: Karl Heins <karlheins@northwesternmutual.com> Support updating primary Deployment/DaemonSet/HPA/Service labels and annotations after first-time rollout
347 lines
13 KiB
Go
347 lines
13 KiB
Go
/*
|
|
Copyright 2020 The Flux authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package canary
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"go.uber.org/zap"
|
|
appsv1 "k8s.io/api/apps/v1"
|
|
corev1 "k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/api/errors"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
|
"k8s.io/client-go/kubernetes"
|
|
"k8s.io/client-go/util/retry"
|
|
|
|
flaggerv1 "github.com/fluxcd/flagger/pkg/apis/flagger/v1beta1"
|
|
clientset "github.com/fluxcd/flagger/pkg/client/clientset/versioned"
|
|
)
|
|
|
|
var (
|
|
daemonSetScaleDownNodeSelector = map[string]string{"flagger.app/scale-to-zero": "true"}
|
|
)
|
|
|
|
// DaemonSetController is managing the operations for Kubernetes DaemonSet kind
|
|
type DaemonSetController struct {
|
|
kubeClient kubernetes.Interface
|
|
flaggerClient clientset.Interface
|
|
logger *zap.SugaredLogger
|
|
configTracker Tracker
|
|
labels []string
|
|
includeLabelPrefix []string
|
|
}
|
|
|
|
func (c *DaemonSetController) ScaleToZero(cd *flaggerv1.Canary) error {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
dae, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("daemonset %s.%s get query error: %w", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
daeCopy := dae.DeepCopy()
|
|
daeCopy.Spec.Template.Spec.NodeSelector = make(map[string]string,
|
|
len(dae.Spec.Template.Spec.NodeSelector)+len(daemonSetScaleDownNodeSelector))
|
|
for k, v := range dae.Spec.Template.Spec.NodeSelector {
|
|
daeCopy.Spec.Template.Spec.NodeSelector[k] = v
|
|
}
|
|
|
|
for k, v := range daemonSetScaleDownNodeSelector {
|
|
daeCopy.Spec.Template.Spec.NodeSelector[k] = v
|
|
}
|
|
|
|
_, err = c.kubeClient.AppsV1().DaemonSets(dae.Namespace).Update(context.TODO(), daeCopy, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("updating daemonset %s.%s failed: %w", daeCopy.GetName(), daeCopy.Namespace, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (c *DaemonSetController) ScaleFromZero(cd *flaggerv1.Canary) error {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
dep, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("daemonset %s.%s query error: %w", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
depCopy := dep.DeepCopy()
|
|
for k := range daemonSetScaleDownNodeSelector {
|
|
delete(depCopy.Spec.Template.Spec.NodeSelector, k)
|
|
}
|
|
|
|
_, err = c.kubeClient.AppsV1().DaemonSets(dep.Namespace).Update(context.TODO(), depCopy, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("scaling up daemonset %s.%s failed: %w", depCopy.GetName(), depCopy.Namespace, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Initialize creates the primary DaemonSet, scales down the canary DaemonSet,
|
|
// and returns the pod selector label and container ports
|
|
func (c *DaemonSetController) Initialize(cd *flaggerv1.Canary) (err error) {
|
|
err = c.createPrimaryDaemonSet(cd, c.includeLabelPrefix)
|
|
if err != nil {
|
|
return fmt.Errorf("createPrimaryDaemonSet failed: %w", err)
|
|
}
|
|
|
|
if cd.Status.Phase == "" || cd.Status.Phase == flaggerv1.CanaryPhaseInitializing {
|
|
if !cd.SkipAnalysis() {
|
|
if err := c.IsPrimaryReady(cd); err != nil {
|
|
return fmt.Errorf("%w", err)
|
|
}
|
|
}
|
|
|
|
c.logger.With("canary", fmt.Sprintf("%s.%s", cd.Name, cd.Namespace)).
|
|
Infof("Scaling down DaemonSet %s.%s", cd.Spec.TargetRef.Name, cd.Namespace)
|
|
if err := c.ScaleToZero(cd); err != nil {
|
|
return fmt.Errorf("ScaleToZero failed: %w", err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Promote copies the pod spec, secrets and config maps from canary to primary
|
|
func (c *DaemonSetController) Promote(cd *flaggerv1.Canary) error {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
primaryName := fmt.Sprintf("%s-primary", targetName)
|
|
|
|
err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
|
|
canary, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("damonset %s.%s get query error: %v", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
label, labelValue, err := c.getSelectorLabel(canary)
|
|
primaryLabelValue := fmt.Sprintf("%s-primary", labelValue)
|
|
if err != nil {
|
|
return fmt.Errorf("getSelectorLabel failed: %w", err)
|
|
}
|
|
|
|
primary, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), primaryName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("daemonset %s.%s get query error: %w", primaryName, cd.Namespace, err)
|
|
}
|
|
|
|
// promote secrets and config maps
|
|
configRefs, err := c.configTracker.GetTargetConfigs(cd)
|
|
if err != nil {
|
|
return fmt.Errorf("GetTargetConfigs failed: %w", err)
|
|
}
|
|
if err := c.configTracker.CreatePrimaryConfigs(cd, configRefs, c.includeLabelPrefix); err != nil {
|
|
return fmt.Errorf("CreatePrimaryConfigs failed: %w", err)
|
|
}
|
|
|
|
primaryCopy := primary.DeepCopy()
|
|
primaryCopy.Spec.MinReadySeconds = canary.Spec.MinReadySeconds
|
|
primaryCopy.Spec.RevisionHistoryLimit = canary.Spec.RevisionHistoryLimit
|
|
primaryCopy.Spec.UpdateStrategy = canary.Spec.UpdateStrategy
|
|
|
|
// update spec with primary secrets and config maps
|
|
primaryCopy.Spec.Template.Spec = c.configTracker.ApplyPrimaryConfigs(canary.Spec.Template.Spec, configRefs)
|
|
|
|
// ignore `daemonSetScaleDownNodeSelector` node selector
|
|
for key := range daemonSetScaleDownNodeSelector {
|
|
delete(primaryCopy.Spec.Template.Spec.NodeSelector, key)
|
|
}
|
|
|
|
// update pod annotations to ensure a rolling update
|
|
annotations, err := makeAnnotations(canary.Spec.Template.Annotations)
|
|
if err != nil {
|
|
return fmt.Errorf("makeAnnotations failed: %w", err)
|
|
}
|
|
|
|
primaryCopy.Spec.Template.Annotations = annotations
|
|
primaryCopy.Spec.Template.Labels = makePrimaryLabels(canary.Spec.Template.Labels, primaryLabelValue, label)
|
|
|
|
// update ds annotations
|
|
primaryCopy.ObjectMeta.Annotations = make(map[string]string)
|
|
filteredAnnotations := includeLabelsByPrefix(canary.ObjectMeta.Annotations, c.includeLabelPrefix)
|
|
for k, v := range filteredAnnotations {
|
|
primaryCopy.ObjectMeta.Annotations[k] = v
|
|
}
|
|
// update ds labels
|
|
primaryCopy.ObjectMeta.Labels = make(map[string]string)
|
|
filteredLabels := includeLabelsByPrefix(canary.ObjectMeta.Labels, c.includeLabelPrefix)
|
|
for k, v := range filteredLabels {
|
|
primaryCopy.ObjectMeta.Labels[k] = v
|
|
}
|
|
|
|
// apply update
|
|
_, err = c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Update(context.TODO(), primaryCopy, metav1.UpdateOptions{})
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("updating daemonset %s.%s template spec failed: %w",
|
|
primaryName, cd.Namespace, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// HasTargetChanged returns true if the canary DaemonSet pod spec has changed
|
|
func (c *DaemonSetController) HasTargetChanged(cd *flaggerv1.Canary) (bool, error) {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
canary, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return false, fmt.Errorf("daemonset %s.%s get query error: %w", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
// ignore `daemonSetScaleDownNodeSelector` node selector
|
|
for key := range daemonSetScaleDownNodeSelector {
|
|
delete(canary.Spec.Template.Spec.NodeSelector, key)
|
|
}
|
|
|
|
// since nil and capacity zero map would have different hash, we have to initialize here
|
|
if canary.Spec.Template.Spec.NodeSelector == nil {
|
|
canary.Spec.Template.Spec.NodeSelector = map[string]string{}
|
|
}
|
|
|
|
return hasSpecChanged(cd, canary.Spec.Template)
|
|
}
|
|
|
|
// GetMetadata returns the pod label selector and svc ports
|
|
func (c *DaemonSetController) GetMetadata(cd *flaggerv1.Canary) (string, string, map[string]int32, error) {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
|
|
canaryDae, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return "", "", nil, fmt.Errorf("daemonset %s.%s get query error: %w", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
label, labelValue, err := c.getSelectorLabel(canaryDae)
|
|
if err != nil {
|
|
return "", "", nil, fmt.Errorf("getSelectorLabel failed: %w", err)
|
|
}
|
|
|
|
var ports map[string]int32
|
|
if cd.Spec.Service.PortDiscovery {
|
|
ports = getPorts(cd, canaryDae.Spec.Template.Spec.Containers)
|
|
}
|
|
return label, labelValue, ports, nil
|
|
}
|
|
|
|
func (c *DaemonSetController) createPrimaryDaemonSet(cd *flaggerv1.Canary, includeLabelPrefix []string) error {
|
|
targetName := cd.Spec.TargetRef.Name
|
|
primaryName := fmt.Sprintf("%s-primary", cd.Spec.TargetRef.Name)
|
|
|
|
canaryDae, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), targetName, metav1.GetOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("daemonset %s.%s get query error: %w", targetName, cd.Namespace, err)
|
|
}
|
|
|
|
if canaryDae.Spec.UpdateStrategy.Type != "" &&
|
|
canaryDae.Spec.UpdateStrategy.Type != appsv1.RollingUpdateDaemonSetStrategyType {
|
|
return fmt.Errorf("daemonset %s.%s must have RollingUpdate strategy but have %s",
|
|
targetName, cd.Namespace, canaryDae.Spec.UpdateStrategy.Type)
|
|
}
|
|
|
|
// Create the labels map but filter unwanted labels
|
|
labels := includeLabelsByPrefix(canaryDae.Labels, includeLabelPrefix)
|
|
|
|
label, labelValue, err := c.getSelectorLabel(canaryDae)
|
|
primaryLabelValue := fmt.Sprintf("%s-primary", labelValue)
|
|
if err != nil {
|
|
return fmt.Errorf("getSelectorLabel failed: %w", err)
|
|
}
|
|
|
|
primaryDae, err := c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Get(context.TODO(), primaryName, metav1.GetOptions{})
|
|
if errors.IsNotFound(err) {
|
|
// create primary secrets and config maps
|
|
configRefs, err := c.configTracker.GetTargetConfigs(cd)
|
|
if err != nil {
|
|
return fmt.Errorf("GetTargetConfigs failed: %w", err)
|
|
}
|
|
if err := c.configTracker.CreatePrimaryConfigs(cd, configRefs, c.includeLabelPrefix); err != nil {
|
|
return fmt.Errorf("CreatePrimaryConfigs failed: %w", err)
|
|
}
|
|
annotations, err := makeAnnotations(canaryDae.Spec.Template.Annotations)
|
|
if err != nil {
|
|
return fmt.Errorf("makeAnnotations failed: %w", err)
|
|
}
|
|
|
|
// create primary daemonset
|
|
primaryDae = &appsv1.DaemonSet{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: primaryName,
|
|
Namespace: cd.Namespace,
|
|
Labels: makePrimaryLabels(labels, primaryLabelValue, label),
|
|
Annotations: filterMetadata(canaryDae.Annotations),
|
|
OwnerReferences: []metav1.OwnerReference{
|
|
*metav1.NewControllerRef(cd, schema.GroupVersionKind{
|
|
Group: flaggerv1.SchemeGroupVersion.Group,
|
|
Version: flaggerv1.SchemeGroupVersion.Version,
|
|
Kind: flaggerv1.CanaryKind,
|
|
}),
|
|
},
|
|
},
|
|
Spec: appsv1.DaemonSetSpec{
|
|
MinReadySeconds: canaryDae.Spec.MinReadySeconds,
|
|
RevisionHistoryLimit: canaryDae.Spec.RevisionHistoryLimit,
|
|
UpdateStrategy: canaryDae.Spec.UpdateStrategy,
|
|
Selector: &metav1.LabelSelector{
|
|
MatchLabels: map[string]string{
|
|
label: primaryLabelValue,
|
|
},
|
|
},
|
|
Template: corev1.PodTemplateSpec{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Labels: makePrimaryLabels(canaryDae.Spec.Template.Labels, primaryLabelValue, label),
|
|
Annotations: annotations,
|
|
},
|
|
// update spec with the primary secrets and config maps
|
|
Spec: c.configTracker.ApplyPrimaryConfigs(canaryDae.Spec.Template.Spec, configRefs),
|
|
},
|
|
},
|
|
}
|
|
|
|
_, err = c.kubeClient.AppsV1().DaemonSets(cd.Namespace).Create(context.TODO(), primaryDae, metav1.CreateOptions{})
|
|
if err != nil {
|
|
return fmt.Errorf("creating daemonset %s.%s failed: %w", primaryDae.Name, cd.Namespace, err)
|
|
}
|
|
|
|
c.logger.With("canary", fmt.Sprintf("%s.%s", cd.Name, cd.Namespace)).Infof("DaemonSet %s.%s created", primaryDae.GetName(), cd.Namespace)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// getSelectorLabel returns the selector match label
|
|
func (c *DaemonSetController) getSelectorLabel(daemonSet *appsv1.DaemonSet) (string, string, error) {
|
|
for _, l := range c.labels {
|
|
if _, ok := daemonSet.Spec.Selector.MatchLabels[l]; ok {
|
|
return l, daemonSet.Spec.Selector.MatchLabels[l], nil
|
|
}
|
|
}
|
|
|
|
return "", "", fmt.Errorf(
|
|
"daemonset %s.%s spec.selector.matchLabels must contain one of %v'",
|
|
daemonSet.Name, daemonSet.Namespace, c.labels,
|
|
)
|
|
}
|
|
|
|
func (c *DaemonSetController) HaveDependenciesChanged(cd *flaggerv1.Canary) (bool, error) {
|
|
return c.configTracker.HasConfigChanged(cd)
|
|
}
|
|
|
|
//Finalize scale the reference instance from zero
|
|
func (c *DaemonSetController) Finalize(cd *flaggerv1.Canary) error {
|
|
if err := c.ScaleFromZero(cd); err != nil {
|
|
return fmt.Errorf("ScaleFromZero failed: %w", err)
|
|
}
|
|
return nil
|
|
}
|