meta.go

/*
Copyright 2018 The Knative 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 resources

import (
	"strings"

	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/sets"
	"knative.dev/pkg/kmap"
	"knative.dev/serving/pkg/apis/autoscaling"
	"knative.dev/serving/pkg/apis/serving"
	v1 "knative.dev/serving/pkg/apis/serving/v1"
)

var (
	excludeLabels = sets.New(
		serving.RouteLabelKey,
		serving.RoutingStateLabelKey,
	)

	excludeAnnotations = sets.New(
		serving.RevisionLastPinnedAnnotationKey,
		serving.RevisionPreservedAnnotationKey,
		serving.RoutingStateModifiedAnnotationKey,
		serving.RoutesAnnotationKey,
	)
)

const (
	DefaultContainerAnnotationName = "kubectl.kubernetes.io/default-container"
)

// makeLabels constructs the labels we will apply to K8s resources.
func makeLabels(revision *v1.Revision) map[string]string {
	labels := kmap.Filter(revision.GetLabels(), excludeLabels.Has)
	labels = kmap.Union(labels, map[string]string{
		serving.RevisionLabelKey: revision.Name,
		serving.RevisionUID:      string(revision.UID),
	})

	// If users don't specify an app: label we will automatically
	// populate it with the revision name to get the benefit of richer
	// tracing information.
	if _, ok := labels[AppLabelKey]; !ok {
		labels[AppLabelKey] = revision.Name
	}
	return labels
}

func filterExcludedAndAutoscalingAnnotations(val string) bool {
	return excludeAnnotations.Has(val) || strings.HasPrefix(val, autoscaling.GroupName)
}

func deploymentAnnotations(r *v1.Revision) map[string]string {
	return kmap.Filter(r.GetAnnotations(), filterExcludedAndAutoscalingAnnotations)
}

func imageCacheAnnotations(r *v1.Revision) map[string]string {
	return kmap.Filter(r.GetAnnotations(), filterExcludedAndAutoscalingAnnotations)
}

func podAutoscalerAnnotations(r *v1.Revision) map[string]string {
	return kmap.Filter(r.GetAnnotations(), excludeAnnotations.Has)
}

func podAnnotations(r *v1.Revision) map[string]string {
	ann := kmap.Filter(r.GetAnnotations(), filterExcludedAndAutoscalingAnnotations)

	if userContainer := r.Spec.GetContainer(); userContainer.Name != "" {
		ann[DefaultContainerAnnotationName] = userContainer.Name
	}

	return ann
}

// makeSelector constructs the Selector we will apply to K8s resources.
func makeSelector(revision *v1.Revision) *metav1.LabelSelector {
	return &metav1.LabelSelector{
		MatchLabels: map[string]string{
			serving.RevisionUID: string(revision.UID),
		},
	}
}