feat(kubernetes): node group utility network access (#247)

villevsv-upcloud · web-flow · commit a104d774b53a · 2023-07-14T16:17:29.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,8 @@ See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - client functions `NewDefaultHTTPClient` and `NewDefaultHTTPTransport` to provide HTTP client default properties
 - kubernetes: experimental support for deleting nodes from node groups
-- kubernetes: consts for `scaling-up` and `scaling-down` node-group states
+- kubernetes: consts for `scaling-up` and `scaling-down` node group states
+- kubernetes: `utility_network_access` field to node group for configuring utility network access on the given group
 
 ### Changed
 - `service.GetKubernetesNodeGroup` method to return `upcloud.KubernetesNodeGroupDetails` type which is extended version of the previous `upcloud.KubernetesNodeGroup`
diff --git a/upcloud/kubernetes.go b/upcloud/kubernetes.go
@@ -48,16 +48,17 @@ type KubernetesCluster struct {
 }
 
 type KubernetesNodeGroup struct {
-	AntiAffinity bool                     `json:"anti_affinity,omitempty"`
-	Count        int                      `json:"count,omitempty"`
-	KubeletArgs  []KubernetesKubeletArg   `json:"kubelet_args,omitempty"`
-	Labels       []Label                  `json:"labels,omitempty"`
-	Name         string                   `json:"name,omitempty"`
-	Plan         string                   `json:"plan,omitempty"`
-	SSHKeys      []string                 `json:"ssh_keys,omitempty"`
-	State        KubernetesNodeGroupState `json:"state,omitempty"`
-	Storage      string                   `json:"storage,omitempty"`
-	Taints       []KubernetesTaint        `json:"taints,omitempty"`
+	AntiAffinity         bool                     `json:"anti_affinity,omitempty"`
+	Count                int                      `json:"count,omitempty"`
+	KubeletArgs          []KubernetesKubeletArg   `json:"kubelet_args,omitempty"`
+	Labels               []Label                  `json:"labels,omitempty"`
+	Name                 string                   `json:"name,omitempty"`
+	Plan                 string                   `json:"plan,omitempty"`
+	SSHKeys              []string                 `json:"ssh_keys,omitempty"`
+	State                KubernetesNodeGroupState `json:"state,omitempty"`
+	Storage              string                   `json:"storage,omitempty"`
+	Taints               []KubernetesTaint        `json:"taints,omitempty"`
+	UtilityNetworkAccess bool                     `json:"utility_network_access,omitempty"`
 }
 
 type KubernetesNodeGroupDetails struct {
diff --git a/upcloud/kubernetes_test.go b/upcloud/kubernetes_test.go
@@ -42,7 +42,8 @@ const exampleKubernetesClusterJSON string = `{
 					"value": "sometaintvalue"
 				}
 			],
-			"ssh_keys": ["somekey"]
+			"ssh_keys": ["somekey"],
+			"utility_network_access": true
 		},
 		{
 			"name": "upcloud-go-sdk-unit-test",
@@ -68,7 +69,8 @@ const exampleKubernetesClusterJSON string = `{
 					"value": "sometaintvalue"
 				}
 			],
-			"ssh_keys": ["somekey"]
+			"ssh_keys": ["somekey"],
+			"utility_network_access": true
 		}
 	]
 }`
@@ -189,6 +191,7 @@ func exampleKubernetesNodeGroup(antiAffinity bool) KubernetesNodeGroup {
 				Value:  "sometaintvalue",
 			},
 		},
-		SSHKeys: []string{"somekey"},
+		SSHKeys:              []string{"somekey"},
+		UtilityNetworkAccess: true,
 	}
 }
diff --git a/upcloud/request/kubernetes.go b/upcloud/request/kubernetes.go
@@ -116,15 +116,16 @@ func (r *GetKubernetesNodeGroupRequest) RequestURL() string {
 }
 
 type KubernetesNodeGroup struct {
-	Count        int                            `json:"count,omitempty"`
-	Labels       []upcloud.Label                `json:"labels,omitempty"`
-	Name         string                         `json:"name,omitempty"`
-	Plan         string                         `json:"plan,omitempty"`
-	SSHKeys      []string                       `json:"ssh_keys,omitempty"`
-	Storage      string                         `json:"storage,omitempty"`
-	KubeletArgs  []upcloud.KubernetesKubeletArg `json:"kubelet_args,omitempty"`
-	Taints       []upcloud.KubernetesTaint      `json:"taints,omitempty"`
-	AntiAffinity bool                           `json:"anti_affinity,omitempty"`
+	Count                int                            `json:"count,omitempty"`
+	Labels               []upcloud.Label                `json:"labels,omitempty"`
+	Name                 string                         `json:"name,omitempty"`
+	Plan                 string                         `json:"plan,omitempty"`
+	SSHKeys              []string                       `json:"ssh_keys,omitempty"`
+	Storage              string                         `json:"storage,omitempty"`
+	KubeletArgs          []upcloud.KubernetesKubeletArg `json:"kubelet_args,omitempty"`
+	Taints               []upcloud.KubernetesTaint      `json:"taints,omitempty"`
+	AntiAffinity         bool                           `json:"anti_affinity,omitempty"`
+	UtilityNetworkAccess *bool                          `json:"utility_network_access,omitempty"`
 }
 
 type CreateKubernetesNodeGroupRequest struct {
diff --git a/upcloud/request/kubernetes_test.go b/upcloud/request/kubernetes_test.go
@@ -36,12 +36,42 @@ const exampleCreateKubernetesClusterRequestJSON string = `{
 					"value": "sometaintvalue"
 				}
 			],
-			"name": "name",
+			"name": "withExplicitUtilityTrue",
 			"plan": "plan",
 			"ssh_keys": [
 				"key",
 				"key"
-			]
+			],
+			"utility_network_access": true
+		},
+		{
+			"count": 1,
+			"labels": [
+				{
+					"key": "managedBy",
+					"value": "upcloud-go-sdk-unit-test"
+				}
+			],
+			"kubelet_args": [
+				{
+					"key": "somekubeletkey",
+					"value": "somekubeletvalue"
+				}
+			],
+			"taints": [
+				{
+					"effect": "NoExecute",
+					"key": "sometaintkey",
+					"value": "sometaintvalue"
+				}
+			],
+			"name": "withExplicitUtilityFalse",
+			"plan": "plan",
+			"ssh_keys": [
+				"key",
+				"key"
+			],
+			"utility_network_access": false
 		},
 		{
 			"count": 1,
@@ -64,7 +94,7 @@ const exampleCreateKubernetesClusterRequestJSON string = `{
 					"value": "sometaintvalue"
 				}
 			],
-			"name": "name",
+			"name": "withoutExplicitUtility",
 			"plan": "plan",
 			"ssh_keys": [
 				"key",
@@ -347,7 +377,7 @@ func TestDeleteKubernetesNodeGroupRequest(t *testing.T) {
 
 func exampleGetKubernetesClustersWithFiltersRequest() GetKubernetesClustersWithFiltersRequest {
 	return GetKubernetesClustersWithFiltersRequest{
-		Filters: []KubernetesFilter{
+		Filters: []QueryFilter{
 			FilterLabelKey{"managedBy"},
 			FilterLabel{Label: upcloud.Label{
 				Key:   "managedBy",
@@ -363,17 +393,18 @@ func exampleCreateKubernetesClusterRequest() CreateKubernetesClusterRequest {
 		Network:     "00000000-0000-0000-0000-000000000000",
 		NetworkCIDR: "172.16.0.1/24",
 		NodeGroups: []KubernetesNodeGroup{
-			exampleKubernetesNodeGroup(),
-			exampleKubernetesNodeGroup(),
+			exampleKubernetesNodeGroup("withExplicitUtilityTrue", upcloud.BoolPtr(true)),
+			exampleKubernetesNodeGroup("withExplicitUtilityFalse", upcloud.BoolPtr(false)),
+			exampleKubernetesNodeGroup("withoutExplicitUtility", nil),
 		},
 		Zone:              "zone",
 		Plan:              "production",
 		PrivateNodeGroups: false,
 	}
 }
 
-func exampleKubernetesNodeGroup() KubernetesNodeGroup {
-	return KubernetesNodeGroup{
+func exampleKubernetesNodeGroup(name string, utilityNetworkAccess *bool) KubernetesNodeGroup {
+	ng := KubernetesNodeGroup{
 		Count: 1,
 		Labels: []upcloud.Label{
 			{
@@ -394,11 +425,17 @@ func exampleKubernetesNodeGroup() KubernetesNodeGroup {
 				Value:  "sometaintvalue",
 			},
 		},
-		Name: "name",
+		Name: name,
 		Plan: "plan",
 		SSHKeys: []string{
 			"key",
 			"key",
 		},
 	}
+
+	if utilityNetworkAccess != nil {
+		ng.UtilityNetworkAccess = utilityNetworkAccess
+	}
+
+	return ng
 }
diff --git a/upcloud/service/kubernetes.go b/upcloud/service/kubernetes.go
@@ -26,19 +26,19 @@ type Kubernetes interface {
 	GetKubernetesPlans(ctx context.Context, r *request.GetKubernetesPlansRequest) ([]upcloud.KubernetesPlan, error)
 }
 
-// GetKubernetesClusters retrieves a list of Kubernetes clusters (EXPERIMENTAL).
+// GetKubernetesClusters retrieves a list of Kubernetes clusters.
 func (s *Service) GetKubernetesClusters(ctx context.Context, r *request.GetKubernetesClustersRequest) ([]upcloud.KubernetesCluster, error) {
 	clusters := make([]upcloud.KubernetesCluster, 0)
 	return clusters, s.get(ctx, r.RequestURL(), &clusters)
 }
 
-// GetKubernetesCluster retrieves details of a Kubernetes cluster (EXPERIMENTAL).
+// GetKubernetesCluster retrieves details of a Kubernetes cluster.
 func (s *Service) GetKubernetesCluster(ctx context.Context, r *request.GetKubernetesClusterRequest) (*upcloud.KubernetesCluster, error) {
 	kubernetesCluster := upcloud.KubernetesCluster{}
 	return &kubernetesCluster, s.get(ctx, r.RequestURL(), &kubernetesCluster)
 }
 
-// CreateKubernetesCluster creates a new Kubernetes cluster (EXPERIMENTAL).
+// CreateKubernetesCluster creates a new Kubernetes cluster.
 func (s *Service) CreateKubernetesCluster(ctx context.Context, r *request.CreateKubernetesClusterRequest) (*upcloud.KubernetesCluster, error) {
 	if r == nil || len(r.Network) == 0 {
 		return nil, fmt.Errorf("bad request")
@@ -57,7 +57,7 @@ func (s *Service) CreateKubernetesCluster(ctx context.Context, r *request.Create
 	return &cluster, s.create(ctx, r, &cluster)
 }
 
-// DeleteKubernetesCluster deletes an existing Kubernetes cluster (EXPERIMENTAL).
+// DeleteKubernetesCluster deletes an existing Kubernetes cluster.
 func (s *Service) DeleteKubernetesCluster(ctx context.Context, r *request.DeleteKubernetesClusterRequest) error {
 	return s.delete(ctx, r)
 }
@@ -91,7 +91,7 @@ func (s *Service) WaitForKubernetesClusterState(ctx context.Context, r *request.
 	}
 }
 
-// GetKubernetesKubeconfig retrieves kubeconfig of a Kubernetes cluster (EXPERIMENTAL).
+// GetKubernetesKubeconfig retrieves kubeconfig of a Kubernetes cluster.
 func (s *Service) GetKubernetesKubeconfig(ctx context.Context, r *request.GetKubernetesKubeconfigRequest) (string, error) {
 	// TODO: should timeout be part of GetKubernetesKubeconfigRequest ?
 	const timeout time.Duration = 10 * time.Minute
@@ -112,47 +112,47 @@ func (s *Service) GetKubernetesKubeconfig(ctx context.Context, r *request.GetKub
 	return data.Kubeconfig, err
 }
 
-// GetKubernetesVersions retrieves a list of Kubernetes cluster versions (EXPERIMENTAL).
+// GetKubernetesVersions retrieves a list of Kubernetes cluster versions.
 func (s *Service) GetKubernetesVersions(ctx context.Context, r *request.GetKubernetesVersionsRequest) ([]string, error) {
 	versions := make([]string, 0)
 	return versions, s.get(ctx, r.RequestURL(), &versions)
 }
 
-// GetKubernetesNodeGroups retrieves a list of Kubernetes cluster node groups (EXPERIMENTAL).
+// GetKubernetesNodeGroups retrieves a list of Kubernetes cluster node groups.
 func (s *Service) GetKubernetesNodeGroups(ctx context.Context, r *request.GetKubernetesNodeGroupsRequest) ([]upcloud.KubernetesNodeGroup, error) {
 	ng := make([]upcloud.KubernetesNodeGroup, 0)
 	return ng, s.get(ctx, r.RequestURL(), &ng)
 }
 
-// GetKubernetesNodeGroup retrieves details of a node group (EXPERIMENTAL).
+// GetKubernetesNodeGroup retrieves details of a node group.
 func (s *Service) GetKubernetesNodeGroup(ctx context.Context, r *request.GetKubernetesNodeGroupRequest) (*upcloud.KubernetesNodeGroupDetails, error) {
 	ng := upcloud.KubernetesNodeGroupDetails{}
 	return &ng, s.get(ctx, r.RequestURL(), &ng)
 }
 
-// CreateKubernetesNodeGroup creates a new node group (EXPERIMENTAL).
+// CreateKubernetesNodeGroup creates a new node group.
 func (s *Service) CreateKubernetesNodeGroup(ctx context.Context, r *request.CreateKubernetesNodeGroupRequest) (*upcloud.KubernetesNodeGroup, error) {
 	ng := upcloud.KubernetesNodeGroup{}
 	return &ng, s.create(ctx, r, &ng)
 }
 
-// ModifyKubernetesNodeGroup modifies an existing node group (EXPERIMENTAL).
+// ModifyKubernetesNodeGroup modifies an existing node group.
 func (s *Service) ModifyKubernetesNodeGroup(ctx context.Context, r *request.ModifyKubernetesNodeGroupRequest) (*upcloud.KubernetesNodeGroup, error) {
 	ng := upcloud.KubernetesNodeGroup{}
 	return &ng, s.modify(ctx, r, &ng)
 }
 
-// DeleteKubernetesNodeGroup deletes an existing node group (EXPERIMENTAL).
+// DeleteKubernetesNodeGroup deletes an existing node group.
 func (s *Service) DeleteKubernetesNodeGroup(ctx context.Context, r *request.DeleteKubernetesNodeGroupRequest) error {
 	return s.delete(ctx, r)
 }
 
-// DeleteKubernetesNodeGroupNode deletes an existing node from the node group (EXPERIMENTAL).
+// DeleteKubernetesNodeGroupNode deletes an existing node from the node group.
 func (s *Service) DeleteKubernetesNodeGroupNode(ctx context.Context, r *request.DeleteKubernetesNodeGroupNodeRequest) error {
 	return s.delete(ctx, r)
 }
 
-// GetKubernetesPlans retrieves a list of Kubernetes plans (EXPERIMENTAL).
+// GetKubernetesPlans retrieves a list of Kubernetes plans.
 func (s *Service) GetKubernetesPlans(ctx context.Context, r *request.GetKubernetesPlansRequest) ([]upcloud.KubernetesPlan, error) {
 	plans := make([]upcloud.KubernetesPlan, 0)
 	return plans, s.get(ctx, r.RequestURL(), &plans)
diff --git a/upcloud/service/kubernetes_test.go b/upcloud/service/kubernetes_test.go
@@ -32,7 +32,8 @@ const exampleClusterResponse = `
 			"anti_affinity": false,
 			"kubelet_args":[],
 			"labels":[],
-			"ssh_keys":[]
+			"ssh_keys":[],
+			"utility_network_access": true
 		},
 		{
 			"name":"my-group2",
@@ -61,7 +62,8 @@ const exampleClusterResponse = `
 			],
 			"ssh_keys":[
 				"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO3fnjc8UrsYDNU8365mL3lnOPQJg18V42Lt8U/8Sm+r testy_test"
-			]
+			],
+			"utility_network_access": false
 		}
 	]
 }
@@ -95,7 +97,8 @@ const exampleNodeGroupResponse = `
 	],
 	"ssh_keys": [
 		"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO3fnjc8UrsYDNU8365mL3lnOPQJg18V42Lt8U/8Sm+r testy_test"
-	]
+	],
+	"utility_network_access": true
 }
 `
 
@@ -117,7 +120,8 @@ const exampleNodeGroupDetailsResponse = `
 			"state": "terminating",
 			"uuid": "00b56302-e211-40d9-83fa-177f0171e75a"
 		}
-	]
+	],
+	"utility_network_access": true
 }`
 
 const exampleNetworkResponse = `
@@ -173,6 +177,7 @@ func TestGetKubernetesClusters(t *testing.T) {
 	assert.Len(t, res[0].NodeGroups[0].Labels, 0)
 	assert.Len(t, res[0].NodeGroups[0].KubeletArgs, 0)
 	assert.Len(t, res[0].NodeGroups[0].Taints, 0)
+	assert.Equal(t, true, res[0].NodeGroups[0].UtilityNetworkAccess)
 
 	// Check second group properties
 	assert.Equal(t, "my-group2", res[0].NodeGroups[1].Name)
@@ -182,6 +187,7 @@ func TestGetKubernetesClusters(t *testing.T) {
 	assert.Len(t, res[0].NodeGroups[1].Labels, 1)
 	assert.Len(t, res[0].NodeGroups[1].KubeletArgs, 1)
 	assert.Len(t, res[0].NodeGroups[1].Taints, 1)
+	assert.Equal(t, false, res[0].NodeGroups[1].UtilityNetworkAccess)
 }
 
 func TestGetKubernetesClusterDetails(t *testing.T) {
@@ -231,11 +237,12 @@ func TestCreateKubernetesCluster(t *testing.T) {
 		Zone:    "de-fra1",
 		NodeGroups: []request.KubernetesNodeGroup{
 			{
-				Name:         "my-group1",
-				Plan:         "2xCPU-4GB",
-				Count:        2,
-				Storage:      "01000000-0000-4000-8000-000160010100",
-				AntiAffinity: false,
+				Name:                 "my-group1",
+				Plan:                 "2xCPU-4GB",
+				Count:                2,
+				Storage:              "01000000-0000-4000-8000-000160010100",
+				AntiAffinity:         false,
+				UtilityNetworkAccess: upcloud.BoolPtr(true),
 			},
 			{
 				Name:         "my-group2",
@@ -265,6 +272,7 @@ func TestCreateKubernetesCluster(t *testing.T) {
 				SSHKeys: []string{
 					"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO3fnjc8UrsYDNU8365mL3lnOPQJg18V42Lt8U/8Sm+r testy_test",
 				},
+				UtilityNetworkAccess: upcloud.BoolPtr(false),
 			},
 		},
 	})
@@ -393,10 +401,12 @@ func TestCreateKubernetesNodeGroup(t *testing.T) {
 			SSHKeys: []string{
 				"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO3fnjc8UrsYDNU8365mL3lnOPQJg18V42Lt8U/8Sm+r testy_test",
 			},
+			UtilityNetworkAccess: upcloud.BoolPtr(true),
 		},
 	})
 	assert.NoError(t, err)
 	assert.Equal(t, "my-test-group", res.Name)
+	assert.Equal(t, true, res.UtilityNetworkAccess)
 }
 
 func TestModifyKubernetesNodeGroup(t *testing.T) {

Original file line number	Diff line number	Diff line change
@@ -42,7 +42,8 @@ const exampleKubernetesClusterJSON string = `{
`42`	`42`	`"value": "sometaintvalue"`
`43`	`43`	`}`
`44`	`44`	`],`
`45`		`- "ssh_keys": ["somekey"]`
	`45`	`+ "ssh_keys": ["somekey"],`
	`46`	`+ "utility_network_access": true`
`46`	`47`	`},`
`47`	`48`	`{`
`48`	`49`	`"name": "upcloud-go-sdk-unit-test",`
@@ -68,7 +69,8 @@ const exampleKubernetesClusterJSON string = `{
`68`	`69`	`"value": "sometaintvalue"`
`69`	`70`	`}`
`70`	`71`	`],`
`71`		`- "ssh_keys": ["somekey"]`
	`72`	`+ "ssh_keys": ["somekey"],`
	`73`	`+ "utility_network_access": true`
`72`	`74`	`}`
`73`	`75`	`]`
`74`	`76`	}`
`@@ -189,6 +191,7 @@ func exampleKubernetesNodeGroup(antiAffinity bool) KubernetesNodeGroup {`
`189`	`191`	`Value: "sometaintvalue",`
`190`	`192`	`},`
`191`	`193`	`},`
`192`		`- SSHKeys: []string{"somekey"},`
	`194`	`+ SSHKeys: []string{"somekey"},`
	`195`	`+ UtilityNetworkAccess: true,`
`193`	`196`	`}`
`194`	`197`	`}`