hypervisor-crd.yaml

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.19.0
  name: hypervisors.kvm.cloud.sap
spec:
  group: kvm.cloud.sap
  names:
    kind: Hypervisor
    listKind: HypervisorList
    plural: hypervisors
    shortNames:
    - hv
    singular: hypervisor
  scope: Cluster
  versions:
  - additionalPrinterColumns:
    - jsonPath: .metadata.labels.topology\.kubernetes\.io/zone
      name: Zone
      priority: 2
      type: string
    - jsonPath: .metadata.labels.kubernetes\.metal\.cloud\.sap/bb
      name: Building Block
      priority: 2
      type: string
    - jsonPath: .metadata.labels.worker\.garden\.sapcloud\.io/group
      name: Group
      priority: 2
      type: string
    - jsonPath: .status.conditions[?(@.type=="Ready")].status
      name: Ready
      type: string
    - jsonPath: .status.conditions[?(@.type=="Ready")].reason
      name: State
      type: string
    - jsonPath: .status.conditions[?(@.type=="Tainted")].message
      name: Taint
      type: string
    - jsonPath: .spec.lifecycleEnabled
      name: Lifecycle
      type: boolean
    - jsonPath: .spec.highAvailability
      name: High Availability
      type: boolean
    - jsonPath: .spec.skipTests
      name: Skip Tests
      type: boolean
    - jsonPath: .status.operatingSystem.prettyVersion
      name: Version
      type: string
    - jsonPath: .status.internalIp
      name: IP
      type: string
    - jsonPath: .status.numInstances
      name: Instances
      type: integer
    - jsonPath: .status.operatingSystem.hardwareModel
      name: Hardware
      priority: 2
      type: string
    - jsonPath: .status.operatingSystem.kernelRelease
      name: Kernel
      priority: 2
      type: string
    - jsonPath: .status.conditions[?(@.type=="Onboarding")].reason
      name: Onboarding
      priority: 3
      type: string
    - jsonPath: .status.serviceId
      name: Service ID
      priority: 3
      type: string
    - jsonPath: .status.hypervisorId
      name: Hypervisor ID
      priority: 3
      type: string
    - jsonPath: .metadata.creationTimestamp
      name: Age
      type: date
    name: v1
    schema:
      openAPIV3Schema:
        description: Hypervisor is the Schema for the hypervisors API
        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: HypervisorSpec defines the desired state of Hypervisor
            properties:
              aggregates:
                default: []
                description: Aggregates are used to apply aggregates to the hypervisor.
                items:
                  type: string
                type: array
              allowedProjects:
                default: []
                description: |-
                  AllowedProjects defines which openstack projects are allowed to schedule
                  instances on this hypervisor. The values of this list should be project
                  uuids. If left empty, all projects are allowed.
                items:
                  type: string
                type: array
              createCertManagerCertificate:
                default: false
                description: |-
                  Require to issue a certificate from cert-manager for the hypervisor, to be used for
                  secure communication with the libvirt API.
                type: boolean
              customTraits:
                default: []
                description: CustomTraits are used to apply custom traits to the hypervisor.
                items:
                  type: string
                type: array
              evacuateOnReboot:
                default: true
                description: EvacuateOnReboot request an evacuation of all instances
                  before reboot.
                type: boolean
              highAvailability:
                default: true
                description: HighAvailability is used to enable the high availability
                  handling of the hypervisor.
                type: boolean
              installCertificate:
                default: true
                description: InstallCertificate is used to enable the installations
                  of the certificates via kvm-node-agent.
                type: boolean
              lifecycleEnabled:
                default: true
                description: LifecycleEnabled enables the lifecycle management of
                  the hypervisor via hypervisor-operator.
                type: boolean
              maintenance:
                description: Maintenance indicates whether the hypervisor is in maintenance
                  mode.
                enum:
                - ""
                - manual
                - auto
                - ha
                - termination
                type: string
              maintenanceReason:
                description: MaintenanceReason provides the reason for manual maintenance
                  mode.
                type: string
              overcommit:
                additionalProperties:
                  type: number
                description: |-
                  Overcommit specifies the desired overcommit ratio by resource type.

                  If no overcommit is specified for a resource type, the default overcommit
                  ratio of 1.0 should be applied, i.e. the effective capacity is the same
                  as the actual capacity.

                  If the overcommit ratio results in a fractional effective capacity,
                  the effective capacity is expected to be rounded down. This allows
                  gradually adjusting the hypervisor capacity.

                  It is validated that all overcommit ratios are greater than or equal to
                  1.0, if specified. For this we don't need extra validating webhooks.
                  See: https://kubernetes.io/blog/2022/09/23/crd-validation-rules-beta/#crd-transition-rules
                type: object
                x-kubernetes-validations:
                - message: overcommit ratios must be >= 1.0
                  rule: self.all(k, self[k] >= 1.0)
              reboot:
                default: false
                description: Reboot request an reboot after successful installation
                  of an upgrade.
                type: boolean
              skipTests:
                default: false
                description: SkipTests skips the tests during the onboarding process.
                type: boolean
              version:
                description: OperatingSystemVersion represents the desired operating
                  system version.
                type: string
            required:
            - aggregates
            - allowedProjects
            - createCertManagerCertificate
            - customTraits
            - evacuateOnReboot
            - highAvailability
            - installCertificate
            - lifecycleEnabled
            - reboot
            - skipTests
            type: object
            x-kubernetes-validations:
            - message: spec is immutable when maintenance is 'termination'; can only
                change maintenance to 'ha'
              rule: '!has(oldSelf.maintenance) || oldSelf.maintenance != ''termination''
                || self.maintenance == ''ha'' || self == oldSelf'
            - message: maintenanceReason must be non-empty when maintenance is 'manual'
              rule: '!has(self.maintenance) || self.maintenance != ''manual'' || (has(self.maintenanceReason)
                && self.maintenanceReason.size() > 0)'
          status:
            description: HypervisorStatus defines the observed state of Hypervisor
            properties:
              aggregates:
                description: Aggregates are the applied aggregates of the hypervisor
                  with their names and UUIDs.
                items:
                  description: Aggregate represents an OpenStack aggregate with its
                    name and UUID.
                  properties:
                    metadata:
                      additionalProperties:
                        type: string
                      description: Metadata is the metadata of the aggregate as key-value
                        pairs.
                      type: object
                    name:
                      description: Name is the name of the aggregate.
                      type: string
                    uuid:
                      description: UUID is the unique identifier of the aggregate.
                      type: string
                  required:
                  - name
                  - uuid
                  type: object
                type: array
              allocation:
                additionalProperties:
                  anyOf:
                  - type: integer
                  - type: string
                  pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                  x-kubernetes-int-or-string: true
                description: Auto-discovered resource allocation of all hosted VMs.
                type: object
              capabilities:
                description: Auto-discovered capabilities as reported by libvirt.
                properties:
                  cpuArch:
                    default: unknown
                    description: The hosts CPU architecture (not the guests).
                    type: string
                  cpus:
                    anyOf:
                    - type: integer
                    - type: string
                    description: Total host cpus available as a sum of cpus over all
                      numa cells.
                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                    x-kubernetes-int-or-string: true
                  memory:
                    anyOf:
                    - type: integer
                    - type: string
                    description: Total host memory available as a sum of memory over
                      all numa cells.
                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                    x-kubernetes-int-or-string: true
                type: object
              capacity:
                additionalProperties:
                  anyOf:
                  - type: integer
                  - type: string
                  pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                  x-kubernetes-int-or-string: true
                description: |-
                  Auto-discovered capacity of the hypervisor.

                  Note that this capacity does not include the applied overcommit ratios,
                  and represents the actual capacity of the hypervisor. Use the
                  effective capacity field to get the capacity considering the applied
                  overcommit ratios.
                type: object
              cells:
                description: Auto-discovered cells on this hypervisor.
                items:
                  description: Cell represents a NUMA cell on the hypervisor.
                  properties:
                    allocation:
                      additionalProperties:
                        anyOf:
                        - type: integer
                        - type: string
                        pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                        x-kubernetes-int-or-string: true
                      description: Auto-discovered resource allocation of all hosted
                        VMs in this cell.
                      type: object
                    capacity:
                      additionalProperties:
                        anyOf:
                        - type: integer
                        - type: string
                        pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                        x-kubernetes-int-or-string: true
                      description: |-
                        Auto-discovered capacity of this cell.

                        Note that this capacity does not include the applied overcommit ratios,
                        and represents the actual capacity of the cell. Use the effective capacity
                        field to get the capacity considering the applied overcommit ratios.
                      type: object
                    cellID:
                      description: Cell ID.
                      format: int64
                      type: integer
                    effectiveCapacity:
                      additionalProperties:
                        anyOf:
                        - type: integer
                        - type: string
                        pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                        x-kubernetes-int-or-string: true
                      description: |-
                        Auto-discovered capacity of this cell, considering the
                        applied overcommit ratios.

                        In case no overcommit ratio is specified for a resource type, the default
                        overcommit ratio of 1 should be applied, meaning the effective capacity
                        is the same as the actual capacity.

                        If the overcommit ratio results in a fractional effective capacity, the
                        effective capacity is expected to be rounded down.
                      type: object
                  required:
                  - cellID
                  type: object
                type: array
              conditions:
                description: Represents the Hypervisor node conditions.
                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
                type: array
              domainCapabilities:
                description: |-
                  Auto-discovered domain capabilities relevant to check if a VM
                  can be scheduled on the hypervisor.
                properties:
                  arch:
                    default: unknown
                    description: The available domain cpu architecture.
                    type: string
                  hypervisorType:
                    default: unknown
                    description: The supported type of virtualization for domains,
                      such as "ch".
                    type: string
                  supportedCpuModes:
                    default: []
                    description: |-
                      Supported cpu modes for domains.

                      The format of this list is cpu mode, and if specified, a specific
                      submode. For example, the take the following xml domain cpu definition:

                      <mode name='host-passthrough' supported='yes'>
                        <enum name='hostPassthroughMigratable'/>
                      </mode>

                      The corresponding entries in this list would be "host-passthrough" and
                      "host-passthrough/migratable".
                    items:
                      type: string
                    type: array
                  supportedDevices:
                    default: []
                    description: |-
                      Supported devices for domains.

                      The format of this list is the device type, and if specified, a specific
                      model. For example, the take the following xml domain device definition:

                      <video supported='yes'>
                        <enum name='modelType'>
                          <value>nvidia</value>
                        </enum>
                      </video>

                      The corresponding entries in this list would be "video" and "video/nvidia".
                    items:
                      type: string
                    type: array
                  supportedFeatures:
                    default: []
                    description: |-
                      Supported features for domains, such as "sev" or "sgx".

                      This is a flat list of supported features, meaning the following xml:

                      <features>
                        <sev supported='no'/>
                        <sgx supported='no'/>
                      </features>

                      Would correspond to the entries "sev" and "sgx" in this list.
                    items:
                      type: string
                    type: array
                type: object
              effectiveCapacity:
                additionalProperties:
                  anyOf:
                  - type: integer
                  - type: string
                  pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                  x-kubernetes-int-or-string: true
                description: |-
                  Auto-discovered capacity of the hypervisor, considering the
                  applied overcommit ratios.

                  In case no overcommit ratio is specified for a resource type, the default
                  overcommit ratio of 1 should be applied, meaning the effective capacity
                  is the same as the actual capacity.

                  If the overcommit ratio results in a fractional effective capacity, the
                  effective capacity is expected to be rounded down.
                type: object
              evicted:
                description: Evicted indicates whether the hypervisor is evicted.
                  (no instances left with active maintenance mode)
                type: boolean
              hypervisorId:
                description: HypervisorID is the unique identifier of the hypervisor
                  in OpenStack.
                type: string
              hypervisorVersion:
                default: unknown
                description: Represents the Hypervisor version
                type: string
              instances:
                description: Represents the Hypervisor hosted Virtual Machines
                items:
                  properties:
                    active:
                      description: Represents the instance state.
                      type: boolean
                    id:
                      description: Represents the instance ID (uuidv4).
                      type: string
                    name:
                      description: Represents the instance name.
                      type: string
                  required:
                  - active
                  - id
                  - name
                  type: object
                type: array
              internalIp:
                description: InternalIP is the internal IP address of the hypervisor.
                type: string
              libVirtVersion:
                default: unknown
                description: Represents the LibVirt version.
                type: string
              numInstances:
                default: 0
                description: Represent the num of instances
                type: integer
              operatingSystem:
                description: Represents the Operating System status.
                properties:
                  firmwareDate:
                    description: FirmwareDate
                    format: date-time
                    type: string
                  firmwareVendor:
                    description: FirmwareVendor
                    type: string
                  firmwareVersion:
                    description: FirmwareVersion
                    type: string
                  gardenLinuxCommitID:
                    description: Represents the Garden Linux build commit id
                    type: string
                  gardenLinuxFeatures:
                    description: Represents the Garden Linux Feature Set
                    items:
                      type: string
                    type: array
                  hardwareModel:
                    description: HardwareModel
                    type: string
                  hardwareSerial:
                    description: HardwareSerial
                    type: string
                  hardwareVendor:
                    description: HardwareVendor
                    type: string
                  kernelCommandLine:
                    description: KernelCommandLine contains the raw kernel boot parameters
                      from /proc/cmdline.
                    type: string
                  kernelName:
                    description: KernelName
                    type: string
                  kernelRelease:
                    description: KernelRelease
                    type: string
                  kernelVersion:
                    description: KernelVersion
                    type: string
                  prettyVersion:
                    description: PrettyVersion
                    type: string
                  variantID:
                    description: Identifying a specific variant or edition of the
                      operating system
                    type: string
                  version:
                    description: Represents the Operating System version.
                    type: string
                type: object
              serviceId:
                description: ServiceID is the unique identifier of the compute service
                  in OpenStack.
                type: string
              specHash:
                type: string
              traits:
                description: Traits are the applied traits of the hypervisor.
                items:
                  type: string
                type: array
              updateStatus:
                description: Represents the Hypervisor update status.
                properties:
                  inProgress:
                    default: false
                    description: Represents a running Operating System update.
                    type: boolean
                  installed:
                    default: unknown
                    description: Represents the Operating System installed update
                      version.
                    type: string
                  retry:
                    default: 3
                    description: Represents the number of retries.
                    type: integer
                required:
                - inProgress
                - retry
                type: object
            required:
            - numInstances
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}