...

Text file src/github.com/GoogleCloudPlatform/k8s-config-connector/crds/cloudfunctions_v1beta1_cloudfunctionsfunction.yaml

Documentation: github.com/GoogleCloudPlatform/k8s-config-connector/crds

     1# Copyright 2020 Google LLC
     2#
     3# Licensed under the Apache License, Version 2.0 (the "License");
     4# you may not use this file except in compliance with the License.
     5# You may obtain a copy of the License at
     6#
     7#     http://www.apache.org/licenses/LICENSE-2.0
     8#
     9# Unless required by applicable law or agreed to in writing, software
    10# distributed under the License is distributed on an "AS IS" BASIS,
    11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12# See the License for the specific language governing permissions and
    13# limitations under the License.
    14
    15apiVersion: apiextensions.k8s.io/v1
    16kind: CustomResourceDefinition
    17metadata:
    18  annotations:
    19    cnrm.cloud.google.com/version: 1.106.0
    20  creationTimestamp: null
    21  labels:
    22    cnrm.cloud.google.com/dcl2crd: "true"
    23    cnrm.cloud.google.com/managed-by-kcc: "true"
    24    cnrm.cloud.google.com/stability-level: stable
    25    cnrm.cloud.google.com/system: "true"
    26  name: cloudfunctionsfunctions.cloudfunctions.cnrm.cloud.google.com
    27spec:
    28  group: cloudfunctions.cnrm.cloud.google.com
    29  names:
    30    categories:
    31    - gcp
    32    kind: CloudFunctionsFunction
    33    plural: cloudfunctionsfunctions
    34    shortNames:
    35    - gcpcloudfunctionsfunction
    36    - gcpcloudfunctionsfunctions
    37    singular: cloudfunctionsfunction
    38  scope: Namespaced
    39  versions:
    40  - additionalPrinterColumns:
    41    - jsonPath: .metadata.creationTimestamp
    42      name: Age
    43      type: date
    44    - description: When 'True', the most recent reconcile of the resource succeeded
    45      jsonPath: .status.conditions[?(@.type=='Ready')].status
    46      name: Ready
    47      type: string
    48    - description: The reason for the value in 'Ready'
    49      jsonPath: .status.conditions[?(@.type=='Ready')].reason
    50      name: Status
    51      type: string
    52    - description: The last transition time for the value in 'Status'
    53      jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
    54      name: Status Age
    55      type: date
    56    name: v1beta1
    57    schema:
    58      openAPIV3Schema:
    59        properties:
    60          apiVersion:
    61            description: 'apiVersion defines the versioned schema of this representation
    62              of an object. Servers should convert recognized schemas to the latest
    63              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
    64            type: string
    65          kind:
    66            description: 'kind is a string value representing the REST resource this
    67              object represents. Servers may infer this from the endpoint the client
    68              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
    69            type: string
    70          metadata:
    71            type: object
    72          spec:
    73            properties:
    74              availableMemoryMb:
    75                description: 'Memory (in MB), available to the function. Default value
    76                  is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.'
    77                format: int64
    78                type: integer
    79              description:
    80                description: User-provided description of a function.
    81                type: string
    82              entryPoint:
    83                description: |-
    84                  Immutable. The name of the function (as defined in source code) that will be
    85                  executed. Defaults to the resource name suffix, if not specified. For
    86                  backward compatibility, if function with given name is not found, then the
    87                  system will try to use function named "function".
    88                  For Node.js this is name of a function exported by the module specified
    89                  in `source_location`.
    90                type: string
    91              environmentVariables:
    92                additionalProperties:
    93                  type: string
    94                description: Environment variables that shall be available during
    95                  function execution.
    96                type: object
    97              eventTrigger:
    98                description: Immutable. A source that fires events in response to
    99                  a condition in another service.
   100                properties:
   101                  eventType:
   102                    description: |-
   103                      Immutable. Required. The type of event to observe. For example:
   104                      `providers/cloud.storage/eventTypes/object.change` and
   105                      `providers/cloud.pubsub/eventTypes/topic.publish`.
   106
   107                      Event types match pattern `providers/*/eventTypes/*.*`.
   108                      The pattern contains:
   109
   110                      1. namespace: For example, `cloud.storage` and
   111                         `google.firebase.analytics`.
   112                      2. resource type: The type of resource on which event occurs. For
   113                         example, the Google Cloud Storage API includes the type `object`.
   114                      3. action: The action that generates the event. For example, action for
   115                         a Google Cloud Storage Object is 'change'.
   116                      These parts are lower case.
   117                    type: string
   118                  failurePolicy:
   119                    description: Immutable. Specifies policy for failed executions.
   120                    type: boolean
   121                  resourceRef:
   122                    description: Immutable.
   123                    oneOf:
   124                    - not:
   125                        required:
   126                        - external
   127                      required:
   128                      - name
   129                      - kind
   130                    - not:
   131                        anyOf:
   132                        - required:
   133                          - name
   134                        - required:
   135                          - namespace
   136                        - required:
   137                          - kind
   138                      required:
   139                      - external
   140                    properties:
   141                      external:
   142                        description: |-
   143                          Required. The resource(s) from which to observe events, for example,
   144                          `projects/_/buckets/myBucket`.
   145
   146                          Not all syntactically correct values are accepted by all services. For
   147                          example:
   148
   149                          1. The authorization model must support it. Google Cloud Functions
   150                             only allows EventTriggers to be deployed that observe resources in the
   151                             same project as the `Function`.
   152                          2. The resource type must match the pattern expected for an
   153                             `event_type`. For example, an `EventTrigger` that has an
   154                             `event_type` of "google.pubsub.topic.publish" should have a resource
   155                             that matches Google Cloud Pub/Sub topics.
   156
   157                          Additionally, some services may support short names when creating an
   158                          `EventTrigger`. These will always be returned in the normalized "long"
   159                          format.
   160
   161                          See each *service's* documentation for supported formats.
   162
   163                          Allowed values:
   164                          * The Google Cloud resource name of a `StorageBucket` resource (format: `{{name}}`).
   165                          * The Google Cloud resource name of a `PubSubTopic` resource (format: `projects/{{project}}/topics/{{name}}`).
   166                        type: string
   167                      kind:
   168                        description: 'Kind of the referent. Allowed values: StorageBucket,PubSubTopic'
   169                        type: string
   170                      name:
   171                        description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   172                        type: string
   173                      namespace:
   174                        description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   175                        type: string
   176                    type: object
   177                  service:
   178                    description: |-
   179                      Immutable. The hostname of the service that should be observed.
   180
   181                      If no string is provided, the default service implementing the API will
   182                      be used. For example, `storage.googleapis.com` is the default for all
   183                      event types in the `google.storage` namespace.
   184                    type: string
   185                required:
   186                - eventType
   187                - resourceRef
   188                type: object
   189              httpsTrigger:
   190                description: Immutable. An HTTPS endpoint type of source that can
   191                  be triggered via URL.
   192                properties:
   193                  securityLevel:
   194                    description: 'Immutable. Both HTTP and HTTPS requests with URLs
   195                      that match the handler succeed without redirects. The application
   196                      can examine the request to determine which protocol was used
   197                      and respond accordingly. Possible values: SECURITY_LEVEL_UNSPECIFIED,
   198                      SECURE_ALWAYS, SECURE_OPTIONAL'
   199                    type: string
   200                type: object
   201              ingressSettings:
   202                description: |-
   203                  The ingress settings for the function, controlling what traffic can reach
   204                  it. Possible values: INGRESS_SETTINGS_UNSPECIFIED, ALLOW_ALL, ALLOW_INTERNAL_ONLY, ALLOW_INTERNAL_AND_GCLB
   205                type: string
   206              maxInstances:
   207                description: |-
   208                  The limit on the maximum number of function instances that may coexist at a
   209                  given time.
   210                format: int64
   211                type: integer
   212              projectRef:
   213                description: Immutable. The Project that this resource belongs to.
   214                oneOf:
   215                - not:
   216                    required:
   217                    - external
   218                  required:
   219                  - name
   220                - not:
   221                    anyOf:
   222                    - required:
   223                      - name
   224                    - required:
   225                      - namespace
   226                  required:
   227                  - external
   228                properties:
   229                  external:
   230                    description: |-
   231                      The project id of the function.
   232
   233                      Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).
   234                    type: string
   235                  name:
   236                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   237                    type: string
   238                  namespace:
   239                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   240                    type: string
   241                type: object
   242              region:
   243                description: Immutable. The name of the Cloud Functions region of
   244                  the function.
   245                type: string
   246              resourceID:
   247                description: Immutable. Optional. The name of the resource. Used for
   248                  creation and acquisition. When unset, the value of `metadata.name`
   249                  is used as the default.
   250                type: string
   251              runtime:
   252                description: |
   253                  The runtime in which to run the function. Required when deploying a new
   254                  function, optional when updating an existing function. For a complete
   255                  list of possible choices, see the
   256                  [`gcloud` command
   257                  reference](/sdk/gcloud/reference/functions/deploy#--runtime).
   258                type: string
   259              serviceAccountRef:
   260                description: Immutable.
   261                oneOf:
   262                - not:
   263                    required:
   264                    - external
   265                  required:
   266                  - name
   267                - not:
   268                    anyOf:
   269                    - required:
   270                      - name
   271                    - required:
   272                      - namespace
   273                  required:
   274                  - external
   275                properties:
   276                  external:
   277                    description: |-
   278                      The email of the function's service account. If empty, defaults to
   279                      `{project_id}@appspot.gserviceaccount.com`.
   280
   281                      Allowed value: The `email` field of an `IAMServiceAccount` resource.
   282                    type: string
   283                  name:
   284                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   285                    type: string
   286                  namespace:
   287                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   288                    type: string
   289                type: object
   290              sourceArchiveUrl:
   291                description: Immutable. The Google Cloud Storage URL, starting with
   292                  gs://, pointing to the zip archive which contains the function.
   293                type: string
   294              sourceRepository:
   295                description: Immutable. Represents parameters related to source repository
   296                  where a function is hosted.
   297                properties:
   298                  url:
   299                    description: |-
   300                      Immutable. The URL pointing to the hosted repository where the function is defined.
   301                      There are supported Cloud Source Repository URLs in the following
   302                      formats:
   303
   304                      To refer to a specific commit:
   305                      `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`
   306                      To refer to a moveable alias (branch):
   307                      `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`
   308                      In particular, to refer to HEAD use `master` moveable alias.
   309                      To refer to a specific fixed alias (tag):
   310                      `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
   311
   312                      You may omit `paths/*` if you want to use the main directory.
   313                    type: string
   314                required:
   315                - url
   316                type: object
   317              timeout:
   318                description: |-
   319                  The function execution timeout. Execution is considered failed and
   320                  can be terminated if the function is not completed at the end of the
   321                  timeout period. Defaults to 60 seconds.
   322                type: string
   323              vpcConnectorEgressSettings:
   324                description: |-
   325                  The egress settings for the connector, controlling what traffic is diverted
   326                  through it. Possible values: VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED, PRIVATE_RANGES_ONLY, ALL_TRAFFIC
   327                type: string
   328              vpcConnectorRef:
   329                oneOf:
   330                - not:
   331                    required:
   332                    - external
   333                  required:
   334                  - name
   335                - not:
   336                    anyOf:
   337                    - required:
   338                      - name
   339                    - required:
   340                      - namespace
   341                  required:
   342                  - external
   343                properties:
   344                  external:
   345                    description: |-
   346                      The VPC Network Connector that this cloud function can connect to. It can
   347                      be either the fully-qualified URI, or the short name of the network
   348                      connector resource. The format of this field is
   349                      `projects/*/locations/*/connectors/*`
   350
   351                      Allowed value: The Google Cloud resource name of a `VPCAccessConnector` resource (format: `projects/{{project}}/locations/{{location}}/connectors/{{name}}`).
   352                    type: string
   353                  name:
   354                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   355                    type: string
   356                  namespace:
   357                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   358                    type: string
   359                type: object
   360            required:
   361            - projectRef
   362            - region
   363            - runtime
   364            type: object
   365          status:
   366            properties:
   367              conditions:
   368                description: Conditions represent the latest available observation
   369                  of the resource's current state.
   370                items:
   371                  properties:
   372                    lastTransitionTime:
   373                      description: Last time the condition transitioned from one status
   374                        to another.
   375                      type: string
   376                    message:
   377                      description: Human-readable message indicating details about
   378                        last transition.
   379                      type: string
   380                    reason:
   381                      description: Unique, one-word, CamelCase reason for the condition's
   382                        last transition.
   383                      type: string
   384                    status:
   385                      description: Status is the status of the condition. Can be True,
   386                        False, Unknown.
   387                      type: string
   388                    type:
   389                      description: Type is the type of the condition.
   390                      type: string
   391                  type: object
   392                type: array
   393              httpsTrigger:
   394                properties:
   395                  url:
   396                    description: Output only. The deployed url for the function.
   397                    type: string
   398                type: object
   399              observedGeneration:
   400                description: ObservedGeneration is the generation of the resource
   401                  that was most recently observed by the Config Connector controller.
   402                  If this is equal to metadata.generation, then that means that the
   403                  current reported status reflects the most recent desired state of
   404                  the resource.
   405                type: integer
   406              sourceRepository:
   407                properties:
   408                  deployedUrl:
   409                    description: |-
   410                      Output only. The URL pointing to the hosted repository where the function
   411                      were defined at the time of deployment. It always points to a specific
   412                      commit in the format described above.
   413                    type: string
   414                type: object
   415              status:
   416                description: 'Output only. Status of the function deployment. Possible
   417                  values: CLOUD_FUNCTION_STATUS_UNSPECIFIED, ACTIVE, OFFLINE, DEPLOY_IN_PROGRESS,
   418                  DELETE_IN_PROGRESS, UNKNOWN'
   419                type: string
   420              updateTime:
   421                description: Output only. The last update timestamp of a Cloud Function
   422                  in RFC3339 UTC 'Zulu' format, with nanosecond resolution and up
   423                  to nine fractional digits.
   424                type: string
   425              versionId:
   426                description: |-
   427                  Output only. The version identifier of the Cloud Function. Each deployment attempt
   428                  results in a new version of a function being created.
   429                format: int64
   430                type: integer
   431            type: object
   432        required:
   433        - spec
   434        type: object
   435    served: true
   436    storage: true
   437    subresources:
   438      status: {}
   439status:
   440  acceptedNames:
   441    kind: ""
   442    plural: ""
   443  conditions: []
   444  storedVersions: []

View as plain text