...

Text file src/github.com/GoogleCloudPlatform/k8s-config-connector/crds/compute_v1beta1_computehealthcheck.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/managed-by-kcc: "true"
    23    cnrm.cloud.google.com/stability-level: stable
    24    cnrm.cloud.google.com/system: "true"
    25    cnrm.cloud.google.com/tf2crd: "true"
    26  name: computehealthchecks.compute.cnrm.cloud.google.com
    27spec:
    28  group: compute.cnrm.cloud.google.com
    29  names:
    30    categories:
    31    - gcp
    32    kind: ComputeHealthCheck
    33    plural: computehealthchecks
    34    shortNames:
    35    - gcpcomputehealthcheck
    36    - gcpcomputehealthchecks
    37    singular: computehealthcheck
    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              checkIntervalSec:
    75                description: |-
    76                  How often (in seconds) to send a health check. The default value is 5
    77                  seconds.
    78                type: integer
    79              description:
    80                description: |-
    81                  An optional description of this resource. Provide this property when
    82                  you create the resource.
    83                type: string
    84              grpcHealthCheck:
    85                description: A nested object resource.
    86                properties:
    87                  grpcServiceName:
    88                    description: |-
    89                      The gRPC service name for the health check.
    90                      The value of grpcServiceName has the following meanings by convention:
    91                        - Empty serviceName means the overall status of all services at the backend.
    92                        - Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service.
    93                      The grpcServiceName can only be ASCII.
    94                    type: string
    95                  port:
    96                    description: |-
    97                      The port number for the health check request.
    98                      Must be specified if portName and portSpecification are not set
    99                      or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
   100                    type: integer
   101                  portName:
   102                    description: |-
   103                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   104                      port_name are defined, port takes precedence.
   105                    type: string
   106                  portSpecification:
   107                    description: |-
   108                      Specifies how port is selected for health checking, can be one of the
   109                      following values:
   110
   111                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   112
   113                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   114
   115                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   116                        network endpoint is used for health checking. For other backends, the
   117                        port or named port specified in the Backend Service is used for health
   118                        checking.
   119
   120                      If not specified, gRPC health check follows behavior specified in 'port' and
   121                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   122                    type: string
   123                type: object
   124              healthyThreshold:
   125                description: |-
   126                  A so-far unhealthy instance will be marked healthy after this many
   127                  consecutive successes. The default value is 2.
   128                type: integer
   129              http2HealthCheck:
   130                description: A nested object resource.
   131                properties:
   132                  host:
   133                    description: |-
   134                      The value of the host header in the HTTP2 health check request.
   135                      If left empty (default value), the public IP on behalf of which this health
   136                      check is performed will be used.
   137                    type: string
   138                  port:
   139                    description: |-
   140                      The TCP port number for the HTTP2 health check request.
   141                      The default value is 443.
   142                    type: integer
   143                  portName:
   144                    description: |-
   145                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   146                      port_name are defined, port takes precedence.
   147                    type: string
   148                  portSpecification:
   149                    description: |-
   150                      Specifies how port is selected for health checking, can be one of the
   151                      following values:
   152
   153                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   154
   155                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   156
   157                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   158                        network endpoint is used for health checking. For other backends, the
   159                        port or named port specified in the Backend Service is used for health
   160                        checking.
   161
   162                      If not specified, HTTP2 health check follows behavior specified in 'port' and
   163                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   164                    type: string
   165                  proxyHeader:
   166                    description: |-
   167                      Specifies the type of proxy header to append before sending data to the
   168                      backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
   169                    type: string
   170                  requestPath:
   171                    description: |-
   172                      The request path of the HTTP2 health check request.
   173                      The default value is /.
   174                    type: string
   175                  response:
   176                    description: |-
   177                      The bytes to match against the beginning of the response data. If left empty
   178                      (the default value), any response will indicate health. The response data
   179                      can only be ASCII.
   180                    type: string
   181                type: object
   182              httpHealthCheck:
   183                description: A nested object resource.
   184                properties:
   185                  host:
   186                    description: |-
   187                      The value of the host header in the HTTP health check request.
   188                      If left empty (default value), the public IP on behalf of which this health
   189                      check is performed will be used.
   190                    type: string
   191                  port:
   192                    description: |-
   193                      The TCP port number for the HTTP health check request.
   194                      The default value is 80.
   195                    type: integer
   196                  portName:
   197                    description: |-
   198                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   199                      port_name are defined, port takes precedence.
   200                    type: string
   201                  portSpecification:
   202                    description: |-
   203                      Specifies how port is selected for health checking, can be one of the
   204                      following values:
   205
   206                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   207
   208                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   209
   210                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   211                        network endpoint is used for health checking. For other backends, the
   212                        port or named port specified in the Backend Service is used for health
   213                        checking.
   214
   215                      If not specified, HTTP health check follows behavior specified in 'port' and
   216                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   217                    type: string
   218                  proxyHeader:
   219                    description: |-
   220                      Specifies the type of proxy header to append before sending data to the
   221                      backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
   222                    type: string
   223                  requestPath:
   224                    description: |-
   225                      The request path of the HTTP health check request.
   226                      The default value is /.
   227                    type: string
   228                  response:
   229                    description: |-
   230                      The bytes to match against the beginning of the response data. If left empty
   231                      (the default value), any response will indicate health. The response data
   232                      can only be ASCII.
   233                    type: string
   234                type: object
   235              httpsHealthCheck:
   236                description: A nested object resource.
   237                properties:
   238                  host:
   239                    description: |-
   240                      The value of the host header in the HTTPS health check request.
   241                      If left empty (default value), the public IP on behalf of which this health
   242                      check is performed will be used.
   243                    type: string
   244                  port:
   245                    description: |-
   246                      The TCP port number for the HTTPS health check request.
   247                      The default value is 443.
   248                    type: integer
   249                  portName:
   250                    description: |-
   251                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   252                      port_name are defined, port takes precedence.
   253                    type: string
   254                  portSpecification:
   255                    description: |-
   256                      Specifies how port is selected for health checking, can be one of the
   257                      following values:
   258
   259                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   260
   261                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   262
   263                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   264                        network endpoint is used for health checking. For other backends, the
   265                        port or named port specified in the Backend Service is used for health
   266                        checking.
   267
   268                      If not specified, HTTPS health check follows behavior specified in 'port' and
   269                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   270                    type: string
   271                  proxyHeader:
   272                    description: |-
   273                      Specifies the type of proxy header to append before sending data to the
   274                      backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
   275                    type: string
   276                  requestPath:
   277                    description: |-
   278                      The request path of the HTTPS health check request.
   279                      The default value is /.
   280                    type: string
   281                  response:
   282                    description: |-
   283                      The bytes to match against the beginning of the response data. If left empty
   284                      (the default value), any response will indicate health. The response data
   285                      can only be ASCII.
   286                    type: string
   287                type: object
   288              location:
   289                description: 'Location represents the geographical location of the
   290                  ComputeHealthCheck. Specify a region name or "global" for global
   291                  resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/)'
   292                type: string
   293              logConfig:
   294                description: Configure logging on this health check.
   295                properties:
   296                  enable:
   297                    description: |-
   298                      Indicates whether or not to export logs. This is false by default,
   299                      which means no health check logging will be done.
   300                    type: boolean
   301                type: object
   302              resourceID:
   303                description: Immutable. Optional. The name of the resource. Used for
   304                  creation and acquisition. When unset, the value of `metadata.name`
   305                  is used as the default.
   306                type: string
   307              sslHealthCheck:
   308                description: A nested object resource.
   309                properties:
   310                  port:
   311                    description: |-
   312                      The TCP port number for the SSL health check request.
   313                      The default value is 443.
   314                    type: integer
   315                  portName:
   316                    description: |-
   317                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   318                      port_name are defined, port takes precedence.
   319                    type: string
   320                  portSpecification:
   321                    description: |-
   322                      Specifies how port is selected for health checking, can be one of the
   323                      following values:
   324
   325                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   326
   327                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   328
   329                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   330                        network endpoint is used for health checking. For other backends, the
   331                        port or named port specified in the Backend Service is used for health
   332                        checking.
   333
   334                      If not specified, SSL health check follows behavior specified in 'port' and
   335                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   336                    type: string
   337                  proxyHeader:
   338                    description: |-
   339                      Specifies the type of proxy header to append before sending data to the
   340                      backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
   341                    type: string
   342                  request:
   343                    description: |-
   344                      The application data to send once the SSL connection has been
   345                      established (default value is empty). If both request and response are
   346                      empty, the connection establishment alone will indicate health. The request
   347                      data can only be ASCII.
   348                    type: string
   349                  response:
   350                    description: |-
   351                      The bytes to match against the beginning of the response data. If left empty
   352                      (the default value), any response will indicate health. The response data
   353                      can only be ASCII.
   354                    type: string
   355                type: object
   356              tcpHealthCheck:
   357                description: A nested object resource.
   358                properties:
   359                  port:
   360                    description: |-
   361                      The TCP port number for the TCP health check request.
   362                      The default value is 443.
   363                    type: integer
   364                  portName:
   365                    description: |-
   366                      Port name as defined in InstanceGroup#NamedPort#name. If both port and
   367                      port_name are defined, port takes precedence.
   368                    type: string
   369                  portSpecification:
   370                    description: |-
   371                      Specifies how port is selected for health checking, can be one of the
   372                      following values:
   373
   374                        * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
   375
   376                        * 'USE_NAMED_PORT': The 'portName' is used for health checking.
   377
   378                        * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
   379                        network endpoint is used for health checking. For other backends, the
   380                        port or named port specified in the Backend Service is used for health
   381                        checking.
   382
   383                      If not specified, TCP health check follows behavior specified in 'port' and
   384                      'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
   385                    type: string
   386                  proxyHeader:
   387                    description: |-
   388                      Specifies the type of proxy header to append before sending data to the
   389                      backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
   390                    type: string
   391                  request:
   392                    description: |-
   393                      The application data to send once the TCP connection has been
   394                      established (default value is empty). If both request and response are
   395                      empty, the connection establishment alone will indicate health. The request
   396                      data can only be ASCII.
   397                    type: string
   398                  response:
   399                    description: |-
   400                      The bytes to match against the beginning of the response data. If left empty
   401                      (the default value), any response will indicate health. The response data
   402                      can only be ASCII.
   403                    type: string
   404                type: object
   405              timeoutSec:
   406                description: |-
   407                  How long (in seconds) to wait before claiming failure.
   408                  The default value is 5 seconds.  It is invalid for timeoutSec to have
   409                  greater value than checkIntervalSec.
   410                type: integer
   411              unhealthyThreshold:
   412                description: |-
   413                  A so-far healthy instance will be marked unhealthy after this many
   414                  consecutive failures. The default value is 2.
   415                type: integer
   416            required:
   417            - location
   418            type: object
   419          status:
   420            properties:
   421              conditions:
   422                description: Conditions represent the latest available observation
   423                  of the resource's current state.
   424                items:
   425                  properties:
   426                    lastTransitionTime:
   427                      description: Last time the condition transitioned from one status
   428                        to another.
   429                      type: string
   430                    message:
   431                      description: Human-readable message indicating details about
   432                        last transition.
   433                      type: string
   434                    reason:
   435                      description: Unique, one-word, CamelCase reason for the condition's
   436                        last transition.
   437                      type: string
   438                    status:
   439                      description: Status is the status of the condition. Can be True,
   440                        False, Unknown.
   441                      type: string
   442                    type:
   443                      description: Type is the type of the condition.
   444                      type: string
   445                  type: object
   446                type: array
   447              creationTimestamp:
   448                description: Creation timestamp in RFC3339 text format.
   449                type: string
   450              observedGeneration:
   451                description: ObservedGeneration is the generation of the resource
   452                  that was most recently observed by the Config Connector controller.
   453                  If this is equal to metadata.generation, then that means that the
   454                  current reported status reflects the most recent desired state of
   455                  the resource.
   456                type: integer
   457              selfLink:
   458                type: string
   459              type:
   460                description: The type of the health check. One of HTTP, HTTPS, TCP,
   461                  or SSL.
   462                type: string
   463            type: object
   464        required:
   465        - spec
   466        type: object
   467    served: true
   468    storage: true
   469    subresources:
   470      status: {}
   471status:
   472  acceptedNames:
   473    kind: ""
   474    plural: ""
   475  conditions: []
   476  storedVersions: []

View as plain text