Support global registry configuration (#309)

DataDog · Jun 3, 2021 · f95658e · f95658e
1 parent 959b205
commit f95658e
Show file tree

Hide file tree

Showing 14 changed files with 320 additions and 113 deletions.
diff --git a/api/v1alpha1/const.go b/api/v1alpha1/const.go
@@ -340,4 +340,9 @@ const (
 	ClusterRoleKind    = "ClusterRole"
 	RoleKind           = "Role"
 	ServiceAccountKind = "ServiceAccount"
+
+	// Container Registries
+
+	DefaultImageRegistry = "gcr.io/datadoghq"
+	JMXTagSuffix         = "-jmx"
 )
diff --git a/api/v1alpha1/datadogagent_default.go b/api/v1alpha1/datadogagent_default.go
@@ -22,7 +22,10 @@ import (
 // default values
 const (
 	DefaultLogLevel                       string = "INFO"
-	defaultAgentImage                     string = "gcr.io/datadoghq/agent:latest"
+	defaultAgentImageTag                  string = "7.28.0"
+	defaultClusterAgentImageTag           string = "1.12.0"
+	defaultAgentImageName                 string = "agent"
+	defaultClusterAgentImageName          string = "cluster-agent"
 	defaultCollectEvents                  bool   = false
 	defaultLeaderElection                 bool   = false
 	defaultDockerSocketPath               string = "/var/run/docker.sock"
@@ -54,7 +57,6 @@ const (
 	defaultClusterAgentReplicas                          int32  = 1
 	defaultAgentCanaryReplicas                           int32  = 1
 	defaultClusterChecksRunnerReplicas                   int32  = 1
-	defaultClusterAgentImage                             string = "gcr.io/datadoghq/cluster-agent:latest"
 	defaultRollingUpdateMaxUnavailable                          = "10%"
 	defaultUpdateStrategy                                       = appsv1.RollingUpdateDaemonSetStrategyType
 	defaultRollingUpdateMaxPodSchedulerFailure                  = "10%"
@@ -178,6 +180,10 @@ func IsDefaultedImageConfig(imageConfig *ImageConfig) bool {
 		return false
 	}
 
+	if imageConfig.Tag == "" {
+		return false
+	}
+
 	if imageConfig.PullPolicy == nil {
 		return false
 	}
@@ -501,7 +507,7 @@ func DefaultDatadogAgentSpecAgent(agent *DatadogAgentSpecAgentSpec) *DatadogAgen
 		agent.UseExtendedDaemonset = NewBoolPointer(false)
 	}
 
-	DefaultDatadogAgentSpecAgentImage(&agent.Image)
+	DefaultDatadogImage(&agent.Image, defaultAgentImageName, defaultAgentImageTag)
 	DefaultDatadogAgentSpecAgentConfig(agent)
 	DefaultDatadogAgentSpecRbacConfig(&agent.Rbac)
 	agent.DeploymentStrategy = DefaultDatadogAgentSpecDatadogAgentStrategy(agent.DeploymentStrategy)
@@ -512,15 +518,19 @@ func DefaultDatadogAgentSpecAgent(agent *DatadogAgentSpecAgentSpec) *DatadogAgen
 	return agent
 }
 
-// DefaultDatadogAgentSpecAgentImage used to default a ImageConfig
-// return the defaulted ImageConfig
-func DefaultDatadogAgentSpecAgentImage(image *ImageConfig) *ImageConfig {
+// DefaultDatadogImage used to default a ImageConfig for the Agent, Cluster Agent and the Cluster Check Runner.
+// Returns the defaulted ImageConfig.
+func DefaultDatadogImage(image *ImageConfig, name, tag string) *ImageConfig {
 	if image == nil {
 		image = &ImageConfig{}
 	}
 
 	if image.Name == "" {
-		image.Name = defaultAgentImage
+		image.Name = name
+	}
+
+	if image.Tag == "" {
+		image.Tag = tag
 	}
 
 	if image.PullPolicy == nil {
@@ -858,7 +868,7 @@ func DefaultDatadogFeaturePrometheusScrape(prom *PrometheusScrapeConfig) *Promet
 // DefaultDatadogAgentSpecClusterAgent used to default an DatadogAgentSpecClusterAgentSpec
 // return the defaulted DatadogAgentSpecClusterAgentSpec
 func DefaultDatadogAgentSpecClusterAgent(clusterAgent *DatadogAgentSpecClusterAgentSpec) *DatadogAgentSpecClusterAgentSpec {
-	DefaultDatadogAgentSpecClusterAgentImage(&clusterAgent.Image)
+	DefaultDatadogImage(&clusterAgent.Image, defaultClusterAgentImageName, defaultClusterAgentImageTag)
 	DefaultDatadogAgentSpecClusterAgentConfig(&clusterAgent.Config)
 	DefaultDatadogAgentSpecRbacConfig(&clusterAgent.Rbac)
 	DefaultNetworkPolicy(&clusterAgent.NetworkPolicy)
@@ -914,32 +924,10 @@ func GetKubeStateMetricsConfName(dcaConf *DatadogAgent) string {
 	return fmt.Sprintf("%s-%s", dcaConf.Name, DefaultKubeStateMetricsCoreConf)
 }
 
-// DefaultDatadogAgentSpecClusterAgentImage used to default ImageConfig for the Datadog Cluster Agent
-// return the defaulted ImageConfig
-func DefaultDatadogAgentSpecClusterAgentImage(image *ImageConfig) *ImageConfig {
-	if image == nil {
-		image = &ImageConfig{}
-	}
-
-	if image.Name == "" {
-		image.Name = defaultClusterAgentImage
-	}
-
-	if image.PullPolicy == nil {
-		image.PullPolicy = &defaultImagePullPolicy
-	}
-
-	if image.PullSecrets == nil {
-		image.PullSecrets = &[]corev1.LocalObjectReference{}
-	}
-
-	return image
-}
-
 // DefaultDatadogAgentSpecClusterChecksRunner used to default an DatadogAgentSpecClusterChecksRunnerSpec
 // return the defaulted DatadogAgentSpecClusterChecksRunnerSpec
 func DefaultDatadogAgentSpecClusterChecksRunner(clusterChecksRunner *DatadogAgentSpecClusterChecksRunnerSpec) *DatadogAgentSpecClusterChecksRunnerSpec {
-	DefaultDatadogAgentSpecClusterChecksRunnerImage(&clusterChecksRunner.Image)
+	DefaultDatadogImage(&clusterChecksRunner.Image, defaultAgentImageName, defaultAgentImageTag)
 	DefaultDatadogAgentSpecClusterChecksRunnerConfig(&clusterChecksRunner.Config)
 	DefaultDatadogAgentSpecRbacConfig(&clusterChecksRunner.Rbac)
 	DefaultNetworkPolicy(&clusterChecksRunner.NetworkPolicy)
@@ -961,28 +949,6 @@ func DefaultDatadogAgentSpecClusterChecksRunnerConfig(config *ClusterChecksRunne
 	return config
 }
 
-// DefaultDatadogAgentSpecClusterChecksRunnerImage used to default ImageConfig for the Datadog Cluster Agent
-// return the defaulted ImageConfig
-func DefaultDatadogAgentSpecClusterChecksRunnerImage(image *ImageConfig) *ImageConfig {
-	if image == nil {
-		image = &ImageConfig{}
-	}
-
-	if image.Name == "" {
-		image.Name = defaultAgentImage
-	}
-
-	if image.PullPolicy == nil {
-		image.PullPolicy = &defaultImagePullPolicy
-	}
-
-	if image.PullSecrets == nil {
-		image.PullSecrets = &[]corev1.LocalObjectReference{}
-	}
-
-	return image
-}
-
 // DefaultNetworkPolicy is used to default NetworkPolicy. Returns the defaulted
 // ImageConfig
 func DefaultNetworkPolicy(policy *NetworkPolicySpec) *NetworkPolicySpec {

diff --git a/api/v1alpha1/datadogagent_types.go b/api/v1alpha1/datadogagent_types.go
@@ -60,6 +60,12 @@ type DatadogAgentSpec struct {
 	// Set to 'datadoghq.eu' to send data to the EU site.
 	// +optional
 	Site string `json:"site,omitempty"`
+
+	// Registry to use for all Agent images (default gcr.io/datadoghq).
+	// Use public.ecr.aws/datadog for AWS
+	// Use docker.io/datadog for DockerHub
+	// +optional
+	Registry *string `json:"registry,omitempty"`
 }
 
 // DatadogCredentials is a generic structure that holds credentials to access Datadog.
@@ -1151,10 +1157,21 @@ type DatadogAgentSpecClusterChecksRunnerSpec struct {
 // +k8s:openapi-gen=true
 type ImageConfig struct {
 	// Define the image to use:
-	// Use "gcr.io/datadoghq/agent:latest" for Datadog Agent 6
+	// Use "gcr.io/datadoghq/agent:latest" for Datadog Agent 7
 	// Use "datadog/dogstatsd:latest" for Standalone Datadog Agent DogStatsD6
 	// Use "gcr.io/datadoghq/cluster-agent:latest" for Datadog Cluster Agent
-	Name string `json:"name"`
+	// Use "agent" with the registry and tag configurations for <registry>/agent:<tag>
+	// Use "cluster-agent" with the registry and tag configurations for <registry>/cluster-agent:<tag>
+	Name string `json:"name,omitempty"`
+
+	// Define the image version to use:
+	// To be used if the Name field does not correspond to a full image string.
+	// +optional
+	Tag string `json:"tag,omitempty"`
+
+	// Define whether the Agent image should support JMX.
+	// +optional
+	JmxEnabled bool `json:"jmxEnabled,omitempty"`
 
 	// The Kubernetes pull policy:
 	// Use Always, Never or IfNotPresent.

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/api/v1alpha1/zz_generated.openapi.go b/api/v1alpha1/zz_generated.openapi.go
diff --git a/config/crd/bases/v1/datadoghq.com_datadogagents.yaml b/config/crd/bases/v1/datadoghq.com_datadogagents.yaml
@@ -2857,11 +2857,17 @@ spec:
                   image:
                     description: The container image of the Datadog Agent.
                     properties:
+                      jmxEnabled:
+                        description: Define whether the Agent image should support
+                          JMX.
+                        type: boolean
                       name:
                         description: 'Define the image to use: Use "gcr.io/datadoghq/agent:latest"
-                          for Datadog Agent 6 Use "datadog/dogstatsd:latest" for Standalone
+                          for Datadog Agent 7 Use "datadog/dogstatsd:latest" for Standalone
                           Datadog Agent DogStatsD6 Use "gcr.io/datadoghq/cluster-agent:latest"
-                          for Datadog Cluster Agent'
+                          for Datadog Cluster Agent Use "agent" with the registry
+                          and tag configurations for <registry>/agent:<tag> Use "cluster-agent"
+                          with the registry and tag configurations for <registry>/cluster-agent:<tag>'
                         type: string
                       pullPolicy:
                         description: 'The Kubernetes pull policy: Use Always, Never
@@ -2881,8 +2887,10 @@ spec:
                               type: string
                           type: object
                         type: array
-                    required:
-                    - name
+                      tag:
+                        description: 'Define the image version to use: To be used
+                          if the Name field does not correspond to a full image string.'
+                        type: string
                     type: object
                   keepAnnotations:
                     description: KeepAnnotations allows the specification of annotations
@@ -6378,11 +6386,17 @@ spec:
                   image:
                     description: The container image of the Datadog Cluster Agent.
                     properties:
+                      jmxEnabled:
+                        description: Define whether the Agent image should support
+                          JMX.
+                        type: boolean
                       name:
                         description: 'Define the image to use: Use "gcr.io/datadoghq/agent:latest"
-                          for Datadog Agent 6 Use "datadog/dogstatsd:latest" for Standalone
+                          for Datadog Agent 7 Use "datadog/dogstatsd:latest" for Standalone
                           Datadog Agent DogStatsD6 Use "gcr.io/datadoghq/cluster-agent:latest"
-                          for Datadog Cluster Agent'
+                          for Datadog Cluster Agent Use "agent" with the registry
+                          and tag configurations for <registry>/agent:<tag> Use "cluster-agent"
+                          with the registry and tag configurations for <registry>/cluster-agent:<tag>'
                         type: string
                       pullPolicy:
                         description: 'The Kubernetes pull policy: Use Always, Never
@@ -6402,8 +6416,10 @@ spec:
                               type: string
                           type: object
                         type: array
-                    required:
-                    - name
+                      tag:
+                        description: 'Define the image version to use: To be used
+                          if the Name field does not correspond to a full image string.'
+                        type: string
                     type: object
                   keepAnnotations:
                     description: KeepAnnotations allows the specification of annotations
@@ -8936,11 +8952,17 @@ spec:
                     description: The container image of the Datadog Cluster Checks
                       Runner.
                     properties:
+                      jmxEnabled:
+                        description: Define whether the Agent image should support
+                          JMX.
+                        type: boolean
                       name:
                         description: 'Define the image to use: Use "gcr.io/datadoghq/agent:latest"
-                          for Datadog Agent 6 Use "datadog/dogstatsd:latest" for Standalone
+                          for Datadog Agent 7 Use "datadog/dogstatsd:latest" for Standalone
                           Datadog Agent DogStatsD6 Use "gcr.io/datadoghq/cluster-agent:latest"
-                          for Datadog Cluster Agent'
+                          for Datadog Cluster Agent Use "agent" with the registry
+                          and tag configurations for <registry>/agent:<tag> Use "cluster-agent"
+                          with the registry and tag configurations for <registry>/cluster-agent:<tag>'
                         type: string
                       pullPolicy:
                         description: 'The Kubernetes pull policy: Use Always, Never
@@ -8960,8 +8982,10 @@ spec:
                               type: string
                           type: object
                         type: array
-                    required:
-                    - name
+                      tag:
+                        description: 'Define the image version to use: To be used
+                          if the Name field does not correspond to a full image string.'
+                        type: string
                     type: object
                   networkPolicy:
                     description: Provide Cluster Checks Runner Network Policy configuration.
@@ -9247,6 +9271,10 @@ spec:
                         type: boolean
                     type: object
                 type: object
+              registry:
+                description: Registry to use for all Agent images (default gcr.io/datadoghq).
+                  Use public.ecr.aws/datadog for AWS Use docker.io/datadog for DockerHub
+                type: string
               site:
                 description: The site of the Datadog intake to send Agent data to.
                   Set to 'datadoghq.eu' to send data to the EU site.