UptimeCheckConfig is the Schema for the UptimeCheckConfigs API. This message configures which resources and services to monitor for availability.
Type
CRD
Group
monitoring.gcp.upbound.io
Version
v1beta1
apiVersion: monitoring.gcp.upbound.io/v1beta1
kind: UptimeCheckConfig
UptimeCheckConfigSpec defines the desired state of UptimeCheckConfig
No description provided.
The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. Structure is documented below.
Information needed to perform a JSONPath content match. Used for ContentMatcherOption::MATCHES_JSON_PATH and ContentMatcherOption::NOT_MATCHES_JSON_PATH. Structure is documented below.
Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
Contains information needed to add pings to an HTTP check. Structure is documented below.
The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
The group resource associated with the configuration. Structure is documented below.
Reference to a Group in monitoring to populate groupId.
Policies for referencing.
Selector for a Group in monitoring to populate groupId.
Policies for selection.
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
Reference to a Function in cloudfunctions2 to populate name.
Policies for referencing.
Selector for a Function in cloudfunctions2 to populate name.
Policies for selection.
Contains information needed to make a TCP check. Structure is documented below.
Contains information needed to add pings to a TCP check. Structure is documented below.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. Structure is documented below.
Information needed to perform a JSONPath content match. Used for ContentMatcherOption::MATCHES_JSON_PATH and ContentMatcherOption::NOT_MATCHES_JSON_PATH. Structure is documented below.
Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
Contains information needed to add pings to an HTTP check. Structure is documented below.
The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
The group resource associated with the configuration. Structure is documented below.
Reference to a Group in monitoring to populate groupId.
Policies for referencing.
Selector for a Group in monitoring to populate groupId.
Policies for selection.
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
Reference to a Function in cloudfunctions2 to populate name.
Policies for referencing.
Selector for a Function in cloudfunctions2 to populate name.
Policies for selection.
Contains information needed to make a TCP check. Structure is documented below.
Contains information needed to add pings to a TCP check. Structure is documented below.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
UptimeCheckConfigStatus defines the observed state of UptimeCheckConfig.
No description provided.
The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. Structure is documented below.
Information needed to perform a JSONPath content match. Used for ContentMatcherOption::MATCHES_JSON_PATH and ContentMatcherOption::NOT_MATCHES_JSON_PATH. Structure is documented below.
Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
Contains information needed to add pings to an HTTP check. Structure is documented below.
The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
The group resource associated with the configuration. Structure is documented below.
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
Contains information needed to make a TCP check. Structure is documented below.
Contains information needed to add pings to a TCP check. Structure is documented below.
Conditions of the resource.
example-http-uptime-check
apiVersion: monitoring.gcp.upbound.io/v1beta1
kind: UptimeCheckConfig
metadata:
annotations:
meta.upbound.io/example-id: monitoring/v1beta1/uptimecheckconfig
labels:
testing.upbound.io/example-name: http_uptime_check
name: example-http-uptime-check
spec:
forProvider:
checkerType: STATIC_IP_CHECKERS
contentMatchers:
- content: example
displayName: example-http-uptime-check
httpCheck:
- body: Zm9vJTI1M0RiYXI=
contentType: URL_ENCODED
path: some-path
port: 8010
requestMethod: POST
monitoredResource:
- labels:
host: 192.168.1.1
project_id: official-provider-testing
type: uptime_url
timeout: 60s
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.