openstack.k-orc.cloud_images.yaml

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.17.1
  name: images.openstack.k-orc.cloud
spec:
  group: openstack.k-orc.cloud
  names:
    categories:
    - openstack
    kind: Image
    listKind: ImageList
    plural: images
    singular: image
  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: Message describing current progress status
      jsonPath: .status.conditions[?(@.type=='Progressing')].message
      name: Message
      type: string
    name: v1alpha1
    schema:
      openAPIV3Schema:
        description: Image 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:
                      name:
                        description: name specifies the name of a Glance image
                        maxLength: 255
                        minLength: 1
                        pattern: ^[^,]+$
                        type: string
                      tags:
                        description: tags is the list of tags on the resource.
                        items:
                          maxLength: 255
                          minLength: 1
                          type: string
                        maxItems: 64
                        type: array
                        x-kubernetes-list-type: set
                      visibility:
                        description: visibility specifies the visibility of a Glance
                          image.
                        enum:
                        - public
                        - private
                        - shared
                        - community
                        type: string
                    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
                  resyncPeriod:
                    default: 10h
                    description: |-
                      resyncPeriod specifies the interval after which a successfully
                      reconciled resource will be reconciled again to detect drift from the
                      desired state. Set to 0 to disable periodic resync. If not specified,
                      the default is 10 hours.
                    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:
                  content:
                    description: content specifies how to obtain the image content.
                    properties:
                      containerFormat:
                        default: bare
                        description: |-
                          containerFormat is the format of the image container.
                          qcow2 and raw images do not usually have a container. This is specified as "bare", which is also the default.
                          Permitted values are ami, ari, aki, bare, compressed, ovf, ova, and docker.
                        enum:
                        - ami
                        - ari
                        - aki
                        - bare
                        - ovf
                        - ova
                        - docker
                        - compressed
                        type: string
                      diskFormat:
                        description: |-
                          diskFormat is the format of the disk image.
                          Normal values are "qcow2", or "raw". Glance may be configured to support others.
                        enum:
                        - ami
                        - ari
                        - aki
                        - vhd
                        - vhdx
                        - vmdk
                        - raw
                        - qcow2
                        - vdi
                        - ploop
                        - iso
                        type: string
                      download:
                        description: |-
                          download describes how to obtain image data by downloading it from a URL.
                          Must be set when creating a managed image.
                        properties:
                          decompress:
                            description: |-
                              decompress specifies that the source data must be decompressed with the
                              given compression algorithm before being stored. Specifying Decompress
                              will disable the use of Glance's web-download, as web-download cannot
                              currently deterministically decompress downloaded content.
                            enum:
                            - xz
                            - gz
                            - bz2
                            type: string
                          hash:
                            description: |-
                              hash is a hash which will be used to verify downloaded data, i.e.
                              before any decompression. If not specified, no hash verification will be
                              performed. Specifying a Hash will disable the use of Glance's
                              web-download, as web-download cannot currently deterministically verify
                              the hash of downloaded content.
                            properties:
                              algorithm:
                                description: algorithm is the hash algorithm used
                                  to generate value.
                                enum:
                                - md5
                                - sha1
                                - sha256
                                - sha512
                                type: string
                              value:
                                description: value is the hash of the image data using
                                  Algorithm. It must be hex encoded using lowercase
                                  letters.
                                maxLength: 1024
                                minLength: 1
                                pattern: ^[0-9a-f]+$
                                type: string
                            required:
                            - algorithm
                            - value
                            type: object
                            x-kubernetes-validations:
                            - message: hash is immutable
                              rule: self == oldSelf
                          url:
                            description: url containing image data
                            format: uri
                            maxLength: 2048
                            type: string
                        required:
                        - url
                        type: object
                    required:
                    - diskFormat
                    - download
                    type: object
                    x-kubernetes-validations:
                    - message: content is immutable
                      rule: self == oldSelf
                  name:
                    description: |-
                      name will be the name of the created Glance image. If not specified, the
                      name of the Image object will be used.
                    maxLength: 255
                    minLength: 1
                    pattern: ^[^,]+$
                    type: string
                  properties:
                    description: properties is metadata available to consumers of
                      the image
                    properties:
                      architecture:
                        description: architecture is the CPU architecture that must
                          be supported by the hypervisor.
                        enum:
                        - aarch64
                        - alpha
                        - armv7l
                        - cris
                        - i686
                        - ia64
                        - lm32
                        - m68k
                        - microblaze
                        - microblazeel
                        - mips
                        - mipsel
                        - mips64
                        - mips64el
                        - openrisc
                        - parisc
                        - parisc64
                        - ppc
                        - ppc64
                        - ppcemb
                        - s390
                        - s390x
                        - sh4
                        - sh4eb
                        - sparc
                        - sparc64
                        - unicore32
                        - x86_64
                        - xtensa
                        - xtensaeb
                        type: string
                      hardware:
                        description: |-
                          hardware is a set of properties which control the virtual hardware
                          created by Nova.
                        properties:
                          cdromBus:
                            description: cdromBus specifies the type of disk controller
                              to attach CD-ROM devices to.
                            enum:
                            - scsi
                            - virtio
                            - uml
                            - xen
                            - ide
                            - usb
                            - lxc
                            type: string
                          cpuCores:
                            description: cpuCores is the preferred number of cores
                              to expose to the guest
                            format: int32
                            minimum: 1
                            type: integer
                          cpuPolicy:
                            description: |-
                              cpuPolicy is used to pin the virtual CPUs (vCPUs) of instances to the
                              host's physical CPU cores (pCPUs). Host aggregates should be used to
                              separate these pinned instances from unpinned instances as the latter
                              will not respect the resourcing requirements of the former.

                              Permitted values are shared (the default), and dedicated.

                              shared: The guest vCPUs will be allowed to freely float across host
                              pCPUs, albeit potentially constrained by NUMA policy.

                              dedicated: The guest vCPUs will be strictly pinned to a set of host
                              pCPUs. In the absence of an explicit vCPU topology request, the
                              drivers typically expose all vCPUs as sockets with one core and one
                              thread. When strict CPU pinning is in effect the guest CPU topology
                              will be setup to match the topology of the CPUs to which it is
                              pinned. This option implies an overcommit ratio of 1.0. For example,
                              if a two vCPU guest is pinned to a single host core with two threads,
                              then the guest will get a topology of one socket, one core, two
                              threads.
                            enum:
                            - shared
                            - dedicated
                            type: string
                          cpuSockets:
                            description: cpuSockets is the preferred number of sockets
                              to expose to the guest
                            format: int32
                            minimum: 1
                            type: integer
                          cpuThreadPolicy:
                            description: |-
                              cpuThreadPolicy further refines a CPUPolicy of 'dedicated' by stating
                              how hardware CPU threads in a simultaneous multithreading-based (SMT)
                              architecture be used. SMT-based architectures include Intel
                              processors with Hyper-Threading technology. In these architectures,
                              processor cores share a number of components with one or more other
                              cores. Cores in such architectures are commonly referred to as
                              hardware threads, while the cores that a given core share components
                              with are known as thread siblings.

                              Permitted values are prefer (the default), isolate, and require.

                              prefer: The host may or may not have an SMT architecture. Where an
                              SMT architecture is present, thread siblings are preferred.

                              isolate: The host must not have an SMT architecture or must emulate a
                              non-SMT architecture. If the host does not have an SMT architecture,
                              each vCPU is placed on a different core as expected. If the host does
                              have an SMT architecture - that is, one or more cores have thread
                              siblings - then each vCPU is placed on a different physical core. No
                              vCPUs from other guests are placed on the same core. All but one
                              thread sibling on each utilized core is therefore guaranteed to be
                              unusable.

                              require: The host must have an SMT architecture. Each vCPU is
                              allocated on thread siblings. If the host does not have an SMT
                              architecture, then it is not used. If the host has an SMT
                              architecture, but not enough cores with free thread siblings are
                              available, then scheduling fails.
                            enum:
                            - prefer
                            - isolate
                            - require
                            type: string
                          cpuThreads:
                            description: cpuThreads is the preferred number of threads
                              to expose to the guest
                            format: int32
                            minimum: 1
                            type: integer
                          diskBus:
                            description: diskBus specifies the type of disk controller
                              to attach disk devices to.
                            enum:
                            - scsi
                            - virtio
                            - uml
                            - xen
                            - ide
                            - usb
                            - lxc
                            type: string
                          qemuGuestAgent:
                            description: qemuGuestAgent enables QEMU guest agent.
                            type: boolean
                          rngModel:
                            description: |-
                              rngModel adds a random-number generator device to the image’s instances.
                              This image property by itself does not guarantee that a hardware RNG will be used;
                              it expresses a preference that may or may not be satisfied depending upon Nova configuration.
                            maxLength: 255
                            type: string
                          scsiModel:
                            description: |-
                              scsiModel enables the use of VirtIO SCSI (virtio-scsi) to provide
                              block device access for compute instances; by default, instances use
                              VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI
                              controller device that provides improved scalability and performance,
                              and supports advanced SCSI hardware.

                              The only permitted value is virtio-scsi.
                            enum:
                            - virtio-scsi
                            type: string
                          vifModel:
                            description: |-
                              vifModel specifies the model of virtual network interface device to use.

                              Permitted values are e1000, e1000e, ne2k_pci, pcnet, rtl8139, virtio,
                              and vmxnet3.
                            enum:
                            - e1000
                            - e1000e
                            - ne2k_pci
                            - pcnet
                            - rtl8139
                            - virtio
                            - vmxnet3
                            type: string
                        type: object
                      hypervisorType:
                        description: hypervisorType is the hypervisor type
                        enum:
                        - hyperv
                        - ironic
                        - lxc
                        - qemu
                        - uml
                        - vmware
                        - xen
                        type: string
                      minDiskGB:
                        description: minDiskGB is the minimum amount of disk space
                          in GB that is required to boot the image
                        format: int32
                        minimum: 1
                        type: integer
                      minMemoryMB:
                        description: minMemoryMB is the minimum amount of RAM in MB
                          that is required to boot the image.
                        format: int32
                        minimum: 1
                        type: integer
                      operatingSystem:
                        description: |-
                          operatingSystem is a set of properties that specify and influence the behavior
                          of the operating system within the virtual machine.
                        properties:
                          distro:
                            description: distro is the common name of the operating
                              system distribution in lowercase.
                            enum:
                            - arch
                            - centos
                            - debian
                            - fedora
                            - freebsd
                            - gentoo
                            - mandrake
                            - mandriva
                            - mes
                            - msdos
                            - netbsd
                            - netware
                            - openbsd
                            - opensolaris
                            - opensuse
                            - rocky
                            - rhel
                            - sled
                            - ubuntu
                            - windows
                            type: string
                          version:
                            description: version is the operating system version as
                              specified by the distributor.
                            maxLength: 255
                            type: string
                        type: object
                    type: object
                    x-kubernetes-validations:
                    - message: properties is immutable
                      rule: self == oldSelf
                  protected:
                    description: |-
                      protected specifies that the image is protected from deletion.
                      If not specified, the default is false.
                    type: boolean
                  tags:
                    description: tags is a list of tags which will be applied to the
                      image. A tag has a maximum length of 255 characters.
                    items:
                      maxLength: 255
                      minLength: 1
                      type: string
                    maxItems: 64
                    type: array
                    x-kubernetes-list-type: set
                  visibility:
                    description: visibility of the image
                    enum:
                    - public
                    - private
                    - shared
                    - community
                    type: string
                type: object
            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'
            - message: resource content must be specified when not importing
              rule: '!has(self.__import__) ? has(self.resource.content) : 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
              downloadAttempts:
                description: downloadAttempts is the number of times the controller
                  has attempted to download the image contents
                format: int32
                type: integer
              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:
                  hash:
                    description: |-
                      hash is the hash of the image data published by Glance. Note that this is
                      a hash of the data stored internally by Glance, which will have been
                      decompressed and potentially format converted depending on server-side
                      configuration which is not visible to clients. It is expected that this
                      hash will usually differ from the download hash.
                    properties:
                      algorithm:
                        description: algorithm is the hash algorithm used to generate
                          value.
                        enum:
                        - md5
                        - sha1
                        - sha256
                        - sha512
                        type: string
                      value:
                        description: value is the hash of the image data using Algorithm.
                          It must be hex encoded using lowercase letters.
                        maxLength: 1024
                        minLength: 1
                        pattern: ^[0-9a-f]+$
                        type: string
                    required:
                    - algorithm
                    - value
                    type: object
                  name:
                    description: name is a Human-readable name for the image. Might
                      not be unique.
                    maxLength: 1024
                    type: string
                  protected:
                    description: protected specifies that the image is protected from
                      deletion.
                    type: boolean
                  sizeB:
                    description: sizeB is the size of the image data, in bytes
                    format: int64
                    type: integer
                  status:
                    description: status is the image status as reported by Glance
                    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
                  virtualSizeB:
                    description: virtualSizeB is the size of the disk the image data
                      represents, in bytes
                    format: int64
                    type: integer
                  visibility:
                    description: visibility of the image
                    maxLength: 1024
                    type: string
                type: object
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}