github.com/operator-framework/operator-lifecycle-manager@v0.30.0/deploy/chart/crds/0000_50_olm_00-installplans.crd.yaml (about)

     1  apiVersion: apiextensions.k8s.io/v1
     2  kind: CustomResourceDefinition
     3  metadata:
     4    annotations:
     5      controller-gen.kubebuilder.io/version: v0.16.1
     6    name: installplans.operators.coreos.com
     7  spec:
     8    group: operators.coreos.com
     9    names:
    10      categories:
    11        - olm
    12      kind: InstallPlan
    13      listKind: InstallPlanList
    14      plural: installplans
    15      shortNames:
    16        - ip
    17      singular: installplan
    18    scope: Namespaced
    19    versions:
    20      - additionalPrinterColumns:
    21          - description: The first CSV in the list of clusterServiceVersionNames
    22            jsonPath: .spec.clusterServiceVersionNames[0]
    23            name: CSV
    24            type: string
    25          - description: The approval mode
    26            jsonPath: .spec.approval
    27            name: Approval
    28            type: string
    29          - jsonPath: .spec.approved
    30            name: Approved
    31            type: boolean
    32        name: v1alpha1
    33        schema:
    34          openAPIV3Schema:
    35            description: InstallPlan defines the installation of a set of operators.
    36            type: object
    37            required:
    38              - metadata
    39              - spec
    40            properties:
    41              apiVersion:
    42                description: |-
    43                  APIVersion defines the versioned schema of this representation of an object.
    44                  Servers should convert recognized schemas to the latest internal value, and
    45                  may reject unrecognized values.
    46                  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    47                type: string
    48              kind:
    49                description: |-
    50                  Kind is a string value representing the REST resource this object represents.
    51                  Servers may infer this from the endpoint the client submits requests to.
    52                  Cannot be updated.
    53                  In CamelCase.
    54                  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    55                type: string
    56              metadata:
    57                type: object
    58              spec:
    59                description: InstallPlanSpec defines a set of Application resources to be installed
    60                type: object
    61                required:
    62                  - approval
    63                  - approved
    64                  - clusterServiceVersionNames
    65                properties:
    66                  approval:
    67                    description: |-
    68                      Approval is the user approval policy for an InstallPlan.
    69                      It must be one of "Automatic" or "Manual".
    70                    type: string
    71                  approved:
    72                    type: boolean
    73                  clusterServiceVersionNames:
    74                    type: array
    75                    items:
    76                      type: string
    77                  generation:
    78                    type: integer
    79                  source:
    80                    type: string
    81                  sourceNamespace:
    82                    type: string
    83              status:
    84                description: |-
    85                  InstallPlanStatus represents the information about the status of
    86                  steps required to complete installation.
    87  
    88                  Status may trail the actual state of a system.
    89                type: object
    90                required:
    91                  - catalogSources
    92                  - phase
    93                properties:
    94                  attenuatedServiceAccountRef:
    95                    description: |-
    96                      AttenuatedServiceAccountRef references the service account that is used
    97                      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: |-
   105                          If referring to a piece of an object instead of an entire object, this string
   106                          should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
   107                          For example, if the object reference is to a container within a pod, this would take on a value like:
   108                          "spec.containers{name}" (where "name" refers to the name of the container that triggered
   109                          the event) or if no container name is specified "spec.containers[2]" (container with
   110                          index 2 in this pod). This syntax is chosen only to have some well-defined way of
   111                          referencing a part of an object.
   112                        type: string
   113                      kind:
   114                        description: |-
   115                          Kind of the referent.
   116                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
   117                        type: string
   118                      name:
   119                        description: |-
   120                          Name of the referent.
   121                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
   122                        type: string
   123                      namespace:
   124                        description: |-
   125                          Namespace of the referent.
   126                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
   127                        type: string
   128                      resourceVersion:
   129                        description: |-
   130                          Specific resourceVersion to which this reference is made, if any.
   131                          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
   132                        type: string
   133                      uid:
   134                        description: |-
   135                          UID of the referent.
   136                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
   137                        type: string
   138                    x-kubernetes-map-type: atomic
   139                  bundleLookups:
   140                    description: BundleLookups is the set of in-progress requests to pull and unpackage bundle content to the cluster.
   141                    type: array
   142                    items:
   143                      description: BundleLookup is a request to pull and unpackage the content of a bundle to the cluster.
   144                      type: object
   145                      required:
   146                        - catalogSourceRef
   147                        - identifier
   148                        - path
   149                        - replaces
   150                      properties:
   151                        catalogSourceRef:
   152                          description: CatalogSourceRef is a reference to the CatalogSource the bundle path was resolved from.
   153                          type: object
   154                          properties:
   155                            apiVersion:
   156                              description: API version of the referent.
   157                              type: string
   158                            fieldPath:
   159                              description: |-
   160                                If referring to a piece of an object instead of an entire object, this string
   161                                should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
   162                                For example, if the object reference is to a container within a pod, this would take on a value like:
   163                                "spec.containers{name}" (where "name" refers to the name of the container that triggered
   164                                the event) or if no container name is specified "spec.containers[2]" (container with
   165                                index 2 in this pod). This syntax is chosen only to have some well-defined way of
   166                                referencing a part of an object.
   167                              type: string
   168                            kind:
   169                              description: |-
   170                                Kind of the referent.
   171                                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
   172                              type: string
   173                            name:
   174                              description: |-
   175                                Name of the referent.
   176                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
   177                              type: string
   178                            namespace:
   179                              description: |-
   180                                Namespace of the referent.
   181                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
   182                              type: string
   183                            resourceVersion:
   184                              description: |-
   185                                Specific resourceVersion to which this reference is made, if any.
   186                                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
   187                              type: string
   188                            uid:
   189                              description: |-
   190                                UID of the referent.
   191                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
   192                              type: string
   193                          x-kubernetes-map-type: atomic
   194                        conditions:
   195                          description: Conditions represents the overall state of a BundleLookup.
   196                          type: array
   197                          items:
   198                            type: object
   199                            required:
   200                              - status
   201                              - type
   202                            properties:
   203                              lastTransitionTime:
   204                                description: Last time the condition transitioned from one status to another.
   205                                type: string
   206                                format: date-time
   207                              lastUpdateTime:
   208                                description: Last time the condition was probed.
   209                                type: string
   210                                format: date-time
   211                              message:
   212                                description: A human readable message indicating details about the transition.
   213                                type: string
   214                              reason:
   215                                description: The reason for the condition's last transition.
   216                                type: string
   217                              status:
   218                                description: Status of the condition, one of True, False, Unknown.
   219                                type: string
   220                              type:
   221                                description: Type of condition.
   222                                type: string
   223                        identifier:
   224                          description: Identifier is the catalog-unique name of the operator (the name of the CSV for bundles that contain CSVs)
   225                          type: string
   226                        path:
   227                          description: |-
   228                            Path refers to the location of a bundle to pull.
   229                            It's typically an image reference.
   230                          type: string
   231                        properties:
   232                          description: The effective properties of the unpacked bundle.
   233                          type: string
   234                        replaces:
   235                          description: Replaces is the name of the bundle to replace with the one found at Path.
   236                          type: string
   237                  catalogSources:
   238                    type: array
   239                    items:
   240                      type: string
   241                  conditions:
   242                    type: array
   243                    items:
   244                      description: |-
   245                        InstallPlanCondition represents the overall status of the execution of
   246                        an InstallPlan.
   247                      type: object
   248                      properties:
   249                        lastTransitionTime:
   250                          type: string
   251                          format: date-time
   252                        lastUpdateTime:
   253                          type: string
   254                          format: date-time
   255                        message:
   256                          type: string
   257                        reason:
   258                          description: ConditionReason is a camelcased reason for the state transition.
   259                          type: string
   260                        status:
   261                          type: string
   262                        type:
   263                          description: InstallPlanConditionType describes the state of an InstallPlan at a certain point as a whole.
   264                          type: string
   265                  message:
   266                    description: |-
   267                      Message is a human-readable message containing detailed
   268                      information that may be important to understanding why the
   269                      plan has its current status.
   270                    type: string
   271                  phase:
   272                    description: InstallPlanPhase is the current status of a InstallPlan as a whole.
   273                    type: string
   274                  plan:
   275                    type: array
   276                    items:
   277                      description: Step represents the status of an individual step in an InstallPlan.
   278                      type: object
   279                      required:
   280                        - resolving
   281                        - resource
   282                        - status
   283                      properties:
   284                        optional:
   285                          type: boolean
   286                        resolving:
   287                          type: string
   288                        resource:
   289                          description: |-
   290                            StepResource represents the status of a resource to be tracked by an
   291                            InstallPlan.
   292                          type: object
   293                          required:
   294                            - group
   295                            - kind
   296                            - name
   297                            - sourceName
   298                            - sourceNamespace
   299                            - version
   300                          properties:
   301                            group:
   302                              type: string
   303                            kind:
   304                              type: string
   305                            manifest:
   306                              type: string
   307                            name:
   308                              type: string
   309                            sourceName:
   310                              type: string
   311                            sourceNamespace:
   312                              type: string
   313                            version:
   314                              type: string
   315                        status:
   316                          description: |-
   317                            StepStatus is the current status of a particular resource an in
   318                            InstallPlan
   319                          type: string
   320                  startTime:
   321                    description: |-
   322                      StartTime is the time when the controller began applying
   323                      the resources listed in the plan to the cluster.
   324                    type: string
   325                    format: date-time
   326        served: true
   327        storage: true
   328        subresources:
   329          status: {}