add support for image and network name (#441)

Signed-off-by: Prajyot-Parab <[email protected]>

Author: Prajyot-Parab

api/v1alpha4/ibmpowervscluster_types.go

@@ -38,8 +38,8 @@ type IBMPowerVSClusterSpec struct {
 	// ServiceInstanceID is the id of the power cloud instance where the vsi instance will get deployed
 	ServiceInstanceID string `json:"serviceInstanceID"`
 
-	// Network is network ID used for the VSI
-	NetworkID string `json:"networkID"`
+	// Network is the reference to the Network to use for this cluster.
+	Network IBMPowerVSResourceReference `json:"network"`
 
 	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
 	// +optional

api/v1alpha4/ibmpowervsmachine_types.go

@@ -41,9 +41,8 @@ type IBMPowerVSMachineSpec struct {
 	// SSHKey is the name of the SSH key pair provided to the vsi for authenticating users
 	SSHKey string `json:"sshKey,omitempty"`
 
-	// ImageID is the id of OS image which would be install on the instance.
-	// Example: c57eef35-ea0b-45d7-b864-4b0d4893425b
-	ImageID string `json:"imageID"`
+	// Image is the reference to the Image from which to create the machine instance.
+	Image IBMPowerVSResourceReference `json:"image"`
 
 	// SysType is the System type used to host the vsi
 	SysType string `json:"sysType"`
@@ -57,14 +56,27 @@ type IBMPowerVSMachineSpec struct {
 	// Memory is Amount of memory allocated (in GB)
 	Memory string `json:"memory"`
 
-	// NetworkID is network ID used for the VSI
-	NetworkID string `json:"networkID"`
+	// Network is the reference to the Network to use for this instance.
+	Network IBMPowerVSResourceReference `json:"network"`
 
 	// ProviderID is the unique identifier as specified by the cloud provider.
 	// +optional
 	ProviderID *string `json:"providerID,omitempty"`
 }
 
+// IBMPowerVSResourceReference is a reference to a specific PowerVS resource by ID or Name
+// Only one of ID or Name may be specified. Specifying more than one will result in
+// a validation error.
+type IBMPowerVSResourceReference struct {
+	// ID of resource
+	// +optional
+	ID *string `json:"id,omitempty"`
+
+	// Name of resource
+	// +optional
+	Name *string `json:"name,omitempty"`
+}
+
 // IBMPowerVSMachineStatus defines the observed state of IBMPowerVSMachine
 type IBMPowerVSMachineStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster

api/v1alpha4/zz_generated.deepcopy.go

@@ -31,6 +31,7 @@ type IBMPowerVSClient struct {
 	session        *ibmpisession.IBMPISession
 	InstanceClient *instance.IBMPIInstanceClient
 	NetworkClient  *instance.IBMPINetworkClient
+	ImageClient    *instance.IBMPIImageClient
 }
 
 // NewIBMPowerVSClient creates and returns a IBM Power VS client
@@ -43,5 +44,6 @@ func NewIBMPowerVSClient(token, account, cloudInstanceID, region, zone string, d
 
 	client.InstanceClient = instance.NewIBMPIInstanceClient(client.session, cloudInstanceID)
 	client.NetworkClient = instance.NewIBMPINetworkClient(client.session, cloudInstanceID)
+	client.ImageClient = instance.NewIBMPIImageClient(client.session, cloudInstanceID)
 	return client, nil
 }

cloud/scope/powervs_clients.go

@@ -25,9 +25,10 @@ import (
 
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
+	utils "github.com/ppc64le-cloud/powervs-utils"
 
-	"github.com/ppc64le-cloud/powervs-utils"
-
+	"github.com/IBM-Cloud/power-go-client/ibmpisession"
+	"github.com/IBM-Cloud/power-go-client/power/client/p_cloud_networks"
 	"github.com/IBM-Cloud/power-go-client/power/client/p_cloud_p_vm_instances"
 	"github.com/IBM-Cloud/power-go-client/power/models"
 
@@ -157,13 +158,23 @@ func (m *PowerVSMachineScope) CreateMachine() (*models.PVMInstanceReference, err
 		return nil, fmt.Errorf("failed to convert Processors(%s) to float64", s.Processors)
 	}
 
+	imageID, err := getImageID(s.Image, m)
+	if err != nil {
+		return nil, fmt.Errorf("error getting image ID: %v", err)
+	}
+
+	networkID, err := getNetworkID(s.Network, m)
+	if err != nil {
+		return nil, fmt.Errorf("error getting network ID: %v", err)
+	}
+
 	params := &p_cloud_p_vm_instances.PcloudPvminstancesPostParams{
 		Body: &models.PVMInstanceCreate{
-			ImageID:     &s.ImageID,
+			ImageID:     imageID,
 			KeyPairName: s.SSHKey,
 			Networks: []*models.PVMInstanceAddNetwork{
 				{
-					NetworkID: &s.NetworkID,
+					NetworkID: networkID,
 					//IPAddress: address,
 				},
 			},
@@ -216,3 +227,60 @@ func (m *PowerVSMachineScope) GetBootstrapData() (string, error) {
 
 	return base64.StdEncoding.EncodeToString(value), nil
 }
+
+func getImageID(image v1alpha4.IBMPowerVSResourceReference, m *PowerVSMachineScope) (*string, error) {
+	if image.ID != nil {
+		return image.ID, nil
+	} else if image.Name != nil {
+		images, err := m.GetImages()
+		if err != nil {
+			m.Logger.Error(err, "failed to get images")
+			return nil, err
+		}
+		for _, img := range images.Images {
+			if *image.Name == *img.Name {
+				m.Logger.Info("image found with ID", "Image", *image.Name, "ID", *img.ImageID)
+				return img.ImageID, nil
+			}
+		}
+	} else {
+		return nil, fmt.Errorf("both ID and Name can't be nil")
+	}
+	return nil, fmt.Errorf("failed to find an image ID")
+}
+
+func (m *PowerVSMachineScope) GetImages() (*models.Images, error) {
+	return m.IBMPowerVSClient.ImageClient.GetAll(m.IBMPowerVSMachine.Spec.ServiceInstanceID)
+}
+
+func getNetworkID(network v1alpha4.IBMPowerVSResourceReference, m *PowerVSMachineScope) (*string, error) {
+	if network.ID != nil {
+		return network.ID, nil
+	} else if network.Name != nil {
+		networks, err := m.GetNetworks()
+		if err != nil {
+			m.Logger.Error(err, "failed to get networks")
+			return nil, err
+		}
+		for _, nw := range networks.Networks {
+			if *network.Name == *nw.Name {
+				m.Logger.Info("network found with ID", "Network", *network.Name, "ID", *nw.NetworkID)
+				return nw.NetworkID, nil
+			}
+		}
+	} else {
+		return nil, fmt.Errorf("both ID and Name can't be nil")
+	}
+
+	return nil, fmt.Errorf("failed to find a network ID")
+}
+
+func (m *PowerVSMachineScope) GetNetworks() (*models.Networks, error) {
+	params := p_cloud_networks.NewPcloudNetworksGetallParamsWithTimeout(TIMEOUT).WithCloudInstanceID(m.IBMPowerVSMachine.Spec.ServiceInstanceID)
+	resp, err := m.IBMPowerVSClient.session.Power.PCloudNetworks.PcloudNetworksGetall(params, ibmpisession.NewAuth(m.IBMPowerVSClient.session, m.IBMPowerVSMachine.Spec.ServiceInstanceID))
+
+	if err != nil || resp.Payload == nil {
+		return nil, err
+	}
+	return resp.Payload, nil
+}

cloud/scope/powervs_machine.go

@@ -51,15 +51,23 @@ spec:
                 - host
                 - port
                 type: object
-              networkID:
-                description: Network is network ID used for the VSI
-                type: string
+              network:
+                description: Network is the reference to the Network to use for this
+                  cluster.
+                properties:
+                  id:
+                    description: ID of resource
+                    type: string
+                  name:
+                    description: Name of resource
+                    type: string
+                type: object
               serviceInstanceID:
                 description: ServiceInstanceID is the id of the power cloud instance
                   where the vsi instance will get deployed
                 type: string
             required:
-            - networkID
+            - network
             - serviceInstanceID
             type: object
           status:

config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsclusters.yaml

@@ -53,16 +53,31 @@ spec:
           spec:
             description: IBMPowerVSMachineSpec defines the desired state of IBMPowerVSMachine
             properties:
-              imageID:
-                description: 'ImageID is the id of OS image which would be install
-                  on the instance. Example: c57eef35-ea0b-45d7-b864-4b0d4893425b'
-                type: string
+              image:
+                description: Image is the reference to the Image from which to create
+                  the machine instance.
+                properties:
+                  id:
+                    description: ID of resource
+                    type: string
+                  name:
+                    description: Name of resource
+                    type: string
+                type: object
               memory:
                 description: Memory is Amount of memory allocated (in GB)
                 type: string
-              networkID:
-                description: NetworkID is network ID used for the VSI
-                type: string
+              network:
+                description: Network is the reference to the Network to use for this
+                  instance.
+                properties:
+                  id:
+                    description: ID of resource
+                    type: string
+                  name:
+                    description: Name of resource
+                    type: string
+                type: object
               procType:
                 description: 'ProcType is the processor type, e.g: dedicated, shared,
                   capped'
@@ -86,9 +101,9 @@ spec:
                 description: SysType is the System type used to host the vsi
                 type: string
             required:
-            - imageID
+            - image
             - memory
-            - networkID
+            - network
             - procType
             - processors
             - serviceInstanceID

config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachines.yaml

@@ -46,16 +46,31 @@ spec:
                     description: IBMPowerVSMachineSpec defines the desired state of
                       IBMPowerVSMachine
                     properties:
-                      imageID:
-                        description: 'ImageID is the id of OS image which would be
-                          install on the instance. Example: c57eef35-ea0b-45d7-b864-4b0d4893425b'
-                        type: string
+                      image:
+                        description: Image is the reference to the Image from which
+                          to create the machine instance.
+                        properties:
+                          id:
+                            description: ID of resource
+                            type: string
+                          name:
+                            description: Name of resource
+                            type: string
+                        type: object
                       memory:
                         description: Memory is Amount of memory allocated (in GB)
                         type: string
-                      networkID:
-                        description: NetworkID is network ID used for the VSI
-                        type: string
+                      network:
+                        description: Network is the reference to the Network to use
+                          for this instance.
+                        properties:
+                          id:
+                            description: ID of resource
+                            type: string
+                          name:
+                            description: Name of resource
+                            type: string
+                        type: object
                       procType:
                         description: 'ProcType is the processor type, e.g: dedicated,
                           shared, capped'
@@ -79,9 +94,9 @@ spec:
                         description: SysType is the System type used to host the vsi
                         type: string
                     required:
-                    - imageID
+                    - image
                     - memory
-                    - networkID
+                    - network
                     - procType
                     - processors
                     - serviceInstanceID

config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachinetemplates.yaml

@@ -101,9 +101,9 @@
     IBMPOWERVS_VIP="192.168.151.22" \
     IBMPOWERVS_VIP_EXTERNAL="158.175.162.22" \
     IBMPOWERVS_VIP_CIDR="29" \
-    IBMPOWERVS_IMAGE_ID="505f57d8-1143-4a99-b67f-7e82d73342bf" \
+    IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-8-1-22-4" \
     IBMPOWERVS_SERVICE_INSTANCE_ID="7845d372-d4e1-46b8-91fc-41051c984601" \
-    IBMPOWERVS_NETWORK_ID="0ad342f5-f461-414a-a870-e2f2a2b7fa0c" \
+    IBMPOWERVS_NETWORK_NAME="capi-test-3" \
     clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.22.4 \
     --target-namespace default \
     --control-plane-machine-count=3 \

docs/book/src/topics/powervs/creating-a-cluster.md

@@ -18,6 +18,7 @@ package pkg
 
 import (
 	"fmt"
+
 	"github.com/IBM/go-sdk-core/v5/core"
 )