meta

Documentation

Index

• Constants
• Variables
• func IsPauseAnnotationSet(annotations map[string]string) bool
• func UseGCPSecretManager(annotations map[string]string) bool
• func UseVClusterOps(annotations map[string]string) bool

Constants

const (
	// Annotations that we set in each of the pod.  These are set by the
	// AnnotateAndLabelPodReconciler.  They are available in the pod with the
	// downwardAPI so they can be picked up by the Vertica data collector (DC).
	KubernetesVersionAnnotation   = "kubernetes.io/version"   // Version of the k8s server
	KubernetesGitCommitAnnotation = "kubernetes.io/gitcommit" // Git commit of the k8s server
	KubernetesBuildDateAnnotation = "kubernetes.io/buildDate" // Build date of the k8s server

	// If this annotation is on any CR, the operator will skip processing. This can
	// be used to avoid getting in an infinity error-retry loop. Or, if you know
	// no additional work will ever exist for an object. Just set this to a
	// true|ON|1 value.
	PauseOperatorAnnotation = "vertica.com/pause"

	// This is a feature flag for using vertica without admintools. Set this
	// annotation in the VerticaDB that you want to use the new vclusterOps
	// library for any vertica admin task. The value of this annotation is
	// treated as a boolean.
	VClusterOpsAnnotation     = "vertica.com/vcluster-ops"
	VClusterOpsAnnotationTrue = "true"

	// This is a feature flag for accessing the secrets configured in Google Secret Manager.
	// The value of this annotation is treated as a boolean.
	GcpGsmAnnotation = "vertica.com/use-gcp-secret-manager"
)

const (
	SvcTypeLabel              = "vertica.com/svc-type"
	SubclusterNameLabel       = "vertica.com/subcluster-name"
	SubclusterLegacyNameLabel = "vertica.com/subcluster"
	SubclusterTypeLabel       = "vertica.com/subcluster-type"
	SubclusterSvcNameLabel    = "vertica.com/subcluster-svc"
	SubclusterTransientLabel  = "vertica.com/subcluster-transient"

	// ClientRoutingLabel is a label that must exist on the pod in
	// order for Service objects to route to the pod.  This label isn't part of
	// the template in the StatefulSet.  This label is added after the pod is
	// scheduled.  There are a couple of uses for it:
	// - after an add node, we only add the labels once the node has at least
	// one shard subscription.  This saves routing to a pod that cannot fulfill
	// a query request.
	// - before we remove a node.  It allows us to drain out pods that are going
	// to be removed by a pending node removal.
	ClientRoutingLabel = "vertica.com/client-routing"
	ClientRoutingVal   = "true"

	VDBInstanceLabel     = "app.kubernetes.io/instance"
	OperatorVersionLabel = "app.kubernetes.io/version"
	ManagedByLabel       = "app.kubernetes.io/managed-by"
	ComponentLabel       = "app.kubernetes.io/component"
	DataBaseLabel        = "vertica.com/database"

	NameLabel    = "app.kubernetes.io/name"
	OperatorName = "verticadb-operator" // The name of the operator

	CurOperatorVersion = "1.11.2" // The version number of the operator
	// If any of the operator versions are used in the code, add a const here.
	// But it isn't necessary to create a const for each version.
	OperatorVersion100 = "1.0.0"
	OperatorVersion110 = "1.1.0"
	OperatorVersion120 = "1.2.0"
	OperatorVersion130 = "1.3.0"
)

Variables

var ProtectedLabels = []string{
	ManagedByLabel,
	VDBInstanceLabel,
	ComponentLabel,
	OperatorVersionLabel,
	DataBaseLabel,
	SubclusterNameLabel,
	SubclusterTypeLabel,
	SubclusterTransientLabel,
	SubclusterSvcNameLabel,
	SubclusterLegacyNameLabel,
	SvcTypeLabel,
	ClientRoutingLabel,
}

ProtectedLabels lists all of the internally used label.

Functions

func IsPauseAnnotationSet

func IsPauseAnnotationSet(annotations map[string]string) bool

IsPauseAnnotationSet will check the annotations for a special value that will pause the operator for the CR.

func UseGCPSecretManager

func UseGCPSecretManager(annotations map[string]string) bool

UseGCPSecretManager returns true if access to the communal secret should go through Google's secret manager rather the fetching the secret from k8s meta-data.

func UseVClusterOps

func UseVClusterOps(annotations map[string]string) bool

UseVClusterOps returns true if all admin commands should use the vclusterOps library rather than admintools.