ComputeHTTPHealthCheck

Property Value
Google Cloud Service Name Compute Engine
Google Cloud Service Documentation /compute/docs/
Google Cloud REST Resource Name v1.httpHealthChecks
Google Cloud REST Resource Documentation /compute/docs/reference/rest/v1/httpHealthChecks
Config Connector Resource Short Names gcpcomputehttphealthcheck
gcpcomputehttphealthchecks
computehttphealthcheck
Config Connector Service Name compute.googleapis.com
Config Connector Resource Fully Qualified Name computehttphealthchecks.compute.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id

Spec

Schema

  checkIntervalSec: integer
  description: string
  healthyThreshold: integer
  host: string
  port: integer
  requestPath: string
  resourceID: string
  timeoutSec: integer
  unhealthyThreshold: integer
Fields

checkIntervalSec

Optional

integer

How often (in seconds) to send a health check. The default value is 5 seconds.

description

Optional

string

An optional description of this resource. Provide this property when you create the resource.

healthyThreshold

Optional

integer

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

host

Optional

string

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

port

Optional

integer

The TCP port number for the HTTP health check request. The default value is 80.

requestPath

Optional

string

The request path of the HTTP health check request. The default value is /.

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

timeoutSec

Optional

integer

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

unhealthyThreshold

Optional

integer

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  creationTimestamp: string
  observedGeneration: integer
  selfLink: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

creationTimestamp

string

Creation timestamp in RFC3339 text format.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

selfLink

string

Sample YAML(s)

Typical Use Case

  # Copyright 2020 Google LLC
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeHTTPHealthCheck
  metadata:
    name: computehttphealthcheck-sample
  spec:
    checkIntervalSec: 10
    description: example HTTP health check
    healthyThreshold: 2
    port: 80
    requestPath: /
    timeoutSec: 5
    unhealthyThreshold: 2