Add ability to specify and set base annotations for operator resources

docs/api.md

@@ -53,6 +53,7 @@ ClusterSpec defines the desired state for a M3 cluster to be converge to.
 | podSecurityContext | PodSecurityContext allows the user to specify an optional security context for pods. | *corev1.PodSecurityContext | false |
 | securityContext | SecurityContext allows the user to specify a container-level security context. | *corev1.SecurityContext | false |
 | labels | Labels sets the base labels that will be applied to resources created by the cluster. // TODO(schallert): design doc on labeling scheme. | map[string]string | false |
+| annotations | Annotations sets the base annotations that will be applied to resources created by the cluster. | map[string]string | false |
 | tolerations | Tolerations sets the tolerations that will be applied to all M3DB pods. | []corev1.Toleration | false |
 | priorityClassName | PriorityClassName sets the priority class for all M3DB pods. | string | false |
 

pkg/apis/m3dboperator/v1alpha1/cluster.go

@@ -234,6 +234,10 @@ type ClusterSpec struct {
 	// the cluster. // TODO(schallert): design doc on labeling scheme.
 	Labels map[string]string `json:"labels,omitempty"`
 
+	// Annotations sets the base annotations that will be applied to resources created by
+	// the cluster.
+	Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations"`
+
 	// Tolerations sets the tolerations that will be applied to all M3DB pods.
 	// +optional
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

pkg/k8sops/annotations/annotations.go

@@ -0,0 +1,53 @@
+// Copyright (c) 2019 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+// Package annotations defines constants and helpers for annotations used
+// throughout the m3db operator.
+package annotations
+
+import (
+	myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
+	"github.com/m3db/m3db-operator/pkg/k8sops/labels"
+)
+
+const (
+	// App is the label used to identify the application.
+	App = labels.App
+	// AppM3DB is the value for "App" common to all operator-created clusters.
+	AppM3DB = labels.AppM3DB
+	// Cluster is the label identifying what m3db cluster an object is a part of.
+	Cluster = labels.Cluster
+)
+
+// BaseAnnotations returns the base annotations we apply to all objects
+// created by the operator for a given cluster.
+func BaseAnnotations(cluster *myspec.M3DBCluster) map[string]string {
+	base := map[string]string{
+		App:     AppM3DB,
+		Cluster: cluster.Name,
+	}
+	if configured := cluster.Spec.Annotations; configured != nil {
+		for k, v := range configured {
+			base[k] = v
+		}
+	}
+
+	return base
+}

pkg/k8sops/annotations/annotations_test.go

@@ -0,0 +1,53 @@
+// Copyright (c) 2018 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package annotations
+
+import (
+	"testing"
+
+	myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGenerateBaseAnnotations(t *testing.T) {
+	cluster := &myspec.M3DBCluster{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "cluster-foo",
+		},
+	}
+
+	annotations := BaseAnnotations(cluster)
+	expAnnotations := map[string]string{
+		"operator.m3db.io/app":     "m3db",
+		"operator.m3db.io/cluster": "cluster-foo",
+	}
+
+	assert.Equal(t, expAnnotations, annotations)
+
+	cluster.Spec.Annotations = map[string]string{"foo": "bar"}
+	annotations = BaseAnnotations(cluster)
+	expAnnotations["foo"] = "bar"
+
+	assert.Equal(t, expAnnotations, annotations)
+}

pkg/k8sops/generators.go

@@ -26,6 +26,7 @@ import (
 
 	m3dboperator "github.com/m3db/m3db-operator/pkg/apis/m3dboperator"
 	myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
+	"github.com/m3db/m3db-operator/pkg/k8sops/annotations"
 	"github.com/m3db/m3db-operator/pkg/k8sops/labels"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -195,11 +196,12 @@ func GenerateM3DBService(cluster *myspec.M3DBCluster) (*v1.Service, error) {
 
 	svcLabels := labels.BaseLabels(cluster)
 	svcLabels[labels.Component] = labels.ComponentM3DBNode
-
+	svcAnnotations := annotations.BaseAnnotations(cluster)
 	return &v1.Service{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:   HeadlessServiceName(cluster.Name),
-			Labels: svcLabels,
+			Name:        HeadlessServiceName(cluster.Name),
+			Labels:      svcLabels,
+			Annotations: svcAnnotations,
 		},
 		Spec: v1.ServiceSpec{
 			Selector:  svcLabels,

pkg/k8sops/generators_test.go

@@ -25,6 +25,7 @@ import (
 
 	m3dboperator "github.com/m3db/m3db-operator/pkg/apis/m3dboperator"
 	myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
+	"github.com/m3db/m3db-operator/pkg/k8sops/annotations"
 	"github.com/m3db/m3db-operator/pkg/k8sops/labels"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -119,8 +120,9 @@ func TestGenerateStatefulSet(t *testing.T) {
 
 	baseSS := &appsv1.StatefulSet{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:   ssName,
-			Labels: labels,
+			Name:        ssName,
+			Labels:      labels,
+			Annotations: annotations.BaseAnnotations(fixture),
 			OwnerReferences: []metav1.OwnerReference{
 				*metav1.NewControllerRef(fixture, schema.GroupVersionKind{
 					Group:   myspec.SchemeGroupVersion.Group,
@@ -371,6 +373,10 @@ func TestGenerateM3DBService(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{
 			Name:   "m3dbnode-cluster-a",
 			Labels: baseLabels,
+			Annotations: map[string]string{
+				annotations.App:     annotations.AppM3DB,
+				annotations.Cluster: cluster.Name,
+			},
 		},
 		Spec: v1.ServiceSpec{
 			Selector:  baseLabels,

pkg/k8sops/statefulset.go

@@ -25,6 +25,7 @@ import (
 	"fmt"
 
 	myspec "github.com/m3db/m3db-operator/pkg/apis/m3dboperator/v1alpha1"
+	"github.com/m3db/m3db-operator/pkg/k8sops/annotations"
 	"github.com/m3db/m3db-operator/pkg/k8sops/labels"
 	"github.com/m3db/m3db-operator/pkg/k8sops/podidentity"
 
@@ -62,6 +63,8 @@ func NewBaseStatefulSet(ssName, isolationGroup string, cluster *myspec.M3DBClust
 		objLabels[k] = v
 	}
 
+	objAnnotations := annotations.BaseAnnotations(cluster)
+
 	// TODO(schallert): we're currently using the health of the coordinator for
 	// liveness probes until https://github.com/m3db/m3/issues/996 is fixed. Move
 	// to the dbnode's health endpoint once fixed.
@@ -93,8 +96,9 @@ func NewBaseStatefulSet(ssName, isolationGroup string, cluster *myspec.M3DBClust
 
 	return &appsv1.StatefulSet{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:   ssName,
-			Labels: objLabels,
+			Name:        ssName,
+			Labels:      objLabels,
+			Annotations: objAnnotations,
 		},
 		Spec: appsv1.StatefulSetSpec{
 			ServiceName: HeadlessServiceName(clusterName),