feat: implement support to nutanix machine config (#2092)

Co-authored-by: Joao Ferraz <joao.ferraz@suse.com>

Author: github-actions[bot]

aspell_custom.txt

@@ -31,3 +31,6 @@ json
 backport
 PDB
 PC
+AuthConfig
+Cognito
+nutanix

docs/resources/cloud_credential.md

@@ -6,7 +6,7 @@ page_title: "rancher2_cloud_credential Resource"
 
 Provides a Rancher v2 Cloud Credential resource. This can be used to create Cloud Credential for Rancher v2.2.x and retrieve their information.
 
-amazonec2, azure, digitalocean, harvester, linode, openstack and vsphere credentials config are supported for Cloud Credential.
+amazonec2, azure, digitalocean, harvester, linode, nutanix, openstack and vsphere credentials config are supported for Cloud Credential.
 
 ## Example Usage
 
@@ -51,6 +51,7 @@ The following arguments are supported:
 * `google_credential_config` - (Optional) Google config for the Cloud Credential (list maxitems:1)
 * `harvester_credential_config` - (Optional) Harvester config for the Cloud Credential (list maxitems:1)
 * `linode_credential_config` - (Optional) Linode config for the Cloud Credential (list maxitems:1)
+* `nutanix_credential_config` - (Optional) Nutanix config for the Cloud Credential (list maxitems:1)
 * `openstack_credential_config` - (Optional) OpenStack config for the Cloud Credential (list maxitems:1)
 * `s3_credential_config` - (Optional) S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)
 * `vsphere_credential_config` - (Optional) vSphere config for the Cloud Credential (list maxitems:1)
@@ -110,6 +111,15 @@ The following attributes are exported:
 
 * `token` - (Required/Sensitive) Linode API token (string)
 
+### `nutanix_credential_config`
+
+#### Arguments
+
+* `endpoint` - (Required) Nutanix management endpoint IP address/FQDN (string)
+* `username` - (Required) Nutanix management username (string)
+* `password` - (Required/Sensitive) Nutanix management password (string)
+* `port` - (Optional) Nutanix management endpoint port. Default `9440` (string)
+
 ### `openstack_credential_config`
 
 #### Arguments
@@ -162,6 +172,7 @@ The following drivers are supported:
 * digitalocean
 * googlekubernetesengine
 * linode
+* nutanix
 * openstack
 * s3
 * vmwarevsphere

docs/resources/cluster_v2.md

@@ -136,6 +136,53 @@ resource "rancher2_cluster_v2" "foo-k3s" {
 }
 ```
 
+### Create a node-driver cluster with Nutanix as the infrastructure provider
+
+```hcl
+# Create Nutanix cloud credential
+resource "rancher2_cloud_credential" "foo_nutanix" {
+  name = "foo-nutanix"
+  nutanix_credential_config {
+    endpoint = "<PRISM_ENDPOINT>"
+    username = "X-ntnx-api-key"
+    password = "<NUTANIX_API_KEY_OR_PASSWORD>"
+    port     = "9440"
+  }
+}
+
+# Create Nutanix machine config v2
+resource "rancher2_machine_config_v2" "foo_nutanix" {
+  generate_name = "foo-nutanix"
+  nutanix_config {
+    cluster    = "<NUTANIX_CLUSTER_NAME>"
+    vm_network = ["<NETWORK_NAME_OR_UUID>"]
+    vm_image   = "<IMAGE_NAME>"
+  }
+}
+
+# Create a cluster using Nutanix machine config and cloud credential
+resource "rancher2_cluster_v2" "foo_nutanix" {
+  name               = "foo-nutanix"
+  kubernetes_version = "<rke2/k3s-version>"
+
+  rke_config {
+    machine_pools {
+      name                         = "pool1"
+      cloud_credential_secret_name = rancher2_cloud_credential.foo_nutanix.id
+      control_plane_role           = true
+      etcd_role                    = true
+      worker_role                  = true
+      quantity                     = 1
+
+      machine_config {
+        kind = rancher2_machine_config_v2.foo_nutanix.kind
+        name = rancher2_machine_config_v2.foo_nutanix.name
+      }
+    }
+  }
+}
+```
+
 ### Create a node-driver cluster with Harvester as the infrastructure provider
 
 ```hcl

docs/resources/machine_config_v2.md

@@ -6,7 +6,7 @@ page_title: "rancher2_machine_config_v2 Resource"
 
 Provides a Rancher v2 Machine config v2 resource. This can be used to create Machine Config v2 for Rancher v2 and retrieve their information. This resource is available from Rancher v2.6.0 and above.
 
-The supported cloud providers includes `amazonec2`, `azure`, `digitalocean`, `harvester`, `linode`, `openstack`, and `vsphere`.
+The supported cloud providers includes `amazonec2`, `azure`, `digitalocean`, `harvester`, `linode`, `nutanix`, `openstack`, and `vsphere`.
 
 
 Starting with Rancher v2.12.0 and above, `google` is also offered as a supported cloud provider.
@@ -90,14 +90,15 @@ The following arguments are supported:
 
 * `generate_name` - (Required/ForceNew) Cluster V2 generate name. The pattern to generate machine config name. e.g  generate_name=\"prod-pool1\" will generate \"nc-prod-pool1-?????\" name computed at `name` attribute (string)
 * `fleet_namespace` - (Optional/ForceNew) Cluster V2 fleet namespace
-* `amazonec2_config` - (Optional) AWS config for the Machine Config V2. Conflicts with `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `azure_config` - (Optional) Azure config for the Machine Config V2. Conflicts with `amazonec2_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `digitalocean_config` - (Optional) Digitalocean config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `harvester_config`, `linode_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `harvester_config` - (Optional) Harvester config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `linode_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `linode_config` - (Optional) Linode config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `openstack_config` - (Optional) Openstack config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `google_config` and `vsphere_config` (list maxitems:1)
-* `vsphere_config` - (Optional) vSphere config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `google_config` and `openstack_config` (list maxitems:1)
-* `google_config` - (Optional) Google config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `openstack_config` and `vsphere_config` (list maxitems:1)
+* `amazonec2_config` - (Optional) AWS config for the Machine Config V2. Conflicts with `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `nutanix_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `azure_config` - (Optional) Azure config for the Machine Config V2. Conflicts with `amazonec2_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `nutanix_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `digitalocean_config` - (Optional) Digitalocean config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `harvester_config`, `linode_config`, `nutanix_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `harvester_config` - (Optional) Harvester config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `linode_config`, `nutanix_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `linode_config` - (Optional) Linode config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `nutanix_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `nutanix_config` - (Optional) Nutanix config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `openstack_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `openstack_config` - (Optional) Openstack config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `nutanix_config`, `google_config` and `vsphere_config` (list maxitems:1)
+* `vsphere_config` - (Optional) vSphere config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `nutanix_config`, `google_config` and `openstack_config` (list maxitems:1)
+* `google_config` - (Optional) Google config for the Machine Config V2. Conflicts with `amazonec2_config`, `azure_config`, `digitalocean_config`, `harvester_config`, `linode_config`, `nutanix_config`, `openstack_config` and `vsphere_config` (list maxitems:1)
 * `annotations` - (Optional) Annotations for Machine Config V2 object (map)
 * `labels` - (Optional/Computed) Labels for Machine Config V2 object (map)
 
@@ -364,6 +365,33 @@ The following attributes are exported:
 * `username` - (Optional) The username to be set when logging into the virtual machines (string)
 * `zone` - (Required) The region and zone to create virtual machines within (e.g. us-east1-b) (string)
 
+### `nutanix_config`
+
+#### Arguments
+
+* `endpoint` - (Optional) Nutanix management endpoint IP address/FQDN. Mandatory if `rancher2_cloud_credential.nutanix_credential_config` is not used (string)
+* `username` - (Optional) Nutanix management username. Use `X-ntnx-api-key` when using Prism Central service accounts. Mandatory if `rancher2_cloud_credential.nutanix_credential_config` is not used (string)
+* `password` - (Optional/Sensitive) Nutanix management password or API key for service account mode. Mandatory if `rancher2_cloud_credential.nutanix_credential_config` is not used (string)
+* `cluster` - (Required) Nutanix cluster where the VM is deployed (string)
+* `vm_network` - (Required) Network names or UUIDs to attach to the VM (list)
+* `vm_image` - (Required) Name of the VM disk image/template to clone from (string)
+* `port` - (Optional) Nutanix management endpoint port. Default `9440` (string)
+* `insecure` - (Optional) Allow insecure SSL requests. Default `false` (bool)
+* `vm_mem` - (Optional) Memory in MB of the VM to be created. Default `2048` (string)
+* `vm_cpus` - (Optional) Number of VCPUs of the VM to be created. Default `2` (string)
+* `vm_cores` - (Optional) Number of cores per VCPU of the VM to be created. Default `1` (string)
+* `vm_cpu_passthrough` - (Optional) Enable passthrough of host CPU features to the VM. Default `false` (bool)
+* `vm_image_size` - (Optional) Increase the size of the template image in GiB. Default `0` (string)
+* `vm_categories` - (Optional) Categories to apply to the VM (list)
+* `storage_container` - (Optional) UUID of the storage container for additional disk (string)
+* `disk_size` - (Optional) Size of the additional disk in GiB. Default `0` (string)
+* `cloud_init` - (Optional) Cloud-init configuration (string)
+* `vm_serial_port` - (Optional) Attach a serial port to the VM. Default `false` (bool)
+* `project` - (Optional) Name of the project to assign the VM (string)
+* `boot_type` - (Optional) Boot type of the VM. Supported values are `legacy` and `uefi`. Default `legacy` (string)
+* `timeout` - (Optional) Timeout for Nutanix operations in seconds. Default `300` (string)
+* `vm_gpu` - (Optional) GPU devices to attach to the VM (list)
+
 ## Timeouts
 
 `rancher2_machine_config_v2` provides the following

rancher2/resource_rancher2_cloud_credential.go

@@ -17,6 +17,7 @@ const (
 	digitaloceanConfigDriver  = "digitalocean"
 	harvesterConfigDriver     = "harvester"
 	linodeConfigDriver        = "linode"
+	nutanixConfigDriver       = "nutanix"
 	openstackConfigDriver     = "openstack"
 	vmwarevsphereConfigDriver = "vmwarevsphere"
 )
@@ -140,6 +141,8 @@ func resourceRancher2CloudCredentialUpdate(d *schema.ResourceData, meta interfac
 		update["harvestercredentialConfig"] = expandCloudCredentialHarvester(d.Get("harvester_credential_config").([]interface{}))
 	case linodeConfigDriver:
 		update["linodecredentialConfig"] = expandCloudCredentialLinode(d.Get("linode_credential_config").([]interface{}))
+	case nutanixConfigDriver:
+		update["nutanixcredentialConfig"] = expandCloudCredentialNutanix(d.Get("nutanix_credential_config").([]interface{}))
 	case openstackConfigDriver:
 		update["openstackcredentialConfig"] = expandCloudCredentialOpenstack(d.Get("openstack_credential_config").([]interface{}))
 	case s3ConfigDriver:

rancher2/resource_rancher2_machine_config_v2.go

@@ -234,6 +234,13 @@ func createMachineConfigV2(c *Config, obj *MachineConfigV2) (*MachineConfigV2, e
 		out.ID = resp.ID
 		out.TypeMeta = resp.TypeMeta
 		out.ObjectMeta = resp.ObjectMeta
+	case machineConfigV2NutanixKind:
+		resp := &MachineConfigV2Nutanix{}
+		err = c.createObjectV2(rancher2DefaultLocalClusterID, machineConfigV2NutanixAPIType, obj.NutanixConfig, resp)
+		out.NutanixConfig = resp
+		out.ID = resp.ID
+		out.TypeMeta = resp.TypeMeta
+		out.ObjectMeta = resp.ObjectMeta
 	default:
 		return nil, fmt.Errorf("[ERROR] Unsupported driver on node template: %s", kind)
 	}
@@ -349,6 +356,16 @@ func getMachineConfigV2ByID(c *Config, id, kind string) (*MachineConfigV2, error
 		out.Type = resp.Type
 		out.TypeMeta = resp.TypeMeta
 		out.ObjectMeta = resp.ObjectMeta
+	case machineConfigV2NutanixKind:
+		resp := &MachineConfigV2Nutanix{}
+		err = c.getObjectV2ByID(rancher2DefaultLocalClusterID, id, machineConfigV2NutanixAPIType, resp)
+		out.NutanixConfig = resp
+		out.ID = resp.ID
+		out.Links = resp.Links
+		out.Actions = resp.Actions
+		out.Type = resp.Type
+		out.TypeMeta = resp.TypeMeta
+		out.ObjectMeta = resp.ObjectMeta
 	default:
 		return nil, fmt.Errorf("[ERROR] Unsupported driver on node template: %s", kind)
 	}
@@ -428,6 +445,13 @@ func updateMachineConfigV2(c *Config, obj *MachineConfigV2) (*MachineConfigV2, e
 		out.ID = resp.ID
 		out.TypeMeta = resp.TypeMeta
 		out.ObjectMeta = resp.ObjectMeta
+	case machineConfigV2NutanixKind:
+		resp := &MachineConfigV2Nutanix{}
+		err = c.updateObjectV2(rancher2DefaultLocalClusterID, obj.ID, machineConfigV2NutanixAPIType, obj.NutanixConfig, resp)
+		out.NutanixConfig = resp
+		out.ID = resp.ID
+		out.TypeMeta = resp.TypeMeta
+		out.ObjectMeta = resp.ObjectMeta
 	default:
 		return nil, fmt.Errorf("[ERROR] Unsupported driver on node template: %s", kind)
 	}

rancher2/schema_cloud_credential.go

@@ -15,6 +15,7 @@ type CloudCredential struct {
 	GoogleCredentialConfig        *googleCredentialConfig        `json:"googlecredentialConfig,omitempty" yaml:"googlecredentialConfig,omitempty"`
 	HarvesterCredentialConfig     *harvesterCredentialConfig     `json:"harvestercredentialConfig,omitempty" yaml:"harvestercredentialConfig,omitempty"`
 	LinodeCredentialConfig        *linodeCredentialConfig        `json:"linodecredentialConfig,omitempty" yaml:"linodecredentialConfig,omitempty"`
+	NutanixCredentialConfig       *nutanixCredentialConfig       `json:"nutanixcredentialConfig,omitempty" yaml:"nutanixcredentialConfig,omitempty"`
 	OpenstackCredentialConfig     *openstackCredentialConfig     `json:"openstackcredentialConfig,omitempty" yaml:"openstackcredentialConfig,omitempty"`
 	VmwarevsphereCredentialConfig *vmwarevsphereCredentialConfig `json:"vmwarevspherecredentialConfig,omitempty" yaml:"vmwarevspherecredentialConfig,omitempty"`
 }
@@ -26,6 +27,7 @@ var allCloudCredentialDriverConfigFields = []string{
 	"google_credential_config",
 	"harvester_credential_config",
 	"linode_credential_config",
+	"nutanix_credential_config",
 	"openstack_credential_config",
 	"s3_credential_config",
 	"vsphere_credential_config"}
@@ -100,6 +102,15 @@ func cloudCredentialFields() map[string]*schema.Schema {
 				Schema: cloudCredentialLinodeFields(),
 			},
 		},
+		"nutanix_credential_config": {
+			Type:          schema.TypeList,
+			MaxItems:      1,
+			Optional:      true,
+			ConflictsWith: getConflicts(allCloudCredentialDriverConfigFields, "nutanix_credential_config"),
+			Elem: &schema.Resource{
+				Schema: cloudCredentialNutanixFields(),
+			},
+		},
 		"openstack_credential_config": {
 			Type:          schema.TypeList,
 			MaxItems:      1,

rancher2/schema_cloud_credential_nutanix.go

@@ -0,0 +1,43 @@
+package rancher2
+
+import "github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+
+// Types
+
+type nutanixCredentialConfig struct {
+	Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`
+	Username string `json:"username,omitempty" yaml:"username,omitempty"`
+	Password string `json:"password,omitempty" yaml:"password,omitempty"`
+	Port     string `json:"port,omitempty" yaml:"port,omitempty"`
+}
+
+// Schemas
+
+func cloudCredentialNutanixFields() map[string]*schema.Schema {
+	s := map[string]*schema.Schema{
+		"endpoint": {
+			Type:        schema.TypeString,
+			Required:    true,
+			Description: "Nutanix management endpoint IP address/FQDN",
+		},
+		"username": {
+			Type:        schema.TypeString,
+			Required:    true,
+			Description: "Nutanix management username",
+		},
+		"password": {
+			Type:        schema.TypeString,
+			Required:    true,
+			Sensitive:   true,
+			Description: "Nutanix management password",
+		},
+		"port": {
+			Type:        schema.TypeString,
+			Optional:    true,
+			Default:     "9440",
+			Description: "Nutanix management endpoint port",
+		},
+	}
+
+	return s
+}

rancher2/schema_machine_config_v2.go

@@ -13,6 +13,7 @@ var allMachineDriverConfigFields = []string{
 	"openstack_config",
 	"vsphere_config",
 	"google_config",
+	"nutanix_config",
 }
 
 // Schemas
@@ -111,6 +112,15 @@ func machineConfigV2Fields() map[string]*schema.Schema {
 				Schema: machineConfigV2GoogleGCEFields(),
 			},
 		},
+		"nutanix_config": {
+			Type:          schema.TypeList,
+			MaxItems:      1,
+			Optional:      true,
+			ConflictsWith: getConflicts(allMachineDriverConfigFields, "nutanix_config"),
+			Elem: &schema.Resource{
+				Schema: machineConfigV2NutanixFields(),
+			},
+		},
 		"resource_version": {
 			Type:     schema.TypeString,
 			Computed: true,