cloudfoundry/cf-k8s-controllers

View on GitHub
helm/korifi/controllers/crds/korifi.cloudfoundry.org_cfprocesses.yaml

Summary

Maintainability
Test Coverage
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.15.0
  name: cfprocesses.korifi.cloudfoundry.org
spec:
  group: korifi.cloudfoundry.org
  names:
    kind: CFProcess
    listKind: CFProcessList
    plural: cfprocesses
    singular: cfprocess
  scope: Namespaced
  versions:
  - name: v1alpha1
    schema:
      openAPIV3Schema:
        description: CFProcess is the Schema for the cfprocesses 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: CFProcessSpec defines the desired state of CFProcess
            properties:
              appRef:
                description: A reference to the CFApp that owns this CFProcess. The
                  CFApp must be in the same namespace.
                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.
                      TODO: Add other useful fields. apiVersion, kind, uid?
                      More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                      TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
                    type: string
                type: object
                x-kubernetes-map-type: atomic
              command:
                description: Command string used to run this process on the app image.
                  This is analogous to command in k8s and ENTRYPOINT in Docker
                type: string
              desiredInstances:
                description: The desired number of replicas to deploy
                type: integer
              detectedCommand:
                description: The default command for this process as defined by the
                  build. This field is ignored when the Command field is set
                type: string
              diskQuotaMB:
                description: The disk limit in MiB
                format: int64
                type: integer
              healthCheck:
                description: Used to build the Liveness and Readiness Probes for the
                  process' AppWorkload.
                properties:
                  data:
                    description: The input parameters for the liveness and readiness
                      probes in kubernetes
                    properties:
                      httpEndpoint:
                        description: The http endpoint to use with "http" healthchecks
                        type: string
                      invocationTimeoutSeconds:
                        format: int64
                        type: integer
                      timeoutSeconds:
                        format: int64
                        type: integer
                    required:
                    - invocationTimeoutSeconds
                    - timeoutSeconds
                    type: object
                  type:
                    description: |-
                      The type of Health Check the App process will use
                      Valid values are "http", "port", and "process".
                      For processType "web", the default type is "port". For all other processes, the default is "process".
                    enum:
                    - http
                    - port
                    - process
                    - ""
                    type: string
                required:
                - data
                - type
                type: object
              memoryMB:
                description: The memory limit in MiB
                format: int64
                type: integer
              ports:
                description: |-
                  The ports to expose
                  Deprecated: No longer used
                items:
                  format: int32
                  type: integer
                type: array
              processType:
                description: The name of the process within the CFApp (e.g. "web")
                type: string
            required:
            - appRef
            - diskQuotaMB
            - healthCheck
            - memoryMB
            - processType
            type: object
          status:
            description: CFProcessStatus defines the observed state of CFProcess
            properties:
              actualInstances:
                format: int32
                type: integer
              conditions:
                items:
                  description: "Condition contains details for one aspect of the current
                    state of this API Resource.\n---\nThis struct is intended for
                    direct use as an array at the field path .status.conditions.  For
                    example,\n\n\n\ttype FooStatus struct{\n\t    // Represents the
                    observations of a foo's current state.\n\t    // Known .status.conditions.type
                    are: \"Available\", \"Progressing\", and \"Degraded\"\n\t    //
                    +patchMergeKey=type\n\t    // +patchStrategy=merge\n\t    // +listType=map\n\t
                    \   // +listMapKey=type\n\t    Conditions []metav1.Condition `json:\"conditions,omitempty\"
                    patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
                    \   // other fields\n\t}"
                  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.
                        ---
                        Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
                        useful (see .node.status.conditions), the ability to deconflict is important.
                        The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
                      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
              observedGeneration:
                description: ObservedGeneration captures the latest generation of
                  the CFProcess that has been reconciled
                format: int64
                type: integer
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}