openstack.k-orc.cloud_ports.yaml

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.17.1
  name: ports.openstack.k-orc.cloud
spec:
  group: openstack.k-orc.cloud
  names:
    categories:
    - openstack
    kind: Port
    listKind: PortList
    plural: ports
    singular: port
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
    - description: Resource ID
      jsonPath: .status.id
      name: ID
      type: string
    - description: Availability status of resource
      jsonPath: .status.conditions[?(@.type=='Available')].status
      name: Available
      type: string
    - description: Allocated IP addresses
      jsonPath: .status.resource.fixedIPs[*].ip
      name: Addresses
      type: string
    - description: Message describing current progress status
      jsonPath: .status.conditions[?(@.type=='Progressing')].message
      name: Message
      type: string
    name: v1alpha1
    schema:
      openAPIV3Schema:
        description: Port is the Schema for an ORC resource.
        properties:
          apiVersion:
            description: |-
              APIVersion defines the versioned schema of this representation of an object.
              Servers should convert recognized schemas to the latest internal value, and
              may reject unrecognized values.
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
            type: string
          kind:
            description: |-
              Kind is a string value representing the REST resource this object represents.
              Servers may infer this from the endpoint the client submits requests to.
              Cannot be updated.
              In CamelCase.
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
            type: string
          metadata:
            type: object
          spec:
            description: spec specifies the desired state of the resource.
            properties:
              cloudCredentialsRef:
                description: cloudCredentialsRef points to a secret containing OpenStack
                  credentials
                properties:
                  cloudName:
                    description: cloudName specifies the name of the entry in the
                      clouds.yaml file to use.
                    maxLength: 256
                    minLength: 1
                    type: string
                  secretName:
                    description: |-
                      secretName is the name of a secret in the same namespace as the resource being provisioned.
                      The secret must contain a key named `clouds.yaml` which contains an OpenStack clouds.yaml file.
                      The secret may optionally contain a key named `cacert` containing a PEM-encoded CA certificate.
                    maxLength: 253
                    minLength: 1
                    type: string
                required:
                - cloudName
                - secretName
                type: object
              import:
                description: |-
                  import refers to an existing OpenStack resource which will be imported instead of
                  creating a new one.
                maxProperties: 1
                minProperties: 1
                properties:
                  filter:
                    description: |-
                      filter contains a resource query which is expected to return a single
                      result. The controller will continue to retry if filter returns no
                      results. If filter returns multiple results the controller will set an
                      error state and will not continue to retry.
                    minProperties: 1
                    properties:
                      adminStateUp:
                        description: |-
                          adminStateUp is the administrative state of the port,
                          which is up (true) or down (false).
                        type: boolean
                      description:
                        description: description of the existing resource
                        maxLength: 255
                        minLength: 1
                        type: string
                      macAddress:
                        description: macAddress is the MAC address of the port.
                        maxLength: 32
                        type: string
                      name:
                        description: name of the existing resource
                        maxLength: 255
                        minLength: 1
                        pattern: ^[^,]+$
                        type: string
                      networkRef:
                        description: networkRef is a reference to the ORC Network
                          which this port is associated with.
                        maxLength: 253
                        minLength: 1
                        type: string
                      notTags:
                        description: |-
                          notTags is a list of tags to filter by. If specified, resources which
                          contain all of the given tags will be excluded from the result.
                        items:
                          description: |-
                            NeutronTag represents a tag on a Neutron resource.
                            It may not be empty and may not contain commas.
                          maxLength: 255
                          minLength: 1
                          type: string
                        maxItems: 64
                        type: array
                        x-kubernetes-list-type: set
                      notTagsAny:
                        description: |-
                          notTagsAny is a list of tags to filter by. If specified, resources
                          which contain any of the given tags will be excluded from the result.
                        items:
                          description: |-
                            NeutronTag represents a tag on a Neutron resource.
                            It may not be empty and may not contain commas.
                          maxLength: 255
                          minLength: 1
                          type: string
                        maxItems: 64
                        type: array
                        x-kubernetes-list-type: set
                      projectRef:
                        description: |-
                          projectRef is a reference to the ORC Project this resource is associated with.
                          Typically, only used by admin.
                        maxLength: 253
                        minLength: 1
                        type: string
                      tags:
                        description: |-
                          tags is a list of tags to filter by. If specified, the resource must
                          have all of the tags specified to be included in the result.
                        items:
                          description: |-
                            NeutronTag represents a tag on a Neutron resource.
                            It may not be empty and may not contain commas.
                          maxLength: 255
                          minLength: 1
                          type: string
                        maxItems: 64
                        type: array
                        x-kubernetes-list-type: set
                      tagsAny:
                        description: |-
                          tagsAny is a list of tags to filter by. If specified, the resource
                          must have at least one of the tags specified to be included in the
                          result.
                        items:
                          description: |-
                            NeutronTag represents a tag on a Neutron resource.
                            It may not be empty and may not contain commas.
                          maxLength: 255
                          minLength: 1
                          type: string
                        maxItems: 64
                        type: array
                        x-kubernetes-list-type: set
                    type: object
                  id:
                    description: |-
                      id contains the unique identifier of an existing OpenStack resource. Note
                      that when specifying an import by ID, the resource MUST already exist.
                      The ORC object will enter an error state if the resource does not exist.
                    format: uuid
                    type: string
                type: object
              managedOptions:
                description: managedOptions specifies options which may be applied
                  to managed objects.
                properties:
                  onDelete:
                    default: delete
                    description: |-
                      onDelete specifies the behaviour of the controller when the ORC
                      object is deleted. Options are `delete` - delete the OpenStack resource;
                      `detach` - do not delete the OpenStack resource. If not specified, the
                      default is `delete`.
                    enum:
                    - delete
                    - detach
                    type: string
                type: object
              managementPolicy:
                default: managed
                description: |-
                  managementPolicy defines how ORC will treat the object. Valid values are
                  `managed`: ORC will create, update, and delete the resource; `unmanaged`:
                  ORC will import an existing resource, and will not apply updates to it or
                  delete it.
                enum:
                - managed
                - unmanaged
                type: string
                x-kubernetes-validations:
                - message: managementPolicy is immutable
                  rule: self == oldSelf
              resource:
                description: |-
                  resource specifies the desired state of the resource.

                  resource may not be specified if the management policy is `unmanaged`.

                  resource must be specified if the management policy is `managed`.
                properties:
                  addresses:
                    description: addresses are the IP addresses for the port.
                    items:
                      properties:
                        ip:
                          description: |-
                            ip contains a fixed IP address assigned to the port. It must belong
                            to the referenced subnet's CIDR. If not specified, OpenStack
                            allocates an available IP from the referenced subnet.
                          maxLength: 45
                          minLength: 1
                          type: string
                        subnetRef:
                          description: |-
                            subnetRef references the subnet from which to allocate the IP
                            address.
                          maxLength: 253
                          minLength: 1
                          type: string
                      required:
                      - subnetRef
                      type: object
                    maxItems: 128
                    type: array
                    x-kubernetes-list-type: atomic
                    x-kubernetes-validations:
                    - message: addresses is immutable
                      rule: self == oldSelf
                  adminStateUp:
                    default: true
                    description: |-
                      adminStateUp is the administrative state of the port,
                      which is up (true) or down (false). The default value is true.
                    type: boolean
                  allowedAddressPairs:
                    description: allowedAddressPairs are allowed addresses associated
                      with this port.
                    items:
                      properties:
                        ip:
                          description: |-
                            ip contains an IP address which a server connected to the port can
                            send packets with. It can be an IP Address or a CIDR (if supported
                            by the underlying extension plugin).
                          maxLength: 45
                          minLength: 1
                          type: string
                        mac:
                          description: |-
                            mac contains a MAC address which a server connected to the port can
                            send packets with. Defaults to the MAC address of the port.
                          maxLength: 17
                          minLength: 1
                          type: string
                      required:
                      - ip
                      type: object
                    maxItems: 128
                    type: array
                    x-kubernetes-list-type: atomic
                  description:
                    description: description is a human-readable description for the
                      resource.
                    maxLength: 255
                    minLength: 1
                    type: string
                  hostID:
                    description: hostID is the ID of host where the port resides.
                    maxLength: 36
                    type: string
                  macAddress:
                    description: macAddress is the MAC address of the port.
                    maxLength: 32
                    type: string
                  name:
                    description: name is a human-readable name of the port. If not
                      set, the object's name will be used.
                    maxLength: 255
                    minLength: 1
                    pattern: ^[^,]+$
                    type: string
                  networkRef:
                    description: networkRef is a reference to the ORC Network which
                      this port is associated with.
                    maxLength: 253
                    minLength: 1
                    type: string
                    x-kubernetes-validations:
                    - message: networkRef is immutable
                      rule: self == oldSelf
                  portSecurity:
                    default: Inherit
                    description: |-
                      portSecurity controls port security for this port.
                      When set to Enabled, port security is enabled.
                      When set to Disabled, port security is disabled and SecurityGroupRefs must be empty.
                      When set to Inherit (default), it takes the value from the network level.
                    enum:
                    - Enabled
                    - Disabled
                    - Inherit
                    type: string
                    x-kubernetes-validations:
                    - message: portSecurity cannot be changed to Inherit
                      rule: '!(oldSelf != ''Inherit'' && self == ''Inherit'')'
                  projectRef:
                    description: |-
                      projectRef is a reference to the ORC Project this resource is associated with.
                      Typically, only used by admin.
                    maxLength: 253
                    minLength: 1
                    type: string
                    x-kubernetes-validations:
                    - message: projectRef is immutable
                      rule: self == oldSelf
                  propagateUplinkStatus:
                    description: |-
                      propagateUplinkStatus represents the uplink status propagation of
                      the port.
                    type: boolean
                    x-kubernetes-validations:
                    - message: propagateUplinkStatus is immutable
                      rule: self == oldSelf
                  securityGroupRefs:
                    description: |-
                      securityGroupRefs are the names of the security groups associated
                      with this port.
                    items:
                      maxLength: 255
                      minLength: 1
                      pattern: ^[^,]+$
                      type: string
                    maxItems: 64
                    type: array
                    x-kubernetes-list-type: set
                  tags:
                    description: tags is a list of tags which will be applied to the
                      port.
                    items:
                      description: |-
                        NeutronTag represents a tag on a Neutron resource.
                        It may not be empty and may not contain commas.
                      maxLength: 255
                      minLength: 1
                      type: string
                    maxItems: 64
                    type: array
                    x-kubernetes-list-type: set
                  vnicType:
                    description: |-
                      vnicType specifies the type of vNIC which this port should be
                      attached to. This is used to determine which mechanism driver(s) to
                      be used to bind the port. The valid values are normal, macvtap,
                      direct, baremetal, direct-physical, virtio-forwarder, smart-nic and
                      remote-managed, although these values will not be validated in this
                      API to ensure compatibility with future neutron changes or custom
                      implementations. What type of vNIC is actually available depends on
                      deployments. If not specified, the Neutron default value is used.
                    maxLength: 64
                    type: string
                required:
                - networkRef
                type: object
                x-kubernetes-validations:
                - message: securityGroupRefs must be empty when portSecurity is set
                    to Disabled
                  rule: 'has(self.portSecurity) && self.portSecurity == ''Disabled''
                    ? !has(self.securityGroupRefs) : true'
                - message: allowedAddressPairs must be empty when portSecurity is
                    set to Disabled
                  rule: 'has(self.portSecurity) && self.portSecurity == ''Disabled''
                    ? !has(self.allowedAddressPairs) : true'
            required:
            - cloudCredentialsRef
            type: object
            x-kubernetes-validations:
            - message: resource must be specified when policy is managed
              rule: 'self.managementPolicy == ''managed'' ? has(self.resource) : true'
            - message: import may not be specified when policy is managed
              rule: 'self.managementPolicy == ''managed'' ? !has(self.__import__)
                : true'
            - message: resource may not be specified when policy is unmanaged
              rule: 'self.managementPolicy == ''unmanaged'' ? !has(self.resource)
                : true'
            - message: import must be specified when policy is unmanaged
              rule: 'self.managementPolicy == ''unmanaged'' ? has(self.__import__)
                : true'
            - message: managedOptions may only be provided when policy is managed
              rule: 'has(self.managedOptions) ? self.managementPolicy == ''managed''
                : true'
          status:
            description: status defines the observed state of the resource.
            properties:
              conditions:
                description: |-
                  conditions represents the observed status of the object.
                  Known .status.conditions.type are: "Available", "Progressing"

                  Available represents the availability of the OpenStack resource. If it is
                  true then the resource is ready for use.

                  Progressing indicates whether the controller is still attempting to
                  reconcile the current state of the OpenStack resource to the desired
                  state. Progressing will be False either because the desired state has
                  been achieved, or because some terminal error prevents it from ever being
                  achieved and the controller is no longer attempting to reconcile. If
                  Progressing is True, an observer waiting on the resource should continue
                  to wait.
                items:
                  description: Condition contains details for one aspect of the current
                    state of this API Resource.
                  properties:
                    lastTransitionTime:
                      description: |-
                        lastTransitionTime is the last time the condition transitioned from one status to another.
                        This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
                      format: date-time
                      type: string
                    message:
                      description: |-
                        message is a human readable message indicating details about the transition.
                        This may be an empty string.
                      maxLength: 32768
                      type: string
                    observedGeneration:
                      description: |-
                        observedGeneration represents the .metadata.generation that the condition was set based upon.
                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
                        with respect to the current state of the instance.
                      format: int64
                      minimum: 0
                      type: integer
                    reason:
                      description: |-
                        reason contains a programmatic identifier indicating the reason for the condition's last transition.
                        Producers of specific condition types may define expected values and meanings for this field,
                        and whether the values are considered a guaranteed API.
                        The value should be a CamelCase string.
                        This field may not be empty.
                      maxLength: 1024
                      minLength: 1
                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
                      type: string
                    status:
                      description: status of the condition, one of True, False, Unknown.
                      enum:
                      - "True"
                      - "False"
                      - Unknown
                      type: string
                    type:
                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
                      maxLength: 316
                      pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
                      type: string
                  required:
                  - lastTransitionTime
                  - message
                  - reason
                  - status
                  - type
                  type: object
                maxItems: 32
                type: array
                x-kubernetes-list-map-keys:
                - type
                x-kubernetes-list-type: map
              id:
                description: id is the unique identifier of the OpenStack resource.
                type: string
              resource:
                description: resource contains the observed state of the OpenStack
                  resource.
                properties:
                  adminStateUp:
                    description: |-
                      adminStateUp is the administrative state of the port,
                      which is up (true) or down (false).
                    type: boolean
                  allowedAddressPairs:
                    description: |-
                      allowedAddressPairs is a set of zero or more allowed address pair
                      objects each where address pair object contains an IP address and
                      MAC address.
                    items:
                      properties:
                        ip:
                          description: |-
                            ip contains an IP address which a server connected to the port can
                            send packets with.
                          maxLength: 1024
                          type: string
                        mac:
                          description: |-
                            mac contains a MAC address which a server connected to the port can
                            send packets with.
                          maxLength: 1024
                          type: string
                      type: object
                    maxItems: 128
                    type: array
                    x-kubernetes-list-type: atomic
                  createdAt:
                    description: createdAt shows the date and time when the resource
                      was created. The date and time stamp format is ISO 8601
                    format: date-time
                    type: string
                  description:
                    description: description is a human-readable description for the
                      resource.
                    maxLength: 1024
                    type: string
                  deviceID:
                    description: deviceID is the ID of the device that uses this port.
                    maxLength: 1024
                    type: string
                  deviceOwner:
                    description: deviceOwner is the entity type that uses this port.
                    maxLength: 1024
                    type: string
                  fixedIPs:
                    description: |-
                      fixedIPs is a set of zero or more fixed IP objects each where fixed
                      IP object contains an IP address and subnet ID from which the IP
                      address is assigned.
                    items:
                      properties:
                        ip:
                          description: ip contains a fixed IP address assigned to
                            the port.
                          maxLength: 1024
                          type: string
                        subnetID:
                          description: subnetID is the ID of the subnet this IP is
                            allocated from.
                          maxLength: 1024
                          type: string
                      type: object
                    maxItems: 128
                    type: array
                    x-kubernetes-list-type: atomic
                  hostID:
                    description: hostID is the ID of host where the port resides.
                    maxLength: 128
                    type: string
                  macAddress:
                    description: macAddress is the MAC address of the port.
                    maxLength: 1024
                    type: string
                  name:
                    description: name is the human-readable name of the resource.
                      Might not be unique.
                    maxLength: 1024
                    type: string
                  networkID:
                    description: networkID is the ID of the attached network.
                    maxLength: 1024
                    type: string
                  portSecurityEnabled:
                    description: portSecurityEnabled indicates whether port security
                      is enabled or not.
                    type: boolean
                  projectID:
                    description: projectID is the project owner of the resource.
                    maxLength: 1024
                    type: string
                  propagateUplinkStatus:
                    description: |-
                      propagateUplinkStatus represents the uplink status propagation of
                      the port.
                    type: boolean
                  revisionNumber:
                    description: revisionNumber optionally set via extensions/standard-attr-revisions
                    format: int64
                    type: integer
                  securityGroups:
                    description: securityGroups contains the IDs of security groups
                      applied to the port.
                    items:
                      maxLength: 1024
                      type: string
                    maxItems: 64
                    type: array
                    x-kubernetes-list-type: atomic
                  status:
                    description: status indicates the current status of the resource.
                    maxLength: 1024
                    type: string
                  tags:
                    description: tags is the list of tags on the resource.
                    items:
                      maxLength: 1024
                      type: string
                    maxItems: 64
                    type: array
                    x-kubernetes-list-type: atomic
                  updatedAt:
                    description: updatedAt shows the date and time when the resource
                      was updated. The date and time stamp format is ISO 8601
                    format: date-time
                    type: string
                  vnicType:
                    description: vnicType is the type of vNIC which this port is attached
                      to.
                    maxLength: 64
                    type: string
                type: object
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}