Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-grafana.Go to Latest
grafana/provider-grafana@v0.13.2
Check
sm.grafana.crossplane.io
Check
grafana/provider-grafana@v0.13.2sm.grafana.crossplane.io

Check is the Schema for the Checks API. Synthetic Monitoring checks are tests that run on selected probes at defined intervals and report metrics and logs back to your Grafana Cloud account. The target for checks can be a domain name, a server, or a website, depending on what information you would like to gather about your endpoint. You can define multiple checks for a single endpoint to check different capabilities. Official documentation https://grafana.com/docs/grafana-cloud/monitor-public-endpoints/checks/

Type

CRD

Group

sm.grafana.crossplane.io

Version

v1alpha1

apiVersion: sm.grafana.crossplane.io/v1alpha1

kind: Check

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

CheckSpec defines the desired state of Check

forProvider
requiredobject
requiredobject

No description provided.

enabled
boolean
frequency
number
job
string
labels
object
probes
array
array

(Set of Number) List of probe location IDs where this target will be checked from. List of probe location IDs where this target will be checked from.

array

(Block Set, Min: 1, Max: 1) Check settings. Should contain exactly one nested block. (see below for nested schema) Check settings. Should contain exactly one nested block.

dns
array
array

(Block Set, Max: 1) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records). (see below for nested schema) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records).

ipVersion
string
port
number
protocol
string
server
string
array

(Set of String) List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET. List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET.

array

(Block Set) Validate additional matches. (see below for nested schema) Validate additional matches.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response answer. (see below for nested schema) Validate response answer.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response authority. (see below for nested schema) Validate response authority.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

http
array
array

(Block Set, Max: 1) Settings for HTTP check. The target must be a URL (http or https). (see below for nested schema) Settings for HTTP check. The target must be a URL (http or https).

array

(Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings.

password
string
username
string
body
string
array

(Set of String) List of regexes. If any match the response body, the check will fail. List of regexes. If any match the response body, the check will fail.

array

(Set of String) List of regexes. If any do not match the response body, the check will fail. List of regexes. If any do not match the response body, the check will fail.

array

(Block Set) Check fails if headers match. (see below for nested schema) Check fails if headers match.

header
string
regexp
string
array

(Block Set) Check fails if headers do not match. (see below for nested schema) Check fails if headers do not match.

header
string
regexp
string
failIfSsl
boolean
headers
array
array

(Set of String) The HTTP headers set for the probe. The HTTP headers set for the probe.

ipVersion
string
method
string
array

(Set of String) The HTTP headers sent to the proxy URL The HTTP headers sent to the proxy URL

proxyUrl
string
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

caCert
string
object

(String, Sensitive) Client key in PEM format. Client key in PEM format.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

(Set of String) List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0 List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0

array

(Set of Number) Accepted status codes. If unset, defaults to 2xx. Accepted status codes. If unset, defaults to 2xx.

array

(Block Set, Max: 1) Settings for MultiHTTP check. The target must be a URL (http or https) (see below for nested schema) Settings for MultiHTTP check. The target must be a URL (http or https)

entries
array
array

(Block List) (see below for nested schema)

array

(Block List) Assertions to make on the request response (see below for nested schema) Assertions to make on the request response

condition
string
subject
string
type
string
value
string
request
array
array

(Block Set, Max: 1) An individual MultiHTTP request (see below for nested schema) An individual MultiHTTP request

body
array
array

(String) The body of the HTTP request used in probe. The body of the HTTP request used in probe.

headers
array
array

(Set of String) The HTTP headers set for the probe. The headers to send with the request

name
string
value
string
method
string
array

(Block Set) Query fields to send with the request (see below for nested schema) Query fields to send with the request

name
string
value
string
url
string
array

(Block List) Variables to extract from the request response (see below for nested schema) Variables to extract from the request response

attribute
string
name
string
type
string
ping
array
array

(Block Set, Max: 1) Settings for ping (ICMP) check. The target must be a valid hostname or IP address. (see below for nested schema) Settings for ping (ICMP) check. The target must be a valid hostname or IP address.

tcp
array
array

(Block Set, Max: 1) Settings for TCP check. The target must be of the form :, where the host portion must be a valid hostname or IP address. (see below for nested schema) Settings for TCP check. The target must be of the form <host>:<port>, where the host portion must be a valid hostname or IP address.

ipVersion
string
array

(Block Set) The query sent in the TCP probe and the expected associated response. (see below for nested schema) The query sent in the TCP probe and the expected associated response.

expect
string
send
string
startTls
boolean
tls
boolean
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

caCert
string
object

(String, Sensitive) Client key in PEM format. Client key in PEM format.

key
requiredstring
name
requiredstring
namespace
requiredstring
array

(Block Set, Max: 1) Settings for traceroute check. The target must be a valid hostname or IP address (see below for nested schema) Settings for traceroute check. The target must be a valid hostname or IP address

target
string
timeout
number
object

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.

enabled
boolean
frequency
number
job
string
labels
object
probes
array
array

(Set of Number) List of probe location IDs where this target will be checked from. List of probe location IDs where this target will be checked from.

array

(Block Set, Min: 1, Max: 1) Check settings. Should contain exactly one nested block. (see below for nested schema) Check settings. Should contain exactly one nested block.

dns
array
array

(Block Set, Max: 1) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records). (see below for nested schema) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records).

ipVersion
string
port
number
protocol
string
server
string
array

(Set of String) List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET. List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET.

array

(Block Set) Validate additional matches. (see below for nested schema) Validate additional matches.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response answer. (see below for nested schema) Validate response answer.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response authority. (see below for nested schema) Validate response authority.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

http
array
array

(Block Set, Max: 1) Settings for HTTP check. The target must be a URL (http or https). (see below for nested schema) Settings for HTTP check. The target must be a URL (http or https).

array

(Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings.

password
string
username
string
body
string
array

(Set of String) List of regexes. If any match the response body, the check will fail. List of regexes. If any match the response body, the check will fail.

array

(Set of String) List of regexes. If any do not match the response body, the check will fail. List of regexes. If any do not match the response body, the check will fail.

array

(Block Set) Check fails if headers match. (see below for nested schema) Check fails if headers match.

header
string
regexp
string
array

(Block Set) Check fails if headers do not match. (see below for nested schema) Check fails if headers do not match.

header
string
regexp
string
failIfSsl
boolean
headers
array
array

(Set of String) The HTTP headers set for the probe. The HTTP headers set for the probe.

ipVersion
string
method
string
array

(Set of String) The HTTP headers sent to the proxy URL The HTTP headers sent to the proxy URL

proxyUrl
string
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

array

(Set of String) List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0 List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0

array

(Set of Number) Accepted status codes. If unset, defaults to 2xx. Accepted status codes. If unset, defaults to 2xx.

array

(Block Set, Max: 1) Settings for MultiHTTP check. The target must be a URL (http or https) (see below for nested schema) Settings for MultiHTTP check. The target must be a URL (http or https)

entries
array
array

(Block List) (see below for nested schema)

array

(Block List) Assertions to make on the request response (see below for nested schema) Assertions to make on the request response

condition
string
subject
string
type
string
value
string
request
array
array

(Block Set, Max: 1) An individual MultiHTTP request (see below for nested schema) An individual MultiHTTP request

body
array
array

(String) The body of the HTTP request used in probe. The body of the HTTP request used in probe.

headers
array
array

(Set of String) The HTTP headers set for the probe. The headers to send with the request

name
string
value
string
method
string
array

(Block Set) Query fields to send with the request (see below for nested schema) Query fields to send with the request

name
string
value
string
url
string
array

(Block List) Variables to extract from the request response (see below for nested schema) Variables to extract from the request response

attribute
string
name
string
type
string
ping
array
array

(Block Set, Max: 1) Settings for ping (ICMP) check. The target must be a valid hostname or IP address. (see below for nested schema) Settings for ping (ICMP) check. The target must be a valid hostname or IP address.

tcp
array
array

(Block Set, Max: 1) Settings for TCP check. The target must be of the form :, where the host portion must be a valid hostname or IP address. (see below for nested schema) Settings for TCP check. The target must be of the form <host>:<port>, where the host portion must be a valid hostname or IP address.

ipVersion
string
array

(Block Set) The query sent in the TCP probe and the expected associated response. (see below for nested schema) The query sent in the TCP probe and the expected associated response.

expect
string
send
string
startTls
boolean
tls
boolean
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

array

(Block Set, Max: 1) Settings for traceroute check. The target must be a valid hostname or IP address (see below for nested schema) Settings for traceroute check. The target must be a valid hostname or IP address

target
string
timeout
number
array

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

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

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.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

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.

name
requiredstring
namespace
requiredstring
status
object
object

CheckStatus defines the observed state of Check.

object

No description provided.

enabled
boolean
frequency
number
id
string
job
string
labels
object
probes
array
array

(Set of Number) List of probe location IDs where this target will be checked from. List of probe location IDs where this target will be checked from.

array

(Block Set, Min: 1, Max: 1) Check settings. Should contain exactly one nested block. (see below for nested schema) Check settings. Should contain exactly one nested block.

dns
array
array

(Block Set, Max: 1) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records). (see below for nested schema) Settings for DNS check. The target must be a valid hostname (or IP address for PTR records).

ipVersion
string
port
number
protocol
string
server
string
array

(Set of String) List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET. List of valid response codes. Options include NOERROR, BADALG, BADMODE, BADKEY, BADCOOKIE, BADNAME, BADSIG, BADTIME, BADTRUNC, BADVERS, FORMERR, NOTIMP, NOTAUTH, NOTZONE, NXDOMAIN, NXRRSET, REFUSED, SERVFAIL, YXDOMAIN, YXRRSET.

array

(Block Set) Validate additional matches. (see below for nested schema) Validate additional matches.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response answer. (see below for nested schema) Validate response answer.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

array

(Block Set, Max: 1) Validate response authority. (see below for nested schema) Validate response authority.

array

(Set of String) Fail if value matches regex. Fail if value matches regex.

array

(Set of String) Fail if value does not match regex. Fail if value does not match regex.

http
array
array

(Block Set, Max: 1) Settings for HTTP check. The target must be a URL (http or https). (see below for nested schema) Settings for HTTP check. The target must be a URL (http or https).

array

(Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings.

password
string
username
string
body
string
array

(Set of String) List of regexes. If any match the response body, the check will fail. List of regexes. If any match the response body, the check will fail.

array

(Set of String) List of regexes. If any do not match the response body, the check will fail. List of regexes. If any do not match the response body, the check will fail.

array

(Block Set) Check fails if headers match. (see below for nested schema) Check fails if headers match.

header
string
regexp
string
array

(Block Set) Check fails if headers do not match. (see below for nested schema) Check fails if headers do not match.

header
string
regexp
string
failIfSsl
boolean
headers
array
array

(Set of String) The HTTP headers set for the probe. The HTTP headers set for the probe.

ipVersion
string
method
string
array

(Set of String) The HTTP headers sent to the proxy URL The HTTP headers sent to the proxy URL

proxyUrl
string
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

array

(Set of String) List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0 List of valid HTTP versions. Options include HTTP/1.0, HTTP/1.1, HTTP/2.0

array

(Set of Number) Accepted status codes. If unset, defaults to 2xx. Accepted status codes. If unset, defaults to 2xx.

array

(Block Set, Max: 1) Settings for MultiHTTP check. The target must be a URL (http or https) (see below for nested schema) Settings for MultiHTTP check. The target must be a URL (http or https)

entries
array
array

(Block List) (see below for nested schema)

array

(Block List) Assertions to make on the request response (see below for nested schema) Assertions to make on the request response

condition
string
subject
string
type
string
value
string
request
array
array

(Block Set, Max: 1) An individual MultiHTTP request (see below for nested schema) An individual MultiHTTP request

body
array
array

(String) The body of the HTTP request used in probe. The body of the HTTP request used in probe.

headers
array
array

(Set of String) The HTTP headers set for the probe. The headers to send with the request

name
string
value
string
method
string
array

(Block Set) Query fields to send with the request (see below for nested schema) Query fields to send with the request

name
string
value
string
url
string
array

(Block List) Variables to extract from the request response (see below for nested schema) Variables to extract from the request response

attribute
string
name
string
type
string
ping
array
array

(Block Set, Max: 1) Settings for ping (ICMP) check. The target must be a valid hostname or IP address. (see below for nested schema) Settings for ping (ICMP) check. The target must be a valid hostname or IP address.

tcp
array
array

(Block Set, Max: 1) Settings for TCP check. The target must be of the form :, where the host portion must be a valid hostname or IP address. (see below for nested schema) Settings for TCP check. The target must be of the form <host>:<port>, where the host portion must be a valid hostname or IP address.

ipVersion
string
array

(Block Set) The query sent in the TCP probe and the expected associated response. (see below for nested schema) The query sent in the TCP probe and the expected associated response.

expect
string
send
string
startTls
boolean
tls
boolean
array

(Block Set, Max: 1) TLS config. (see below for nested schema) TLS config.

array

(Block Set, Max: 1) Settings for traceroute check. The target must be a valid hostname or IP address (see below for nested schema) Settings for traceroute check. The target must be a valid hostname or IP address

target
string
tenantId
number
timeout
number
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.