Merge pull request #770 from winiciusallan/port-value-specs

port: add ValueSpecs field

Author: mandre

api/v1alpha1/port_types.go

@@ -121,6 +121,19 @@ type FixedIPStatus struct {
 	SubnetID string `json:"subnetID,omitempty"`
 }
 
+type PortValueSpec struct {
+	// key is the name of the Neutron API extension parameter.
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=255
+	// +required
+	Key string `json:"key,omitempty"`
+
+	// value is the value of the Neutron API extension parameter.
+	// +kubebuilder:validation:MaxLength:=255
+	// +required
+	Value *string `json:"value,omitempty"`
+}
+
 // +kubebuilder:validation:XValidation:rule="has(self.portSecurity) && self.portSecurity == 'Disabled' ? !has(self.securityGroupRefs) : true",message="securityGroupRefs must be empty when portSecurity is set to Disabled"
 // +kubebuilder:validation:XValidation:rule="has(self.portSecurity) && self.portSecurity == 'Disabled' ? !has(self.allowedAddressPairs) : true",message="allowedAddressPairs must be empty when portSecurity is set to Disabled"
 type PortResourceSpec struct {
@@ -216,6 +229,21 @@ type PortResourceSpec struct {
 	// operations. Only admin users can create ports with this field.
 	// +optional
 	TrustedVIF *bool `json:"trustedVIF,omitempty"`
+
+	// valueSpecs are extra parameters to include in the API request
+	// with OpenStack. This is an extension point for the API, so what
+	// they do and if they are supported, depends on the specific
+	// OpenStack implementation. This was meant to work similar to the
+	// property on Heat port resource. Since this depends on the
+	// underlying implementation, we can't predict its fields, and
+	// therefore, we don't know how to reconcile them in advance. Use
+	// this field wisely and be aware of the expected behavior.
+	// +kubebuilder:validation:MaxItems:=128
+	// +listType=map
+	// +listMapKey=key
+	// +optional
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="valueSpecs is immutable"
+	ValueSpecs []PortValueSpec `json:"valueSpecs,omitempty"`
 }
 
 type PortResourceStatus struct {

api/v1alpha1/zz_generated.deepcopy.go

@@ -407,6 +407,41 @@ spec:
                       trusted by physical function to perform some privileged
                       operations. Only admin users can create ports with this field.
                     type: boolean
+                  valueSpecs:
+                    description: |-
+                      valueSpecs are extra parameters to include in the API request
+                      with OpenStack. This is an extension point for the API, so what
+                      they do and if they are supported, depends on the specific
+                      OpenStack implementation. This was meant to work similar to the
+                      property on Heat port resource. Since this depends on the
+                      underlying implementation, we can't predict its fields, and
+                      therefore, we don't know how to reconcile them in advance. Use
+                      this field wisely and be aware of the expected behavior.
+                    items:
+                      properties:
+                        key:
+                          description: key is the name of the Neutron API extension
+                            parameter.
+                          maxLength: 255
+                          minLength: 1
+                          type: string
+                        value:
+                          description: value is the value of the Neutron API extension
+                            parameter.
+                          maxLength: 255
+                          type: string
+                      required:
+                      - key
+                      - value
+                      type: object
+                    maxItems: 128
+                    type: array
+                    x-kubernetes-list-map-keys:
+                    - key
+                    x-kubernetes-list-type: map
+                    x-kubernetes-validations:
+                    - message: valueSpecs is immutable
+                      rule: self == oldSelf
                   vnicType:
                     description: |-
                       vnicType specifies the type of vNIC which this port should be

cmd/models-schema/zz_generated.openapi.go

@@ -239,13 +239,23 @@ func (actuator portActuator) CreateResource(ctx context.Context, obj *orcv1alpha
 		return nil, reconcileStatus
 	}
 
+	var valueSpecs *map[string]string
+	if len(resource.ValueSpecs) > 0 {
+		vs := make(map[string]string, len(resource.ValueSpecs))
+		for _, valueSpec := range resource.ValueSpecs {
+			vs[valueSpec.Key] = *valueSpec.Value
+		}
+		valueSpecs = &vs
+	}
+
 	createOpts := ports.CreateOpts{
 		NetworkID:    *network.Status.ID,
 		Name:         getResourceName(obj),
 		Description:  string(ptr.Deref(resource.Description, "")),
 		ProjectID:    projectID,
 		AdminStateUp: resource.AdminStateUp,
 		MACAddress:   resource.MACAddress,
+		ValueSpecs:   valueSpecs,
 	}
 
 	if len(resource.AllowedAddressPairs) > 0 {

config/crd/bases/openstack.k-orc.cloud_ports.yaml

@@ -30,11 +30,11 @@ resourceRefs:
     - apiVersion: openstack.k-orc.cloud/v1alpha1
       kind: subnet
       name: port-create-full
-      ref: subnet      
+      ref: subnet
     - apiVersion: openstack.k-orc.cloud/v1alpha1
       kind: securitygroup
       name: port-create-full
-      ref: sg     
+      ref: sg
     - apiVersion: openstack.k-orc.cloud/v1alpha1
       kind: project
       name: port-create-full

internal/controllers/port/actuator.go

@@ -4,6 +4,11 @@
 
 Create a port using all available fields, and verify that the observed state corresponds to the spec.
 
+We're omitting the `ValueSpecs` field on purpose because we can't
+reliably test it, since the key-value pairs in this structure depend
+solely on the underlying OpenStack implementation, and thus the added
+fields are unpredictable.
+
 Also validate that the OpenStack resource uses the name from the spec when it is specified.
 
 ## Reference