github.com/operator-framework/operator-lifecycle-manager@v0.30.0/deploy/upstream/manifests/0.14.1/0000_50_olm_04-installplan.crd.yaml (about)

     1  ---
     2  # Source: olm/templates/0000_50_olm_04-installplan.crd.yaml
     3  apiVersion: apiextensions.k8s.io/v1beta1
     4  kind: CustomResourceDefinition
     5  metadata:
     6    name: installplans.operators.coreos.com
     7    annotations:
     8      displayName: Install Plan
     9      description: Represents a plan to install and resolve dependencies for Cluster
    10        Services
    11  spec:
    12    group: operators.coreos.com
    13    version: v1alpha1
    14    versions:
    15    - name: v1alpha1
    16      served: true
    17      storage: true
    18    scope: Namespaced
    19    names:
    20      plural: installplans
    21      singular: installplan
    22      kind: InstallPlan
    23      listKind: InstallPlanList
    24      shortNames:
    25      - ip
    26      categories:
    27      - olm
    28    additionalPrinterColumns:
    29    - name: CSV
    30      type: string
    31      description: The first CSV in the list of clusterServiceVersionNames
    32      JSONPath: .spec.clusterServiceVersionNames[0]
    33    - name: Approval
    34      type: string
    35      description: The approval mode
    36      JSONPath: .spec.approval
    37    - name: Approved
    38      type: boolean
    39      JSONPath: .spec.approved
    40    preserveUnknownFields: false
    41    subresources:
    42      # status enables the status subresource.
    43      status: {}
    44    validation:
    45      openAPIV3Schema:
    46        description: InstallPlan defines the installation of a set of operators.
    47        type: object
    48        required:
    49        - metadata
    50        - spec
    51        properties:
    52          apiVersion:
    53            description: 'APIVersion defines the versioned schema of this representation
    54              of an object. Servers should convert recognized schemas to the latest
    55              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    56            type: string
    57          kind:
    58            description: 'Kind is a string value representing the REST resource this
    59              object represents. Servers may infer this from the endpoint the client
    60              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    61            type: string
    62          metadata:
    63            type: object
    64          spec:
    65            description: InstallPlanSpec defines a set of Application resources to be
    66              installed
    67            type: object
    68            required:
    69            - approval
    70            - approved
    71            - clusterServiceVersionNames
    72            properties:
    73              approval:
    74                description: Approval is the user approval policy for an InstallPlan.
    75                type: string
    76              approved:
    77                type: boolean
    78              clusterServiceVersionNames:
    79                type: array
    80                items:
    81                  type: string
    82              source:
    83                type: string
    84              sourceNamespace:
    85                type: string
    86          status:
    87            description: "InstallPlanStatus represents the information about the status
    88              of steps required to complete installation. \n Status may trail the actual
    89              state of a system."
    90            type: object
    91            required:
    92            - catalogSources
    93            - phase
    94            properties:
    95              attenuatedServiceAccountRef:
    96                description: AttenuatedServiceAccountRef references the service account
    97                  that is used to do scoped operator install.
    98                type: object
    99                properties:
   100                  apiVersion:
   101                    description: API version of the referent.
   102                    type: string
   103                  fieldPath:
   104                    description: 'If referring to a piece of an object instead of an
   105                      entire object, this string should contain a valid JSON/Go field
   106                      access statement, such as desiredState.manifest.containers[2].
   107                      For example, if the object reference is to a container within
   108                      a pod, this would take on a value like: "spec.containers{name}"
   109                      (where "name" refers to the name of the container that triggered
   110                      the event) or if no container name is specified "spec.containers[2]"
   111                      (container with index 2 in this pod). This syntax is chosen only
   112                      to have some well-defined way of referencing a part of an object.
   113                      TODO: this design is not final and this field is subject to change
   114                      in the future.'
   115                    type: string
   116                  kind:
   117                    description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   118                    type: string
   119                  name:
   120                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   121                    type: string
   122                  namespace:
   123                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   124                    type: string
   125                  resourceVersion:
   126                    description: 'Specific resourceVersion to which this reference is
   127                      made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   128                    type: string
   129                  uid:
   130                    description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   131                    type: string
   132              bundleLookups:
   133                type: array
   134                items:
   135                  type: object
   136                  required:
   137                  - catalogSourceRef
   138                  - path
   139                  - replaces
   140                  properties:
   141                    catalogSourceRef:
   142                      description: ObjectReference contains enough information to let
   143                        you inspect or modify the referred object.
   144                      type: object
   145                      properties:
   146                        apiVersion:
   147                          description: API version of the referent.
   148                          type: string
   149                        fieldPath:
   150                          description: 'If referring to a piece of an object instead
   151                            of an entire object, this string should contain a valid
   152                            JSON/Go field access statement, such as desiredState.manifest.containers[2].
   153                            For example, if the object reference is to a container within
   154                            a pod, this would take on a value like: "spec.containers{name}"
   155                            (where "name" refers to the name of the container that triggered
   156                            the event) or if no container name is specified "spec.containers[2]"
   157                            (container with index 2 in this pod). This syntax is chosen
   158                            only to have some well-defined way of referencing a part
   159                            of an object. TODO: this design is not final and this field
   160                            is subject to change in the future.'
   161                          type: string
   162                        kind:
   163                          description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   164                          type: string
   165                        name:
   166                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   167                          type: string
   168                        namespace:
   169                          description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   170                          type: string
   171                        resourceVersion:
   172                          description: 'Specific resourceVersion to which this reference
   173                            is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   174                          type: string
   175                        uid:
   176                          description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   177                          type: string
   178                    conditions:
   179                      type: array
   180                      items:
   181                        type: object
   182                        required:
   183                        - status
   184                        - type
   185                        properties:
   186                          lastTransitionTime:
   187                            description: Last time the condition transitioned from one
   188                              status to another.
   189                            type: string
   190                            format: date-time
   191                          lastUpdateTime:
   192                            description: Last time the condition was probed
   193                            type: string
   194                            format: date-time
   195                          message:
   196                            description: A human readable message indicating details
   197                              about the transition.
   198                            type: string
   199                          reason:
   200                            description: The reason for the condition's last transition.
   201                            type: string
   202                          status:
   203                            description: Status of the condition, one of True, False,
   204                              Unknown.
   205                            type: string
   206                          type:
   207                            description: Type of condition.
   208                            type: string
   209                    path:
   210                      type: string
   211                    replaces:
   212                      type: string
   213              catalogSources:
   214                type: array
   215                items:
   216                  type: string
   217              conditions:
   218                type: array
   219                items:
   220                  description: InstallPlanCondition represents the overall status of
   221                    the execution of an InstallPlan.
   222                  type: object
   223                  properties:
   224                    lastTransitionTime:
   225                      type: string
   226                      format: date-time
   227                    lastUpdateTime:
   228                      type: string
   229                      format: date-time
   230                    message:
   231                      type: string
   232                    reason:
   233                      description: ConditionReason is a camelcased reason for the state
   234                        transition.
   235                      type: string
   236                    status:
   237                      type: string
   238                    type:
   239                      description: InstallPlanConditionType describes the state of an
   240                        InstallPlan at a certain point as a whole.
   241                      type: string
   242              phase:
   243                description: InstallPlanPhase is the current status of a InstallPlan
   244                  as a whole.
   245                type: string
   246              plan:
   247                type: array
   248                items:
   249                  description: Step represents the status of an individual step in an
   250                    InstallPlan.
   251                  type: object
   252                  required:
   253                  - resolving
   254                  - resource
   255                  - status
   256                  properties:
   257                    resolving:
   258                      type: string
   259                    resource:
   260                      description: StepResource represents the status of a resource
   261                        to be tracked by an InstallPlan.
   262                      type: object
   263                      required:
   264                      - group
   265                      - kind
   266                      - name
   267                      - sourceName
   268                      - sourceNamespace
   269                      - version
   270                      properties:
   271                        group:
   272                          type: string
   273                        kind:
   274                          type: string
   275                        manifest:
   276                          type: string
   277                        name:
   278                          type: string
   279                        sourceName:
   280                          type: string
   281                        sourceNamespace:
   282                          type: string
   283                        version:
   284                          type: string
   285                    status:
   286                      description: StepStatus is the current status of a particular
   287                        resource an in InstallPlan
   288                      type: string