Merge pull request #34 from dataiku/feature/dss13-sc-194130-gke-support-channel-for-standard-cluster

Adding support for release channels on standard clusters and cluster versions on autopilot clusters

Author: vrutz

python-clusters/create-gke-cluster/cluster.json

@@ -18,25 +18,50 @@
             "parameterSetId" : "connection-info",
             "mandatory" : true
         },
-        {
-            "name": "clusterVersion",
-            "label": "Kubernetes version",
-            "type": "STRING",
-            "defaultValue": "latest",
-            "visibilityCondition": "!model.isAutopilot"
-        },
         {
             "name": "releaseChannel",
             "label": "Release Channel",
             "type": "SELECT",
             "defaultValue": "STABLE",
             "selectChoices": [
-                {"label":"Stable", "value":"STABLE"},
-                {"label":"Regular", "value":"REGULAR"},
-                {"label":"Rapid", "value":"RAPID"}
+                { "label": "Stable", "value": "STABLE" },
+                { "label": "Regular", "value": "REGULAR" },
+                { "label": "Rapid", "value": "RAPID" }
             ],
+            "description": "Find more information on the release channels here: https://cloud.google.com/kubernetes-engine/docs/concepts/release-channels",
             "visibilityCondition": "model.isAutopilot"
         },
+        {
+            "name": "releaseChannelEnrollment",
+            "label": "Enroll into a release channel",
+            "type": "BOOLEAN",
+            "defaultValue": true,
+            "description": "Whether the cluster should be enrolled in a release channel (recommended).",
+            "visibilityCondition": "!model.isAutopilot"
+        },
+        {
+            "name": "standardReleaseChannel",
+            "label": "Release Channel",
+            "type": "SELECT",
+            "defaultValue": "DEFAULT",
+            "selectChoices": [
+                { "label": "Default (recommended)", "value": "DEFAULT" },
+                { "label": "Stable", "value": "STABLE" },
+                { "label": "Regular", "value": "REGULAR" },
+                { "label": "Rapid", "value": "RAPID" },
+                { "label": "Extended", "value": "EXTENDED" }
+            ],
+            "description": "Default will enroll you in the most stable channel for the version you have selected.\nIf you have defined 'latest' for your cluster version, you will be enrolled in the 'Regular' channel.\nFind more information on the release channels here: https://cloud.google.com/kubernetes-engine/docs/concepts/release-channels",
+            "visibilityCondition": "!model.isAutopilot && model.releaseChannelEnrollment"
+        },
+        {
+            "name": "clusterVersion",
+            "label": "Kubernetes version",
+            "type": "STRING",
+            "defaultValue": "latest",
+            "description": "Defaults to the latest version of the configured release channel (or if not enrolled, to a default version in the Regular channel). Find more information on the available versions here: https://cloud.google.com/kubernetes-engine/docs/release-notes",
+            "visibilityCondition": "!model.isAutopilot"
+        },
         {
             "name": "isRegional",
             "label": "Regional",

python-clusters/create-gke-cluster/cluster.py

@@ -32,10 +32,15 @@ def start(self):
         cluster_builder.with_name(self.cluster_name)
         if is_autopilot:
             cluster_builder.with_regional(True, []) # autopilot => regional
-            cluster_builder.with_autopilot(True, self.config.get("releaseChannel", "STABLE"))
+            cluster_builder.with_autopilot(True)
+            cluster_builder.with_release_channel(self.config.get("releaseChannel", "STABLE"))
         else:
             cluster_builder.with_version(self.config.get("clusterVersion", "latest"))
+            cluster_builder.with_release_channel_enrollment(self.config.get("releaseChannelEnrollment", True))
+            cluster_builder.with_release_channel(self.config.get("standardReleaseChannel", "DEFAULT"))
             cluster_builder.with_initial_node_count(self.config.get("numNodes", 3))
+
+
         cluster_builder.with_network(self.config.get("inheritFromDSSHost", True),
                                      self.config.get("network", "").strip(),
                                      self.config.get("subNetwork", "").strip())

python-lib/dku_google/clusters.py

@@ -210,6 +210,7 @@ def __init__(self, clusters):
         self.locations = []
         self.is_autopilot = False
         self.release_channel = 'STABLE'
+        self.release_channel_enrollment = True
         self.settings_valve = None
 
     def with_name(self, name):
@@ -220,11 +221,18 @@ def with_version(self, version):
         self.version = version
         return self
 
-    def with_autopilot(self, is_autopilot, release_channel):
+    def with_autopilot(self, is_autopilot):
         self.is_autopilot = is_autopilot
-        self.release_channel = release_channel
         return self
 
+    def with_release_channel(self, release_channel):
+        self.release_channel = release_channel
+        return self
+
+    def with_release_channel_enrollment(self, release_channel_enrollment):
+        self.release_channel_enrollment = release_channel_enrollment
+        return self
+
     def with_regional(self, is_regional, locations=[]):
         self.is_regional = is_regional
         self.locations = locations
@@ -347,8 +355,18 @@ def build(self):
 
         if self.is_autopilot:
             create_cluster_request_body['cluster']['autopilot'] = {"enabled":True}
-            create_cluster_request_body['cluster']['releaseChannel'] = {"channel":self.release_channel}
-            
+
+        if not self.is_autopilot and not self.release_channel_enrollment:
+            # We can prevent the cluster from being enrolled into a release channel by not specifying the channel to enroll into.
+            # However, the release channel object must be specified otherwise the cluster will be enrolled into the most stable release channel that supports the cluster version.
+            # Note that autopilot clusters must be enrolled into either of the Rapid, Regular or Stable release channels (Extended not supported)
+            create_cluster_request_body['cluster']['releaseChannel'] = {}
+        elif self.release_channel != "DEFAULT":
+            # Specify the release channel to enroll into.
+            # If the channel is default (only possible with standard clusters),
+            # the cluster will be automatically enrolled in the most stable channel possible for the defined cluster version (Regular if the version is 'latest')
+            create_cluster_request_body['cluster']['releaseChannel'] = {"channel": self.release_channel}
+
         if not _is_none_or_blank(self.settings_valve):
             valve = json.loads(self.settings_valve)
             create_cluster_request_body["cluster"] = _merge_objects(create_cluster_request_body["cluster"], valve)