Add conditions (#508)

Author: mkumatag

api/v1alpha4/ibmpowervs_conversion.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha4
 
 import (
+	apiconversion "k8s.io/apimachinery/pkg/conversion"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta1"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 )
@@ -92,3 +93,9 @@ func (dst *IBMPowerVSMachineTemplateList) ConvertFrom(srcRaw conversion.Hub) err
 
 	return Convert_v1beta1_IBMPowerVSMachineTemplateList_To_v1alpha4_IBMPowerVSMachineTemplateList(src, dst, nil)
 }
+
+// Convert_v1beta1_IBMPowerVSMachineStatus_To_v1alpha4_IBMPowerVSMachineStatus is an autogenerated conversion function.
+// Requires manual conversion as FailureReason, FailureMessage and Conditions does not exist in v1alpha4 version of IBMPowerVSMachineStatus.
+func Convert_v1beta1_IBMPowerVSMachineStatus_To_v1alpha4_IBMPowerVSMachineStatus(in *v1beta1.IBMPowerVSMachineStatus, out *IBMPowerVSMachineStatus, s apiconversion.Scope) error {
+	return autoConvert_v1beta1_IBMPowerVSMachineStatus_To_v1alpha4_IBMPowerVSMachineStatus(in, out, s)
+}

api/v1alpha4/zz_generated.conversion.go

@@ -0,0 +1,43 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
+
+const (
+	// InstanceProvisionFailedReason used for failures during instance provisioning.
+	InstanceProvisionFailedReason = "InstanceProvisionFailed"
+	// WaitingForClusterInfrastructureReason used when machine is waiting for cluster infrastructure to be ready before proceeding.
+	WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure"
+	// WaitingForBootstrapDataReason used when machine is waiting for bootstrap data to be ready before proceeding.
+	WaitingForBootstrapDataReason = "WaitingForBootstrapData"
+)
+
+const (
+	// InstanceStoppedReason instance is in a stopped state.
+	InstanceStoppedReason = "InstanceStopped"
+
+	// InstanceNotReadyReason used when the instance is in a pending state.
+	InstanceNotReadyReason = "InstanceNotReady"
+)
+
+const (
+	// InstanceReadyCondition reports on current status of the instance. Ready indicates the instance is in a Running state.
+	InstanceReadyCondition clusterv1.ConditionType = "InstanceReady"
+)

api/v1beta1/conditions_consts.go

@@ -19,6 +19,8 @@ package v1beta1
 import (
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+	"sigs.k8s.io/cluster-api/errors"
 )
 
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
@@ -99,11 +101,54 @@ type IBMPowerVSMachineStatus struct {
 	Health string `json:"health,omitempty"`
 
 	// InstanceState is the status of the vsi
-	InstanceState string `json:"instanceState"`
+	// +optional
+	InstanceState PowerVSInstanceState `json:"instanceState,omitempty"`
 
 	// Fault will report if any fault messages for the vsi
 	// +optional
 	Fault string `json:"fault,omitempty"`
+
+	// FailureReason will be set in the event that there is a terminal problem
+	// reconciling the Machine and will contain a succinct value suitable
+	// for machine interpretation.
+	//
+	// This field should not be set for transitive errors that a controller
+	// faces that are expected to be fixed automatically over
+	// time (like service outages), but instead indicate that something is
+	// fundamentally wrong with the Machine's spec or the configuration of
+	// the controller, and that manual intervention is required. Examples
+	// of terminal errors would be invalid combinations of settings in the
+	// spec, values that are unsupported by the controller, or the
+	// responsible controller itself being critically misconfigured.
+	//
+	// Any transient errors that occur during the reconciliation of Machines
+	// can be added as events to the Machine object and/or logged in the
+	// controller's output.
+	// +optional
+	FailureReason *errors.MachineStatusError `json:"failureReason,omitempty"`
+
+	// FailureMessage will be set in the event that there is a terminal problem
+	// reconciling the Machine and will contain a more verbose string suitable
+	// for logging and human consumption.
+	//
+	// This field should not be set for transitive errors that a controller
+	// faces that are expected to be fixed automatically over
+	// time (like service outages), but instead indicate that something is
+	// fundamentally wrong with the Machine's spec or the configuration of
+	// the controller, and that manual intervention is required. Examples
+	// of terminal errors would be invalid combinations of settings in the
+	// spec, values that are unsupported by the controller, or the
+	// responsible controller itself being critically misconfigured.
+	//
+	// Any transient errors that occur during the reconciliation of Machines
+	// can be added as events to the Machine object and/or logged in the
+	// controller's output.
+	// +optional
+	FailureMessage *string `json:"failureMessage,omitempty"`
+
+	// Conditions defines current service state of the IBMPowerVSMachine.
+	// +optional
+	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
 }
 
 //+kubebuilder:object:root=true
@@ -123,6 +168,16 @@ type IBMPowerVSMachine struct {
 	Status IBMPowerVSMachineStatus `json:"status,omitempty"`
 }
 
+// GetConditions returns the observations of the operational state of the IBMPowerVSMachine resource.
+func (r *IBMPowerVSMachine) GetConditions() clusterv1.Conditions {
+	return r.Status.Conditions
+}
+
+// SetConditions sets the underlying service state of the IBMPowerVSMachine to the predescribed clusterv1.Conditions.
+func (r *IBMPowerVSMachine) SetConditions(conditions clusterv1.Conditions) {
+	r.Status.Conditions = conditions
+}
+
 //+kubebuilder:object:root=true
 
 // IBMPowerVSMachineList contains a list of IBMPowerVSMachine

api/v1beta1/ibmpowervsmachine_types.go

@@ -16,6 +16,23 @@ limitations under the License.
 
 package v1beta1
 
+// PowerVSInstanceState describes the state of an IBM Power VS instance.
+type PowerVSInstanceState string
+
+var (
+	// PowerVSInstanceStateACTIVE is the string representing an instance in a ACTIVE state.
+	PowerVSInstanceStateACTIVE = PowerVSInstanceState("ACTIVE")
+
+	// PowerVSInstanceStateBUILD is the string representing an instance in a BUILD state.
+	PowerVSInstanceStateBUILD = PowerVSInstanceState("BUILD")
+
+	// PowerVSInstanceStateSHUTOFF is the string representing an instance in a SHUTOFF state.
+	PowerVSInstanceStateSHUTOFF = PowerVSInstanceState("SHUTOFF")
+
+	// PowerVSInstanceStateREBOOT is the string representing an instance in a REBOOT state.
+	PowerVSInstanceStateREBOOT = PowerVSInstanceState("REBOOT")
+)
+
 // NetworkInterface holds the network interface information like subnet id.
 type NetworkInterface struct {
 	// Subnet ID of the network interface

api/v1beta1/types.go

@@ -20,6 +20,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"k8s.io/utils/pointer"
 	"strconv"
 
 	"github.com/go-logr/logr"
@@ -307,3 +308,56 @@ func getNetworkID(network v1beta1.IBMPowerVSResourceReference, m *PowerVSMachine
 func (m *PowerVSMachineScope) GetNetworks() (*models.Networks, error) {
 	return m.IBMPowerVSClient.GetAllNetwork()
 }
+
+func (m *PowerVSMachineScope) SetReady() {
+	m.IBMPowerVSMachine.Status.Ready = true
+}
+
+func (m *PowerVSMachineScope) SetNotReady() {
+	m.IBMPowerVSMachine.Status.Ready = false
+}
+
+func (m *PowerVSMachineScope) SetInstanceID(id *string) {
+	if id != nil {
+		m.IBMPowerVSMachine.Status.InstanceID = *id
+	}
+}
+
+func (m *PowerVSMachineScope) GetInstanceID() string {
+	return m.IBMPowerVSMachine.Status.InstanceID
+}
+
+func (m *PowerVSMachineScope) SetHealth(health *models.PVMInstanceHealth) {
+	if health != nil {
+		m.IBMPowerVSMachine.Status.Health = health.Status
+	}
+}
+
+func (m *PowerVSMachineScope) SetAddresses(networks []*models.PVMInstanceNetwork) {
+	var addresses []corev1.NodeAddress
+	for _, network := range networks {
+		addresses = append(addresses, corev1.NodeAddress{
+			Type:    corev1.NodeInternalIP,
+			Address: network.IPAddress,
+		})
+		if network.ExternalIP != "" {
+			addresses = append(addresses, corev1.NodeAddress{
+				Type:    corev1.NodeExternalIP,
+				Address: network.ExternalIP,
+			})
+		}
+	}
+	m.IBMPowerVSMachine.Status.Addresses = addresses
+}
+
+func (m *PowerVSMachineScope) SetInstanceState(status *string) {
+	m.IBMPowerVSMachine.Status.InstanceState = v1beta1.PowerVSInstanceState(*status)
+}
+
+func (m *PowerVSMachineScope) GetInstanceState() v1beta1.PowerVSInstanceState {
+	return m.IBMPowerVSMachine.Status.InstanceState
+}
+
+func (m *PowerVSMachineScope) SetProviderID() {
+	m.IBMPowerVSMachine.Spec.ProviderID = pointer.StringPtr(fmt.Sprintf("ibmpowervs://%s/%s", m.Machine.Spec.ClusterName, m.IBMPowerVSMachine.Name))
+}