Merge pull request #592 from mouellet/cluster-sync-nodes-ref

Add `nodes` attribute reference to `rancher2_cluster_sync` resource

Author: rawmind0

CHANGELOG.md

@@ -14,6 +14,7 @@ ENHANCEMENTS:
 * Updated `rancher2_node_template.openstack_config` to support `boot_from_volume` and related arguments
 * Added `password` as valid `cluster_template_questions` type to `rancher2_cluster` resource
 * Preserve `cluster_template_answers` for `cluster_template_questions` of type `password` in `rancher2_cluster` resource to avoid misleading diffs
+* Added `nodes` attribute reference to `rancher2_cluster_sync` resource
 
 BUG FIXES:
 

docs/resources/cluster_sync.md

@@ -98,8 +98,40 @@ The following attributes are exported:
 * `id` - (Computed) The ID of the resource. Same as `cluster_id` (string)
 * `default_project_id` - (Computed) Default project ID for the cluster sync (string)
 * `kube_config` - (Computed/Sensitive) Kube Config generated for the cluster sync (string)
+* `nodes` - (Computed) The cluster nodes (list).
 * `system_project_id` - (Computed) System project ID for the cluster sync (string)
 
+## Nested blocks
+
+### `nodes`
+
+#### Arguments
+
+* `annotations` - (Computed) Annotations of the node (map).
+* `capacity` - (Computed) The total resources of a node (map).
+* `cluster_id` - (Computed) The Cluster ID of the node (string).
+* `external_ip_address` - (Computed)  The external IP address of the node (string).
+* `hostname` - (Computed) The hostname of the node (string).
+* `id` - (Computed) The ID of the node (string)
+* `ip_address` - (Computed) The private IP address of the node (string).
+* `labels` - (Computed) Labels of the node (map).
+* `name` - (Computed) The name of the node (string).
+* `node_pool_id` - (Computed) The Node Pool ID of the node (string).
+* `node_template_id` - (Computed) The Node Template ID of the node (string).
+* `provider_id` - (Computed) The Provider ID of the node (string).
+* `requested_hostname` - (Computed) The requested hostname (string).
+* `roles` - (Computed) Roles of the node. `controlplane`, `etcd` and `worker`. (list)
+* `ssh_user` - (Computed/Sensitive) The user to connect to the node (string).
+* `system_info` - (Computed) General information about the node, such as kernel version, kubelet and kube-proxy version, Docker version (if used), and OS name.
+
+### `system_info`
+
+* `container_runtime_version` - (Computed) ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
+* `kernel_version` - (Computed) Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
+* `kube_proxy_version` - (Computed) KubeProxy Version reported by the node.
+* `kubelet_version` - (Computed) Kubelet Version reported by the node.
+* `operating_system` - (Computed) The Operating System reported by the node.
+
 ## Timeouts
 
 `rancher2_cluster_sync` provides the following

rancher2/config.go

@@ -596,6 +596,27 @@ func (c *Config) GetClusterSpecialProjectsID(id string) (string, string, error)
 	return defaultProjectID, systemProjectID, nil
 }
 
+func (c *Config) GetClusterNodes(id string) ([]managementClient.Node, error) {
+	if id == "" {
+		return nil, fmt.Errorf("[ERROR] Cluster id is nil")
+	}
+
+	client, err := c.ManagementClient()
+	if err != nil {
+		return nil, err
+	}
+
+	filters := map[string]interface{}{"clusterId": id}
+	listOpts := NewListOpts(filters)
+
+	collection, err := client.Node.List(listOpts)
+	if err != nil {
+		return nil, err
+	}
+
+	return collection.Data, nil
+}
+
 func (c *Config) GetClusterByName(name string) (*managementClient.Cluster, error) {
 	if name == "" {
 		return nil, fmt.Errorf("[ERROR] Cluster name is nil")

rancher2/resource_rancher2_cluster_sync.go

@@ -112,6 +112,11 @@ func resourceRancher2ClusterSyncRead(d *schema.ResourceData, meta interface{}) e
 			return err
 		}
 		d.Set("kube_config", kubeConfig.Config)
+		nodes, err := meta.(*Config).GetClusterNodes(clusterID)
+		if err != nil {
+			return err
+		}
+		d.Set("nodes", flattenClusterNodes(nodes))
 	}
 
 	d.Set("synced", active)

rancher2/schema_cluster_sync.go

@@ -36,6 +36,13 @@ func clusterSyncFields() map[string]*schema.Schema {
 				Type: schema.TypeString,
 			},
 		},
+		"nodes": {
+			Type:     schema.TypeList,
+			Computed: true,
+			Elem: &schema.Resource{
+				Schema: clusterNodeFields(),
+			},
+		},
 		"synced": {
 			Type:     schema.TypeBool,
 			Optional: true,
@@ -58,3 +65,75 @@ func clusterSyncFields() map[string]*schema.Schema {
 
 	return s
 }
+
+func clusterNodeFields() map[string]*schema.Schema {
+	s := map[string]*schema.Schema{
+
+		"capacity": {
+			Type:     schema.TypeMap,
+			Computed: true,
+		},
+		"cluster_id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"external_ip_address": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"hostname": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"ip_address": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"name": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"node_pool_id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"node_template_id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"provider_id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"requested_hostname": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+		"roles": {
+			Type:     schema.TypeList,
+			Computed: true,
+			Elem: &schema.Schema{
+				Type: schema.TypeString,
+			},
+		},
+		"ssh_user": {
+			Type:      schema.TypeString,
+			Computed:  true,
+			Sensitive: true,
+		},
+		"system_info": {
+			Type:     schema.TypeMap,
+			Computed: true,
+		},
+	}
+
+	for k, v := range commonAnnotationLabelFields() {
+		s[k] = v
+	}
+
+	return s
+}

rancher2/structure_cluster.go

@@ -254,6 +254,64 @@ func readPreservedClusterTemplateAnswers(d *schema.ResourceData) map[string]stri
 	return preservedAnswers
 }
 
+func flattenClusterNodes(in []managementClient.Node) []interface{} {
+	if len(in) == 0 {
+		return []interface{}{}
+	}
+	out := make([]interface{}, len(in))
+	for i, in := range in {
+		obj := make(map[string]interface{})
+
+		obj["annotations"] = toMapInterface(in.Annotations)
+		obj["capacity"] = toMapInterface(in.Capacity)
+		obj["cluster_id"] = in.ClusterID
+		obj["external_ip_address"] = in.ExternalIPAddress
+		obj["hostname"] = in.Hostname
+		obj["id"] = in.ID
+		obj["ip_address"] = in.IPAddress
+		obj["labels"] = toMapInterface(in.Labels)
+		obj["name"] = in.NodeName
+		obj["node_pool_id"] = in.NodePoolID
+		obj["node_template_id"] = in.NodeTemplateID
+		obj["provider_id"] = in.ProviderId
+		obj["requested_hostname"] = in.RequestedHostname
+		obj["ssh_user"] = in.SshUser
+		obj["system_info"] = flattenNodeInfo(in.Info)
+
+		var roles []string
+		if in.ControlPlane {
+			roles = append(roles, "control_plane")
+		}
+		if in.Etcd {
+			roles = append(roles, "etcd")
+		}
+		if in.Worker {
+			roles = append(roles, "worker")
+		}
+		obj["roles"] = roles
+
+		out[i] = obj
+	}
+
+	return out
+}
+
+func flattenNodeInfo(in *managementClient.NodeInfo) map[string]string {
+	out := make(map[string]string)
+
+	if in == nil {
+		return map[string]string{}
+	}
+
+	out["kube_proxy_version"] = in.Kubernetes.KubeProxyVersion
+	out["kubelet_version"] = in.Kubernetes.KubeletVersion
+	out["container_runtime_version"] = in.OS.DockerVersion
+	out["kernel_version"] = in.OS.KernelVersion
+	out["operating_system"] = in.OS.OperatingSystem
+
+	return out
+}
+
 // Expanders
 
 func expandClusterRegistationToken(p []interface{}, clusterID string) (*managementClient.ClusterRegistrationToken, error) {

rancher2/structure_cluster_test.go

@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/rancher/norman/types"
 	managementClient "github.com/rancher/rancher/pkg/client/generated/management/v3"
 )
 
@@ -650,3 +651,114 @@ func TestReadPreservedClusterTemplateAnswers(t *testing.T) {
 			expectedOutput, result)
 	}
 }
+
+func TestFlattenClusterNodes(t *testing.T) {
+
+	testClusterNodes := []managementClient.Node{
+		{
+			Resource: types.Resource{
+				ID: "id",
+			},
+			Annotations: map[string]string{
+				"node_one": "one",
+				"node_two": "two",
+			},
+			ClusterID: "cluster_id",
+			Capacity: map[string]string{
+				"cpu":    "4",
+				"memory": "8156056Ki",
+				"pods":   "110",
+			},
+			ControlPlane:      true,
+			Etcd:              true,
+			ExternalIPAddress: "172.18.0.5",
+			Hostname:          "hostname",
+			IPAddress:         "172.18.0.5",
+			Info: &managementClient.NodeInfo{
+				CPU: &managementClient.CPUInfo{
+					Count: 4,
+				},
+				Kubernetes: &managementClient.KubernetesInfo{
+					KubeProxyVersion: "v1.19.7",
+					KubeletVersion:   "v1.19.7",
+				},
+				Memory: &managementClient.MemoryInfo{
+					MemTotalKiB: 8156056,
+				},
+				OS: &managementClient.OSInfo{
+					DockerVersion:   "containerd://1.4.3",
+					KernelVersion:   "4.19.121",
+					OperatingSystem: "Unknown",
+				},
+			},
+			Labels: map[string]string{
+				"option1": "value1",
+				"option2": "value2",
+			},
+			Name:              "name",
+			NodeName:          "node_name",
+			NodePoolID:        "node_pool_id",
+			NodeTemplateID:    "node_template_id",
+			ProviderId:        "provider_id",
+			RequestedHostname: "requested_hostname",
+			SshUser:           "ssh_user",
+			Worker:            true,
+		},
+	}
+
+	testClusterNodesInterface := []interface{}{
+		map[string]interface{}{
+			"id": "id",
+			"annotations": map[string]interface{}{
+				"node_one": "one",
+				"node_two": "two",
+			},
+			"capacity": map[string]interface{}{
+				"cpu":    "4",
+				"memory": "8156056Ki",
+				"pods":   "110",
+			},
+			"cluster_id":          "cluster_id",
+			"external_ip_address": "172.18.0.5",
+			"hostname":            "hostname",
+			"ip_address":          "172.18.0.5",
+			"system_info": map[string]string{
+				"kube_proxy_version":        "v1.19.7",
+				"kubelet_version":           "v1.19.7",
+				"container_runtime_version": "containerd://1.4.3",
+				"kernel_version":            "4.19.121",
+				"operating_system":          "Unknown",
+			},
+			"labels": map[string]interface{}{
+				"option1": "value1",
+				"option2": "value2",
+			},
+			"name":               "node_name",
+			"node_pool_id":       "node_pool_id",
+			"node_template_id":   "node_template_id",
+			"provider_id":        "provider_id",
+			"roles":              []string{"control_plane", "etcd", "worker"},
+			"requested_hostname": "requested_hostname",
+			"ssh_user":           "ssh_user",
+		},
+	}
+
+	cases := []struct {
+		Input          []managementClient.Node
+		ExpectedOutput []interface{}
+	}{
+		{
+			Input:          testClusterNodes,
+			ExpectedOutput: testClusterNodesInterface,
+		},
+	}
+
+	for _, tc := range cases {
+		output := flattenClusterNodes(tc.Input)
+		if !reflect.DeepEqual(output, tc.ExpectedOutput) {
+			t.Fatalf("Unexpected output from flattener.\nExpected: %#v\nGiven:    %#v",
+				tc.ExpectedOutput, output)
+		}
+	}
+
+}