Add custom DNS configuration to AWSPlatformStatus

When customer provides their own DNS solution, they are expected to pre-create the API and API-Int LBs. This information is added to AWSPlatformStatus.
openshift · Jul 18, 2023 · 5402364 · 5402364
1 parent de6ad79
commit 5402364
Show file tree

Hide file tree

Showing 9 changed files with 202 additions and 3 deletions.
diff --git a/config/v1/0000_10_config-operator_01_infrastructure-TechPreviewNoUpgrade.crd.yaml b/config/v1/0000_10_config-operator_01_infrastructure-TechPreviewNoUpgrade.crd.yaml
@@ -466,6 +466,24 @@ spec:
                     aws:
                       description: AWS contains settings specific to the Amazon Web Services infrastructure provider.
                       properties:
+                        dnsConfig:
+                          default:
+                            provider: ClusterProvided
+                          description: dnsConfig contains information about the type of DNS solution in use for the cluster and its related configuration.
+                          properties:
+                            provider:
+                              default: ClusterProvided
+                              description: provider determines which DNS solution is in use for this cluster. When the user wants to use their own DNS solution, the `provider` is set to "UserProvided". In this state, the user is expected to pre-create the Load Balancers for API and API-Int. The names of these pre-created Load Balancers are saved. When the cluster is resposible for its own DNS configuration, this field is set to "ClusterProvided". The Load Balancers are also created by the cluster. The default is "ClusterProvided".
+                              enum:
+                                - UserProvided
+                                - ClusterProvided
+                              type: string
+                              x-kubernetes-validations:
+                                - message: type is immutable once set
+                                  rule: oldSelf == '' || self == oldSelf
+                          required:
+                            - provider
+                          type: object
                         region:
                           description: region holds the default AWS region for new AWS resources created by the cluster.
                           type: string

diff --git a/config/v1/feature_gates.go b/config/v1/feature_gates.go
@@ -311,4 +311,14 @@ var (
 		ResponsiblePerson:   "msluiter",
 		OwningProduct:       ocpSpecific,
 	}
+
+	FeatureGateCustomDNSAWS = FeatureGateName("CustomDNSAWS")
+	customDNSAWS            = FeatureGateDescription{
+		FeatureGateAttributes: FeatureGateAttributes{
+			Name: FeatureGateCustomDNSAWS,
+		},
+		OwningJiraComponent: "installer",
+		ResponsiblePerson:   "sadasu",
+		OwningProduct:       ocpSpecific,
+	}
 )
diff --git a/config/v1/techpreview.infrastructure.testsuite.yaml b/config/v1/techpreview.infrastructure.testsuite.yaml
@@ -662,3 +662,39 @@ tests:
           type: External
           external:
             cloudControllerManager: {}
+  - name: Should set dnsConfig provider to ClusterProvided if not specified
+    initial: |
+      apiVersion: config.openshift.io/v1
+      kind: Infrastructure
+      spec: 
+        platformSpec:
+          aws: {}
+          type: AWS
+    updated: |
+      apiVersion: config.openshift.io/v1
+      kind: Infrastructure
+      spec: 
+        platformSpec:
+          aws: {}
+          type: AWS
+      status:
+        platform: AWS
+        platformStatus:
+          aws: {}
+          type: AWS
+    expected: |
+      apiVersion: config.openshift.io/v1
+      kind: Infrastructure
+      spec: 
+        platformSpec:
+          aws: {}
+          type: AWS
+      status:
+        controlPlaneTopology: HighlyAvailable
+        cpuPartitioning: None
+        infrastructureTopology: HighlyAvailable
+        platform: AWS
+        platformStatus:
+          aws:
+            dnsConfig: {}
+          type: AWS
diff --git a/config/v1/types_feature.go b/config/v1/types_feature.go
@@ -187,6 +187,7 @@ var FeatureSets = map[FeatureSet]*FeatureGateEnabledDisabled{
 		with(automatedEtcdBackup).
 		without(machineAPIOperatorDisableMachineHealthCheckController).
 		with(adminNetworkPolicy).
+		with(customDNSAWS).
 		toFeatures(defaultFeatures),
 	LatencySensitive: newDefaultFeatures().
 		toFeatures(defaultFeatures),

diff --git a/config/v1/types_infrastructure.go b/config/v1/types_infrastructure.go
@@ -478,6 +478,13 @@ type AWSPlatformStatus struct {
 	// +kubebuilder:validation:MaxItems=25
 	// +optional
 	ResourceTags []AWSResourceTag `json:"resourceTags,omitempty"`
+
+	// dnsConfig contains information about the type of DNS solution in use
+	// for the cluster and its related configuration.
+	// +default={"provider": "ClusterProvided"}
+	// +kubebuilder:default={"provider": "ClusterProvided"}
+	// +openshift:enable:FeatureSets=TechPreviewNoUpgrade
+	DNSConfig *DNSConfigurationType `json:"dnsConfig"`
 }
 
 // AWSResourceTag is a tag to apply to AWS resources created for the cluster.
@@ -500,6 +507,38 @@ type AWSResourceTag struct {
 	Value string `json:"value"`
 }
 
+// DNSConfigurationType contains information about API and API-Int Load Balancers
+// and who is responsible for that configuration.
+// +union
+type DNSConfigurationType struct {
+	// provider determines which DNS solution is in use for this cluster.
+	// When the user wants to use their own DNS solution, the `provider` is set to
+	// "UserProvided". In this state, the user is expected to pre-create the Load
+	// Balancers for API and API-Int. The names of these pre-created Load Balancers
+	// are saved.
+	// When the cluster is resposible for its own DNS configuration, this field is
+	// set to "ClusterProvided". The Load Balancers are also created by the cluster.
+	// The default is "ClusterProvided".
+	// +default="ClusterProvided"
+	// +kubebuilder:default:="ClusterProvided"
+	// +kubebuilder:validation:Enum="UserProvided";"ClusterProvided"
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="oldSelf == '' || self == oldSelf",message="type is immutable once set"
+	// +unionDiscriminator
+	Provider DNSProviderType `json:"provider,omitempty"`
+}
+
+// DNSProviderType defines the source of the DNS and LB configuration.
+type DNSProviderType string
+
+const (
+	// DNSUserProvided indicates that the user provides the LB and DNS for API and API-Int.
+	DNSUserProvided DNSProviderType = "UserProvided"
+
+	// DNSClusterProvided indicates that the cluster provides the LB and DNS for API and API-Int.
+	DNSClusterProvided DNSProviderType = "ClusterProvided"
+)
+
 // AzurePlatformSpec holds the desired state of the Azure infrastructure provider.
 // This only includes fields that can be modified in the cluster.
 type AzurePlatformSpec struct{}

diff --git a/config/v1/zz_generated.deepcopy.go b/config/v1/zz_generated.deepcopy.go
diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
diff --git a/openapi/openapi.json b/openapi/openapi.json
@@ -4167,9 +4167,17 @@
       "description": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.",
       "type": "object",
       "required": [
-        "region"
+        "region",
+        "dnsConfig"
       ],
       "properties": {
+        "dnsConfig": {
+          "description": "dnsConfig contains information about the type of DNS solution in use for the cluster and its related configuration.",
+          "default": {
+            "provider": "ClusterProvided"
+          },
+          "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSConfigurationType"
+        },
         "region": {
           "description": "region holds the default AWS region for new AWS resources created by the cluster.",
           "type": "string",
@@ -5712,6 +5720,23 @@
         }
       }
     },
+    "com.github.openshift.api.config.v1.DNSConfigurationType": {
+      "description": "DNSConfigurationType contains information about API and API-Int Load Balancers and who is responsible for that configuration.",
+      "type": "object",
+      "properties": {
+        "provider": {
+          "description": "provider determines which DNS solution is in use for this cluster. When the user wants to use their own DNS solution, the `provider` is set to \"UserProvided\". In this state, the user is expected to pre-create the Load Balancers for API and API-Int. The names of these pre-created Load Balancers are saved. When the cluster is resposible for its own DNS configuration, this field is set to \"ClusterProvided\". The Load Balancers are also created by the cluster. The default is \"ClusterProvided\".",
+          "type": "string",
+          "default": "ClusterProvided"
+        }
+      },
+      "x-kubernetes-unions": [
+        {
+          "discriminator": "provider",
+          "fields-to-discriminateBy": {}
+        }
+      ]
+    },
     "com.github.openshift.api.config.v1.DNSList": {
       "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
       "type": "object",