adding comments and changes for more clarity

Author: vladcristi

api/v1beta1/types.go

@@ -856,7 +856,6 @@ type Subnet struct {
 	Name string `json:"name"`
 	// Skip specifies whether to skip creating subnets.
 	// +optional
-
 	Skip bool `json:"skip,omitempty"`
 	// Subnet CIDR.
 	// +optional
@@ -911,6 +910,7 @@ type VCN struct {
 	Name string `json:"name"`
 
 	// Skip specifies whether to skip creating VCN.
+	// When is set to true, InternetGateway, NatGateway, ServiceGateway, RouteTable should be also have Skip set to true
 	// +optional
 	Skip bool `json:"skip,omitempty"`
 

api/v1beta2/ocicluster_webhook.go

@@ -94,7 +94,7 @@ func (c *OCICluster) ValidateCreate() (admission.Warnings, error) {
 		}
 	}
 
-	// If Skip field is True, ID field of VCN should be specified
+	// If Skip field is true, ID field of VCN should be specified
 	if c.Spec.NetworkSpec.Vcn.Skip == *common.Bool(true) {
 		if c.Spec.NetworkSpec.Vcn.ID == common.String("") || c.Spec.NetworkSpec.Vcn.ID == nil {
 			allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "NetworkSpec.Vcn.ID"), c.Spec.NetworkSpec.Vcn.ID, "field is required"))
@@ -120,22 +120,24 @@ func (c *OCICluster) ValidateCreate() (admission.Warnings, error) {
 			allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "NetworkSpec.Vcn.RouteTable.Skip"), c.Spec.NetworkSpec.Vcn.RouteTable.Skip, "field requires to be true when VCN is skipped"))
 		}
 
-		// For each subnet if Skip field is True, ID field of Subnet should be specified
-		// Also for each subnet if ID field is True, Skip field of Subnet should be true
+		// For each subnet
 		for _, subnet := range c.Spec.NetworkSpec.Vcn.Subnets {
+
+			// if Skip field is true, ID field of Subnet should also be specified
 			if subnet.Skip == *common.Bool(true) {
 				if subnet.ID == common.String("") || subnet.ID == nil {
 					allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.ID"), subnet.ID, "field is required"))
 				}
 			}
+			// if ID field is specified, Skip field of Subnet should also be true
 			if subnet.ID != common.String("") {
 				if subnet.Skip != *common.Bool(true) {
 					allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.Skip"), subnet.Skip, "field requires to be true if Subnet ID is specified"))
 				}
 			}
 		}
 	} else {
-		// If Skip field is False, for each subnet in VCN the Skip field of Subnet cannot be true
+		// If Skip field of VCN is false, for each subnet in that VCN the Skip field of Subnet cannot be true
 		for _, subnet := range c.Spec.NetworkSpec.Vcn.Subnets {
 			if subnet.Skip == *common.Bool(true) {
 				allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.Skip"), subnet.Skip, "field cannot be true when VCN is not skipped"))
@@ -182,7 +184,7 @@ func (c *OCICluster) ValidateUpdate(old runtime.Object) (admission.Warnings, err
 		allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "compartmentId"), c.Spec.CompartmentId, "field is immutable"))
 	}
 
-	// If Skip field is True, ID field of VCN should be specified
+	// If Skip field is true, ID field of VCN should be specified
 	if c.Spec.NetworkSpec.Vcn.Skip == *common.Bool(true) {
 		if c.Spec.NetworkSpec.Vcn.ID == common.String("") || c.Spec.NetworkSpec.Vcn.ID == nil {
 			allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "NetworkSpec.Vcn.ID"), c.Spec.NetworkSpec.Vcn.ID, "field is required"))
@@ -208,22 +210,24 @@ func (c *OCICluster) ValidateUpdate(old runtime.Object) (admission.Warnings, err
 			allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "NetworkSpec.Vcn.RouteTable.Skip"), c.Spec.NetworkSpec.Vcn.RouteTable.Skip, "field requires to be true when VCN is skipped"))
 		}
 
-		// For each subnet if Skip field is True, ID field of Subnet should be specified
-		// Also for each subnet if ID field is True, Skip field of Subnet should be true
+		// For each subnet
 		for _, subnet := range c.Spec.NetworkSpec.Vcn.Subnets {
+
+			// if Skip field is true, ID field of Subnet should also be specified
 			if subnet.Skip == *common.Bool(true) {
 				if subnet.ID == common.String("") || subnet.ID == nil {
 					allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.ID"), subnet.ID, "field is required"))
 				}
 			}
+			// if ID field is specified, Skip field of Subnet should also be true
 			if subnet.ID != common.String("") {
 				if subnet.Skip != *common.Bool(true) {
 					allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.Skip"), subnet.Skip, "field requires to be true if Subnet ID is specified"))
 				}
 			}
 		}
 	} else {
-		// If Skip field is False, for each subnet in VCN the Skip field of Subnet cannot be true
+		// If Skip field of VCN is false, for each subnet in that VCN the Skip field of Subnet cannot be true
 		for _, subnet := range c.Spec.NetworkSpec.Vcn.Subnets {
 			if subnet.Skip == *common.Bool(true) {
 				allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "subnet.Skip"), subnet.Skip, "field cannot be true when VCN is not skipped"))

api/v1beta2/types.go

@@ -910,6 +910,7 @@ type VCN struct {
 	Name string `json:"name"`
 
 	// Skip specifies whether to skip creating VCN.
+	// When is set to true, InternetGateway, NatGateway, ServiceGateway, RouteTable should be also have Skip set to true
 	// +optional
 	Skip bool `json:"skip,omitempty"`
 
@@ -1132,6 +1133,7 @@ type RemotePeeringConnection struct {
 // InternetGateway is used to specify the options for creating internet gateway.
 type InternetGateway struct {
 	// Skip specifies whether to skip creating internet gateway even if any one Subnet is public.
+	// In case of VCN being Skipped (Skip field of VCN set to true), this field should be true also
 	// +optional
 	Skip bool `json:"skip,omitempty"`
 
@@ -1143,6 +1145,7 @@ type InternetGateway struct {
 // NATGateway is used to specify the options for creating NAT gateway.
 type NATGateway struct {
 	// Skip specifies whether to skip creating NAT gateway even if any one Subnet is private.
+	// In case of VCN being Skipped (Skip field of VCN set to true), this field should be true also
 	// +optional
 	Skip bool `json:"skip,omitempty"`
 
@@ -1154,6 +1157,7 @@ type NATGateway struct {
 // ServiceGateway is used to specify the options for creating Service gateway.
 type ServiceGateway struct {
 	// Skip specifies whether to skip creating Service gateway.
+	// In case of VCN being Skipped (Skip field of VCN set to true), this field should be true also
 	// +optional
 	Skip bool `json:"skip,omitempty"`
 
@@ -1165,6 +1169,7 @@ type ServiceGateway struct {
 // RouteTable is used to specify the options for creating Route table.
 type RouteTable struct {
 	// Skip specifies whether to skip creating Route table.
+	// In case of VCN being Skipped (Skip field of VCN set to true), this field should be true also
 	// +optional
 	Skip bool `json:"skip,omitempty"`