Skip to main content

ElasticSearch

This check will try to connect to a specified ElasticSearch database, run a query against it and verify the results.

"Opensearch"
To connect to Opensearch use `opensearch` field instead of `elasticsearch`
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: elasticsearch-check
spec:
interval: 30
elasticsearch:
- url: http://elasticsearch.default.svc:9200
description: Elasticsearch checker
index: index
query: |
{
"query": {
"term": {
"system.role": "api"
}
}
}

results: 1
name: elasticsearch_pass
username:
valueFrom:
secretKeyRef:
name: elasticsearch-credentials
key: USERNAME
password:
valueFrom:
secretKeyRef:
name: elasticsearch-credentials
key: PASSWORD
FieldDescriptionSchemeRequired
indexIndex against which query should be ranstringYes
queryQuery that needs to be executed on the serverstringYes
resultsNumber of expected hitsintYes
*All other commons fieldCommon
Connection
connectionPath of existing connection e.g. connection://elastic/instance/ Mutually exclusive with username and `passwordConnection
usernameMutually exclusive with connectionEnvVar
passwordMutually exclusive with connectionEnvVar
urlhost:port addressstringYes