...

Text file src/github.com/openshift/api/platform/v1alpha1/platformoperators.crd.yaml

Documentation: github.com/openshift/api/platform/v1alpha1

     1apiVersion: apiextensions.k8s.io/v1
     2kind: CustomResourceDefinition
     3metadata:
     4  annotations:
     5    api-approved.openshift.io: https://github.com/openshift/api/pull/1234
     6    exclude.release.openshift.io/internal-openshift-hosted: "true"
     7    include.release.openshift.io/self-managed-high-availability: "true"
     8    include.release.openshift.io/single-node-developer: "true"
     9    release.openshift.io/feature-set: TechPreviewNoUpgrade
    10  creationTimestamp: null
    11  name: platformoperators.platform.openshift.io
    12spec:
    13  group: platform.openshift.io
    14  names:
    15    kind: PlatformOperator
    16    listKind: PlatformOperatorList
    17    plural: platformoperators
    18    singular: platformoperator
    19  scope: Cluster
    20  versions:
    21    - name: v1alpha1
    22      schema:
    23        openAPIV3Schema:
    24          description: "PlatformOperator is the Schema for the PlatformOperators API. \n Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support."
    25          type: object
    26          required:
    27            - spec
    28          properties:
    29            apiVersion:
    30              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'
    31              type: string
    32            kind:
    33              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'
    34              type: string
    35            metadata:
    36              type: object
    37            spec:
    38              description: PlatformOperatorSpec defines the desired state of PlatformOperator.
    39              type: object
    40              required:
    41                - package
    42              properties:
    43                package:
    44                  description: package contains the desired package and its configuration for this PlatformOperator.
    45                  type: object
    46                  required:
    47                    - name
    48                  properties:
    49                    name:
    50                      description: "name contains the desired OLM-based Operator package name that is defined in an existing CatalogSource resource in the cluster. \n This configured package will be managed with the cluster's lifecycle. In the current implementation, it will be retrieving this name from a list of supported operators out of the catalogs included with OpenShift. \n ---"
    51                      type: string
    52                      maxLength: 56
    53                      pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?'
    54            status:
    55              description: PlatformOperatorStatus defines the observed state of PlatformOperator
    56              type: object
    57              properties:
    58                activeBundleDeployment:
    59                  description: activeBundleDeployment is the reference to the BundleDeployment resource that's being managed by this PO resource. If this field is not populated in the status then it means the PlatformOperator has either not been installed yet or is failing to install.
    60                  type: object
    61                  required:
    62                    - name
    63                  properties:
    64                    name:
    65                      description: name is the metadata.name of the referenced BundleDeployment object.
    66                      type: string
    67                conditions:
    68                  description: conditions represent the latest available observations of a platform operator's current state.
    69                  type: array
    70                  items:
    71                    description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions.  For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
    72                    type: object
    73                    required:
    74                      - lastTransitionTime
    75                      - message
    76                      - reason
    77                      - status
    78                      - type
    79                    properties:
    80                      lastTransitionTime:
    81                        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.
    82                        type: string
    83                        format: date-time
    84                      message:
    85                        description: message is a human readable message indicating details about the transition. This may be an empty string.
    86                        type: string
    87                        maxLength: 32768
    88                      observedGeneration:
    89                        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.
    90                        type: integer
    91                        format: int64
    92                        minimum: 0
    93                      reason:
    94                        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.
    95                        type: string
    96                        maxLength: 1024
    97                        minLength: 1
    98                        pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
    99                      status:
   100                        description: status of the condition, one of True, False, Unknown.
   101                        type: string
   102                        enum:
   103                          - "True"
   104                          - "False"
   105                          - Unknown
   106                      type:
   107                        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)
   108                        type: string
   109                        maxLength: 316
   110                        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])$
   111                  x-kubernetes-list-map-keys:
   112                    - type
   113                  x-kubernetes-list-type: map
   114      served: true
   115      storage: true
   116      subresources:
   117        status: {}

View as plain text