annotations

Documentation

Overview

Package annotations defines constants and helpers for annotations used throughout the m3db operator.

Index

• Constants
• func BaseAnnotations(cluster *myspec.M3DBCluster) map[string]string
• func PodAnnotations(cluster *myspec.M3DBCluster) map[string]string

Constants

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
	// Update is the annotation used by the operator to determine if a StatefulSet is
	// allowed to be updated.
	Update = "operator.m3db.io/update"
	// ParallelUpdate is the annotation used by the operator to determine if a StatefulSet
	// is allowed to be updated in parallel.
	ParallelUpdate = "operator.m3db.io/parallel-update"
	// ParallelUpdateInProgress is the annotation used by the operator indicate a parallel update
	// is underway. This annotation should only be used by the operator.
	ParallelUpdateInProgress = "operator.m3db.io/parallel-update-in-progress"
	// EnabledVal is the value that indicates an annotation is enabled.
	EnabledVal = "enabled"
)

Functions

func BaseAnnotations

func BaseAnnotations(cluster *myspec.M3DBCluster) map[string]string

BaseAnnotations returns the base annotations we apply to all objects created by the operator for a given cluster.

func PodAnnotations

func PodAnnotations(cluster *myspec.M3DBCluster) map[string]string

PodAnnotations is for specifying annotations that are only to be applied to the pods such as prometheus scrape tags