operator.openshift.io_mustgathers.yaml

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.19.0
  name: mustgathers.operator.openshift.io
spec:
  group: operator.openshift.io
  names:
    kind: MustGather
    listKind: MustGatherList
    plural: mustgathers
    singular: mustgather
  scope: Namespaced
  versions:
  - name: v1alpha1
    schema:
      openAPIV3Schema:
        description: MustGather is the Schema for the mustgathers 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: MustGatherSpec defines the desired state of MustGather
            properties:
              gatherSpec:
                description: |-
                  GatherSpec allows overriding the command and/or arguments for the custom must-gather image
                  and configures time-based collection filters.
                  This field is ignored if ImageStreamRef is not specified.
                properties:
                  args:
                    description: |-
                      Args is a string array of arguments passed to the custom image's command.
                      This field is only honored when a custom image IS specified via imageStreamRef.
                    items:
                      type: string
                    maxItems: 256
                    type: array
                  audit:
                    description: |-
                      Audit specifies whether to collect audit logs. This is translated to a signal
                      or command that can be respected by the default image
                      or any custom image designed to do so.
                    type: boolean
                  command:
                    description: |-
                      Command is a string array representing the entrypoint for the custom image.
                      This field is only honored when a custom image IS specified via imageStreamRef.
                    items:
                      type: string
                    maxItems: 256
                    type: array
                  since:
                    description: |-
                      Since only returns logs newer than a relative duration like "2h" or "30m".
                      This is passed to the must-gather script to filter log collection.
                      Only one of since or sinceTime may be specified.
                    format: duration
                    type: string
                  sinceTime:
                    description: |-
                      SinceTime only returns logs after a specific date/time (RFC3339 format).
                      This is passed to the must-gather script to filter log collection.
                      Only one of since or sinceTime may be specified.
                    format: date-time
                    type: string
                type: object
                x-kubernetes-validations:
                - message: only one of since or sinceTime may be specified
                  rule: '!(has(self.since) && has(self.sinceTime))'
              imageStreamRef:
                description: |-
                  ImageStreamRef specifies a custom image from the allowlist to be used for the
                  must-gather run.
                properties:
                  name:
                    description: Name is the name of the ImageStream resource in the
                      operator's namespace.
                    type: string
                  tag:
                    description: Tag is the name of the tag within the ImageStream.
                    type: string
                required:
                - name
                - tag
                type: object
              mustGatherTimeout:
                description: |-
                  A time limit for gather command to complete a floating point number with a suffix:
                  "s" for seconds, "m" for minutes, "h" for hours.
                  Will default to no time limit.
                format: duration
                type: string
              retainResourcesOnCompletion:
                default: false
                description: |-
                  A flag to specify if resources (secret, job, pods) should be retained when the MustGather completes.
                  If set to true, resources will be retained. If false or not set, resources will be deleted (default behavior).
                type: boolean
              serviceAccountName:
                default: default
                description: the service account to use to run the must gather job
                  pod, defaults to default
                type: string
              storage:
                description: |-
                  The storage configuration for persisting the collected must-gather tar archive.
                  If not specified, an ephemeral volume is used which will not persist
                  the tar archive on the cluster.
                properties:
                  persistentVolume:
                    description: persistentVolume defines the configuration for a
                      PersistentVolume.
                    properties:
                      claim:
                        description: claim defines the PersistentVolumeClaim to use.
                        properties:
                          name:
                            description: |-
                              name defines the PersistentVolumeClaim to use,
                              should be already present in the same namespace.
                            maxLength: 253
                            type: string
                            x-kubernetes-validations:
                            - message: a lowercase RFC 1123 subdomain must consist
                                of lower case alphanumeric characters, '-' or '.',
                                and must start and end with an alphanumeric character.
                              rule: '!format.dns1123Subdomain().validate(self).hasValue()'
                        required:
                        - name
                        type: object
                      subPath:
                        description: subPath defines the path to a sub directory within
                          the PersistentVolume to use.
                        type: string
                    required:
                    - claim
                    type: object
                  type:
                    description: |-
                      type defines the type of storage to use.
                      Available storage types are PersistentVolume only.
                    enum:
                    - PersistentVolume
                    type: string
                required:
                - persistentVolume
                - type
                type: object
              uploadTarget:
                description: |-
                  The target location for the must-gather bundle to be uploaded to.
                  If not specified, the bundle will not be uploaded.
                properties:
                  sftp:
                    description: SFTP details for the upload.
                    properties:
                      caseID:
                        description: The ID of the case this must gather will be uploaded
                          to
                        type: string
                      caseManagementAccountSecretRef:
                        description: the secret container a username and password
                          field to be used to authenticate with red hat case management
                          systems
                        properties:
                          name:
                            default: ""
                            description: |-
                              Name of the referent.
                              This field is effectively required, but due to backwards compatibility is
                              allowed to be empty. Instances of this type with an empty value here are
                              almost certainly wrong.
                              More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                            type: string
                        type: object
                        x-kubernetes-map-type: atomic
                      host:
                        default: sftp.access.redhat.com
                        description: |-
                          host specifies the SFTP server hostname.
                          The host name of the SFTP server
                        type: string
                      internalUser:
                        default: false
                        description: |-
                          A flag to specify if the upload user provided in the caseManagementAccountSecret is a RH internal user.
                          See documentation for further information.
                        type: boolean
                    required:
                    - caseID
                    - caseManagementAccountSecretRef
                    type: object
                    x-kubernetes-validations:
                    - message: caseID must not be empty
                      rule: size(self.caseID) > 0
                    - message: caseManagementAccountSecretRef.name must not be empty
                      rule: size(self.caseManagementAccountSecretRef.name) > 0
                  type:
                    description: type defines the method used for uploading to a specific
                      target.
                    enum:
                    - SFTP
                    type: string
                required:
                - type
                type: object
                x-kubernetes-validations:
                - message: sftp upload target config is required when upload type
                    is SFTP, and forbidden otherwise
                  rule: 'has(self.type) && self.type == ''SFTP'' ? has(self.sftp)
                    : !has(self.sftp)'
            type: object
            x-kubernetes-validations:
            - message: command and args in gatherSpec can only be set when imageStreamRef
                is specified
              rule: '!(has(self.gatherSpec) && ((has(self.gatherSpec.command) && size(self.gatherSpec.command)
                > 0) || (has(self.gatherSpec.args) && size(self.gatherSpec.args) >
                0))) || has(self.imageStreamRef)'
          status:
            description: MustGatherStatus defines the observed state of MustGather
            properties:
              completed:
                type: boolean
              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
              lastUpdate:
                format: date-time
                type: string
              reason:
                type: string
              status:
                type: string
            required:
            - completed
            type: object
        type: object
        x-kubernetes-validations:
        - message: spec values are immutable once set
          rule: '!has(oldSelf.spec) || self.spec == oldSelf.spec'
    served: true
    storage: true
    subresources:
      status: {}