Helm
+# 
HTTP
+
+# Mutually exclusive with `username`, `password`
ICMP
+# 
JMeter
+# 
JUnit
+# K6
+# 
Kubernetes
+# 
LDAP
+# *Mutually exclusive with `connection`* | `string` | | +| `username` | *Mutually exclusive with `connection`* | [*EnvVar*](../../concepts/authentication/#envvar) | | +| `password` | *Mutually exclusive with `connection`* | [*EnvVar*](../../concepts/authentication/#envvar) | | | `skipTLSVerify` | Skip check of LDAP server TLS certificates | *bool* | | diff --git a/docs/canary-checker/docs/reference/mongo.md b/docs/canary-checker/docs/reference/mongo.md index bcbd4295..c4c542e1 100644 --- a/docs/canary-checker/docs/reference/mongo.md +++ b/docs/canary-checker/docs/reference/mongo.md @@ -2,7 +2,7 @@ title: MongoDB --- -#
MongoDB
+# 
MSSQL
+# 
MySQL
+# 
Namespace
+# Newman
+# Playwright
+# 
Pod
+# 
Postgres
+# 
Prometheus
+# Mutually exclusive with `url`
Redis
+# Mutually exclusive with `url`
Restic
+# Mutually exclusive with `password`
Mutually exclusive with `accessKey`
S3 Bucket
-
+# Mutually exclusive with `accessKey` and `secretKey`
S3 Protocol
+# 
SFTPConnection
+# Mutually exclusive with `username`
Windows File Share (SMB/CIFS)
+# Mutually exclusive with`username` and `password`
TCP
+# - .slice(
-
+ ++++++
+ +++ Synthetic (Active) Checks +
++ Generate synthetic traffic, run queries against various datasources, or even run full integration test suites to verify the health of your services and infrastructure. +
+
+ -
+ ++++++
+ +++ Passive Checks +
++ Consolidate alerts across your monitoring stack and create alerts from non-traditional sources like SQL, NoSQL and CI/CD pipelines. +
+
+ -
+ ++++++
+ +++ Infrastructure +
++ Batteries including support for HTTP, DNS, ICMP, LDAP, Prometheus, SQL, Mongo, Redis, Github, Azure Devops, JMeter, K6, Playwright, Newman/Postman, SMB, SFTP, +
+
+ - + + SaaS + +
- Hosted Platform on either AWS or Azure +
- + + On Premise + +
- Run inside your own data center or Bring Your Own Cloud +
- + + Resource Catalog & Change Tracking + +
- Track both application and infrastructure resources across multiple clouds. +
- + + Playbooks + +
- Run automated playbooks based on canary checker health changes +
- + + Notifications + +
- Send notifications to 10+ different targets when canaries fail +
- + + Topology + +
- Map your complex system in multiple dimensions +
-
+```
+
+Examples:
+
+```javascript
+[1,2,3,4].slice(1, 3) // return [2, 3]
+[1,2,3,4].slice(2, 4) // return [3 ,4]
+```
+
+---
+
+### sets.contains
+
+Returns whether the first list argument contains all elements in the second
+list argument. The list may contain elements of any type and standard CEL
+equality is used to determine whether a value exists in both lists. If the
+second list is empty, the result will always return true.
+
+```javascript
+sets.contains(list(T), list(T)) -> bool
+```
+
+Examples:
+
+```javascript
+sets.contains([], []) // true
+sets.contains([], [1]) // false
+sets.contains([1, 2, 3, 4], [2, 3]) // true
+sets.contains([1, 2.0, 3u], [1.0, 2u, 3]) // true
+```
+
+---
+
+### sets.equivalent
+
+Returns whether the first and second list are set equivalent. Lists are set
+equivalent if for every item in the first list, there is an element in the
+second which is equal. The lists may not be of the same size as they do not
+guarantee the elements within them are unique, so size does not factor into
+the computation.
+
+ sets.equivalent(list(T), list(T)) -> bool
+
+Examples:
+
+```javascript
+sets.equivalent([], []) // true
+sets.equivalent([1], [1, 1]) // true
+sets.equivalent([1], [1u, 1.0]) // true
+sets.equivalent([1, 2, 3], [3u, 2.0, 1]) // true
+```
+
+---
+
+### sets.intersects
+
+Returns whether the first list has at least one element whose value is equal
+to an element in the second list. If either list is empty, the result will
+be false.
+
+ sets.intersects(list(T), list(T)) -> bool
+
+Examples:
+
+```javascript
+sets.intersects([1], []) // false
+sets.intersects([1], [1, 2]) // true
+sets.intersects([[1], [2, 3]], [[1, 2], [2, 3.0]]) // true
+```
+
+---
+
+## Strings
+
+### matches
+
+The `matches` function in CEL is used to determine if a string matches a given regular expression pattern. It returns a boolean value indicating whether the string conforms to the pattern.
+
+Syntax:
+
+```javascript
+string.matches(pattern)
+```
+
+Where:
+
+- `string` is the string you're checking.
+- `pattern` is the regular expression pattern you're matching against.
+
+Examples:
+
+```javascript
+// Checking if a string matches a simple pattern:
+"apple".matches("^a.*e$") // Evaluates to true
+
+// Validating an email format:
+"example@email.com".matches("^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$") // Evaluates to true
+
+// Checking for a pattern of digits:
+"12345".matches("^\\d+$") // Evaluates to true
+```
+---
+
+### startsWith
+
+The `startsWith` function in CEL is used to determine if a string starts with a specified substring.
+
+Syntax:
+
+ string.startsWith(substring)
+
+Examples:
+
+```javascript
+// Checking if a string starts with a certain substring:
+"hello".startsWith("he") // Evaluates to true
+```
+
+---
+
+### endsWith
+
+The `endsWith` function in CEL is used to determine if a string ends with a specified substring.
+
+Syntax:
+
+ string.endsWith(substring)
+
+Examples:
+
+```javascript
+// Checking if a string ends with a certain substring:
+"hello".endsWith("lo") // Evaluates to true
+```
+
+---
+
+### contains
+
+The `contains` function in CEL is used to check if a string contains a given substring.
+
+Syntax:
+
+ string.contains(substring)
+
+Examples:
+
+```javascript
+//Checking if a string contains a certain substring:
+"apple".contains("app") // Evaluates to true
+```
+
+---
+
+### size
+
+The `size` function in CEL is used to determine the number of elements in a collection or the number of Unicode characters in a string.
+
+Syntax:
+
+ collection.size() or string.size()
+
+Examples:
+
+```javascript
+// Getting the size of a list:
+["apple", "banana", "cherry"].size() // Evaluates to 3
+
+// Determining the number of characters in a string:
+"hello".size() // Evaluates to 5
+```
+
+---
+
+### charAt
+
+Returns the character at the given position. If the position is negative, or
+greater than the length of the string, the function will produce an error:
+
+
Alertmanager
-
-Checks [Prometheus AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) for any firing alerts.
-
-The following example [transforms](../concepts/transforms.md) the list of alerts so that each alert becomes a single check result. Without the transform the health check will fail if any alerts are firing.
-
-```yaml title="alert-manager-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: alertmanager-check
-spec:
- schedule: "*/5 * * * *"
- alertmanager:
- - host: alertmanager.example.com
- alerts:
- - .*
- ignore:
- - KubeScheduler.*
- - Watchdog
- transform:
- javascript: |
- var out = _.map(results, function(r) {
- return {
- name: r.name,
- labels: r.labels,
- icon: 'alert',
- message: r.message,
- description: r.message,
- }
- })
- JSON.stringify(out);
-```
-
-| Field | Description | Scheme | Required |
-| ------------- | ------------------------------------------------------------ | -------------------------------------------------- | -------- |
-| `alerts` | A list of alert prefix names to include | `[]string` | |
-| `ignore` | A list of alert prefix names to exclude | `[]string` | |
-| `filters` | A map of label to value prefixes to find alerts on | `map[string]string` | |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://alertmanager/instance`/ Mutually exclusive with `username`, `password`, `host` | [Connection](../../concepts/connections) | |
-| `host` | Host endpoint mutually exclusive with `connection` | `string` | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-
diff --git a/docs/canary-checker/reference/aws-config-rule.md b/docs/canary-checker/reference/aws-config-rule.md
deleted file mode 100644
index 5f9bf345..00000000
--- a/docs/canary-checker/reference/aws-config-rule.md
+++ /dev/null
@@ -1,80 +0,0 @@
-# 
AWS Config Rule
-
-Check if any AWS resources are failing AWS config rule checks.
-
- ```yaml
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfigRule:
- - description: "AWS Config Rule Checker"
- name: AWS Config Rule Checker
- rules:
- - "s3-bucket-public-read-prohibited"
- ignoreRules:
- - "s3-bucket-public-write-prohibited"
- ```
-
-| Field | Description | Scheme | Required |
-| ----------------- | ------------------------------------------------------------ | ------------------------------------------------- | -------- |
-| `rules` | Specify one or more Config rule names to filter the results by rule. | `[]string` | |
-| `ignoreRules` | List of rules which would be omitted from the fetch result. | `[]string` | |
-| `complianceTypes` | Filters the results by compliance. The allowed values are `INSUFFICIENT_DATA`, `NON_COMPLIANT`, `NOT_APPLICABLE`, `COMPLIANT` | `[]string` | |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://aws/instance`/ Mutuall exclusive with `accessKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `endpoint` | Custom AWS Config endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to AWS | *bool* | |
-
-### Connecting to AWS
-
-There are 3 options when connecting to AWS:
-
-1. An AWS [instance profile](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) or [pod identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-configuration.html) (the default if no `connection` or `accessKey` is specified)
-2. `connection`, this is the recommended method, connections are reusable and secure
-
- ```yaml title="aws-connection.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfigRule:
- - name: AWS Config Rule Checker
- connection: connection://aws/internal
- rules:
- - "s3-bucket-public-read-prohibited"
- ```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
- ```yaml title="aws.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfigRule:
- - name: AWS Config Rule Checker
- accessKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: us-east-1
- rules:
- - "s3-bucket-public-read-prohibited"
- ```
diff --git a/docs/canary-checker/reference/aws-config.md b/docs/canary-checker/reference/aws-config.md
deleted file mode 100644
index df6cf9c2..00000000
--- a/docs/canary-checker/reference/aws-config.md
+++ /dev/null
@@ -1,87 +0,0 @@
-# AWS Config
-
-AWS Config checks .
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: exec-check
-spec:
- interval: 30
- awsConfig:
- - description: "Check the config"
- name: config check
- query: "SELECT * FROM aws_config_rule"
-```
-
-| Field | Description | Scheme | Required |
-| ---------------- | ------------------------------------------------------------ | ------------------------------------------------- | -------- |
-| **`query`** | The SQL query SELECT command | `string` | `true` |
-| `aggregatorName` | Specify the name of the configuration aggregator | `string` | |
-| `*` | All other commons fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://aws/instance` Mutuall exclusive with `accessKey`, `secretKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `endpoint` | Custom AWS endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to AWS | *bool* | |
-
-### Connecting to AWS
-
-There are 3 options when connecting to AWS:
-
-1. An AWS [instance profile](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) or [pod identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-configuration.html) (the default if no `connection` or `accessKey` is specified)
-
- ```yaml title="aws-config.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfig:
- - name: AWS Config check
- query: "SELECT * FROM aws_config_rule"
- ```
-
-2. `connection`, this is the recommended method, connections are reusable and secure
-
- ```yaml title="aws-connection.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfig:
- - name: AWS Config check
- connection: connection://aws/internal
- query: "SELECT * FROM aws_config_rule"
- ```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret
-
- ```yaml title="aws-static.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfig:
- - accessKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: us-east-1
- name: AWS Config check
- query: "SELECT * FROM aws_config_rule"
- ```
diff --git a/docs/canary-checker/reference/aws.md b/docs/canary-checker/reference/aws.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/canary-checker/reference/azure-devops.md b/docs/canary-checker/reference/azure-devops.md
deleted file mode 100644
index 48c8ee72..00000000
--- a/docs/canary-checker/reference/azure-devops.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# 
Azure Devops
-
-Azure Devops checks for healthy pipeline runs.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: azure-devops
-spec:
- interval: 300
- azureDevops:
- - project: Demo1
- pipeline: ^windows-
- personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- organization: flanksource
- variable:
- env: prod
- branch:
- - main
- thresholdMillis: 60000 # 60 seconds
-```
-
-| Field | Description | Scheme | Required |
-| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------- | -------- |
-| **`organization`** | Name of the Azure Organization. | `string` | true |
-| **`project`** | The name or ID of the project. | `string` | true |
-| **`pipeline`** | Name/Regexp to select the interested pipeline. | `string` | true |
-| `variables` | Only match those runs that match these variables | `map[string]string` | |
-| `branch` | Only match those runs that are run on these branch. | `[]string` | |
-| `thresholdMillis` | Maximum duration of a run after which it's considered unhealthy. | `int` | |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Connection Name e.g. `connection://azuredevops/org` Mutually exclusive with `personalAccessToken` | `string` | |
-| **`personalAccessToken`** | Mutually exclusive with `connection`, See [Creating ADO PAT's](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) | [*EnvVar*](../../concepts/authentication/#envvar) | true |
diff --git a/docs/canary-checker/reference/canary-spec.md b/docs/canary-checker/reference/canary-spec.md
deleted file mode 100644
index 97c432fd..00000000
--- a/docs/canary-checker/reference/canary-spec.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# Canary Spec
-
-| Field | Description | Type | Required |
-| ---------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------- |
-| `env` | Environment variables. | `map[string]`[`VarSource`](#varsource) | |
-| `schedule` | Schedule to run checks on.Supports all cron expression.
Also supports golang duration. | `string` | | -| `icon` | Icon to use for the check. | `string` | | -| `severity` | Severity of the check. | `string` | | -| `owner` | Owner of the check. | `string` | | -| `resultmode` | Result mode of the check. | `string` | | -| `alertmanager` | List of AlertManager checks to run. | [`[]AlertManagerCheck`](./alert-manager.md) | | -| `awsConfig` | List of AWS Config checks to run. | [`[]AwsConfigCheck`](./aws-config.md) | | -| `awsConfigRule` | List of AWS Config Rule checks to run. | [`[]AwsConfigRuleCheck`](./aws-config-rule.md) | | -| `cloudwatch` | List of CloudWatch checks to run. | [`[]CloudWatchCheck`](./cloudwatch.md) | | -| `configDB` | List of config DB checks to run. | [`[]ConfigDBCheck`](./configdb.md) | | -| `containerd` | List of containerd pull checks to run. | [`[]ContainerdPullCheck`](./containerd-pull.md) | | -| `containerdPush` | List of containerd push checks to run. | [`[]ContainerdPushCheck`](./containerd-push.md) | | -| `databaseBackup` | List of database backup checks to run. | [`[]DatabaseBackupCheck`](./gcs-database-backup.md) | | -| `dns` | List of DNS checks to run. | [`[]DNSCheck`](./dns.md) | | -| `docker` | List of Docker pull checks to run. | [`[]DockerPullCheck`](./docker-pull.md) | | -| `dockerPush` | List of Docker push checks to run. | [`[]DockerPushCheck`](./docker-push.md) | | -| `ec2` | List of EC2 checks to run. | [`[]EC2Check`](./ec2.md) | | -| `elasticsearch` | List of ElasticSearch checks to run. | [`[]ElasticsearchCheck`](./elasticsearch.md) | | -| `exec` | List of exec checks to run. | [`[]ExecCheck`](./exec.md) | | -| `folder` | List of folder checks to run. | [`[]FolderCheck`](./folder.md) | | -| `github` | List of GitHub checks to run. | [`[]GitHubCheck`](./github.md) | | -| `helm` | List of Helm checks to run. | [`[]HelmCheck`](./helm.md) | | -| `http` | List of HTTP checks to run. | [`[]HTTPCheck`](./http.md) | | -| `icmp` | List of ICMP checks to run. | [`[]ICMPCheck`](./icmp.md) | | -| `jmeter` | List of JMeter load test checks to run. | [`[]JmeterCheck`](./jmeter.md) | | -| `junit` | List of JUnit test result checks to run. | [`[]JunitCheck`](./junit.md) | | -| `kubernetes` | List of Kubernetes checks to run. | [`[]KubernetesCheck`](./kubernetes.md) | | -| `ldap` | List of LDAP checks to run. | [`[]LDAPCheck`](./ldap.md) | | -| `mongodb` | List of MongoDB checks to run. | [`[]MongoDBCheck`](./mongo.md) | | -| `mssql` | List of MSSQL checks to run. | [`[]MssqlCheck`](./mssql.md) | | -| `mysql` | List of MySQL checks to run. | [`[]MysqlCheck`](./mysql.md) | | -| `namespace` | List of namespace checks to run. | [`[]NamespaceCheck`](./namespace.md) | | -| `pod` | List of pod checks to run. | [`[]PodCheck`](./pod.md) | | -| `postgres` | List of Postgres checks to run. | [`[]PostgresCheck`](./postgres.md) | | -| `prometheus` | List of Prometheus checks to run. | [`[]PrometheusCheck`](./prometheus.md) | | -| `redis` | List of Redis checks to run. | [`[]RedisCheck`](./redis.md) | | -| `restic` | List of restic backup checks to run. | [`[]ResticCheck`](./restic.md) | | -| `s3` | List of S3 checks to run. | [`[]S3Check`](./s3.md) | | -| `tcp` | List of TCP checks to run. | [`[]TCPCheck`](./tcp.md) | | - -## Scheme Reference - -### VarSource - -| Field | Description | Type | Required | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -------- | -| `value` | | `string` | | -| `fieldRef` | Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. | [`ObjectFieldSelector`](#objectfieldselector) | | -| `configMapKeyRef` | Selects a key of a ConfigMap. | [`ConfigMapKeySelector`](#configmapkeyselector) | | -| `secretKeyRef` | Selects a key of a secret in the pod's namespace | [`SecretKeySelector`](#secretkeyselector) | | - -### ObjectFieldSelector - -| Field | Description | Type | Required | -| ------------ | ----------------------------------------------------------------------------- | -------- | -------- | -| `apiVersion` | Version of the schema the FieldPath is written in terms of, defaults to "v1". | `string` | | -| `fieldPath` | Path of the field to select in the specified API version. | `string` | | - -### ConfigMapKeySelector - -| Field | Description | Type | Required | -| ---------- | -------------------------------------------------------- | -------- | -------- | -| `name` | Name of the referent. | `string` | | -| `key` | The key to select. | `string` | | -| `optional` | Specify whether the ConfigMap or its key must be defined | `bool` | | - -### SecretKeySelector - -| Field | Description | Type | Required | -| ---------- | ----------------------------------------------------------------- | -------- | -------- | -| `name` | Name of the referent. | `string` | | -| `key` | The key of the secret to select from. Must be a valid secret key. | `string` | | -| `optional` | Specify whether the Secret or its key must be defined | `bool` | | diff --git a/docs/canary-checker/reference/cloudwatch.md b/docs/canary-checker/reference/cloudwatch.md deleted file mode 100644 index 547e5a75..00000000 --- a/docs/canary-checker/reference/cloudwatch.md +++ /dev/null @@ -1,83 +0,0 @@ -#
CloudWatch
-
-Cloudwatch checks for all active alarms
-
-```yaml title="cloudwatch-alarms.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: cloudwatch-check
-spec:
- interval: 30
- cloudwatch:
- - name: cloudwatch-check
- accessKey:
- valueFrom:
- secretKeyRef:
- key: AWS_ACCESS_KEY_ID
- name: aws-credentials
- secretKey:
- valueFrom:
- secretKeyRef:
- key: AWS_SECRET_ACCESS_KEY
- name: aws-credentials
- region: "us-east-1"
- #skipTLSVerify: true
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `actionPrefix` | Use to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic. | *string* | |
-| `alarmPrefix` | Specify to receive information about all alarms that have names that start with this prefix. | *string* | |
-| `alarms` | Set field to retrieve information about alarm | *\[\]string* | |
-| `state` | Specify to retrieve state value of alarm | *string* | |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://aws/instance`/. Mutually exclusive with `accessKey` and `secretKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `endpoint` | Custom AWS endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to aws | *bool* | |
-
-### Connecting to AWS
-
-There are 3 options when connecting to AWS:
-
-1. An AWS [instance profile](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) or [pod identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-configuration.html) (the default if no `connection` or `accessKey` is specified)
-2. `connection`, this is the recommended method, connections are reusable and secure
-
- ```yaml title="aws-connection.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: cloudwatch-check
- spec:
- interval: 30
- cloudwatch:
- - connection: connection://aws/internal
- region: us-east-1 # optional if specified in the connection
- ```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
- ```yaml title="aws.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: cloudwatch-check
- spec:
- interval: 30
- cloudwatch:
- - accessKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: us-east-1
- ```
diff --git a/docs/canary-checker/reference/common.md b/docs/canary-checker/reference/common.md
deleted file mode 100644
index 052a38da..00000000
--- a/docs/canary-checker/reference/common.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# Common Fields
-
-All check types support the following fields:
-
-| Field | Description | Scheme | Required |
-| ------------- | -------------------------------------------------- | --------------------------------------- | -------- |
-| **`name`** | Name of the check | `string` | Yes |
-| `filters` | A map of label to value prefixes to find alerts on | `map[string]string` | |
-| `description` | Description for the check | `string` | |
-| `icon` | Icon for overwriting default icon on the dashboard | `string` | |
-| `labels` | Labels for check | `map[string]string` | |
-| `test` | Template to test the result against | [`Template`](../concepts/templating.md) | |
-| `display` | Template to display the result in | [`Template`](../concepts/templating.md) | |
-| `transform` | Template for transformation | [`Template`](../concepts/templating.md) | |
\ No newline at end of file
diff --git a/docs/canary-checker/reference/configdb.md b/docs/canary-checker/reference/configdb.md
deleted file mode 100644
index d5d84266..00000000
--- a/docs/canary-checker/reference/configdb.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# 
Config DB Query
-
-ConfigDB check connects to the specified database host, run a specified query for your configuration data, and return the result.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: configdb-check
-spec:
- interval: 30
- configDB:
- - name: ConfigDB Check
- query: 
ContainerD / Docker
-
-This check will try to pull a Docker image from specified registry using containerd and then verify its checksum and size.
-
-!!! danger "Root Privileges Required"
- The containerd and docker health checks require access to a working socket that is mounted at runtime
-
-## Pulling images
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: containerd-pull-check
-spec:
- interval: 30
- containerd: # use docker if running outside kubernetes / docker
- - image: docker.io/library/busybox:1.31.1
- expectedDigest: sha256:95cf004f559831017cdf4628aaf1bb30133677be8702a8c5f2994629f637a209
- expectedSize: 764556
-
-```
-
-| Field | Description | Scheme | Required |
-| ---------------- | ------------------------------------------------------------ | ------------------------------------------------- | -------- |
-| `auth` | Username and password value, configMapKeyRef or SecretKeyRef for registry | [_Authentication_](../concepts/authentication.md) | |
-| `expectedDigest` | Expected digest of the pulled image | _string_ | Yes |
-| `expectedSize` | Expected size of the pulled image | _int64_ | Yes |
-| **`image`** | Full path to image, including registry | _string_ | Yes |
-| `*` | All other commons field | [*Common*](../common) | |
-
----
-
-## Pushing images
-
-This check will try to push a Docker image to a specified registry using containerd.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: containerd-push-check
-spec:
- interval: 30
- containerdPush: # use dockerPush if running outside kubernetes / docker
- - name: ContainerdPush Check
- image: docker.io/library/busybox:1.31.1
- username: 
DNS
-
-Performs queries to a DNS server, typical use cases include:
-
-* Checking the latency of the DNS server in a Kubernetes cluster
-* Verifying that there are serving records for a DNS based load balancer.
-
-```yaml title="dns-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: dns-check
-spec:
- interval: 30
- dns:
- - name: A record query
- server: 8.8.8.8
- port: 53
- query: "1.2.3.4.nip.io"
- querytype: "A"
- minrecords: 1
- exactreply: ["1.2.3.4"]
- timeout: 10
- thresholdMillis: 1000
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`server`** | Address of DNS server to query e.g. `8.8.8.8` | *string* | Yes |
-| **`port`** | Port to query DNS server on, e.g. `53` | *int* | Yes |
-| **`query`** | Domain name to lookup | *string* | Yes |
-| **`querytype`** | Record type to query e.g. `A`, `CNAME` | *string* | Yes |
-| `exactreply` | Expected exact match result(s) | *\[\]string* | |
-| `minrecords` | Minimum records | *int* | |
-| `thresholdMillis` | Threshold response time from DNS server | *int* | |
-| `timeout` | Timeout in seconds | *int* | |
-| `*` | All other commons field | [*Common*](../common) | |
diff --git a/docs/canary-checker/reference/dynatrace.md b/docs/canary-checker/reference/dynatrace.md
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/canary-checker/reference/ec2.md b/docs/canary-checker/reference/ec2.md
deleted file mode 100644
index 556b020c..00000000
--- a/docs/canary-checker/reference/ec2.md
+++ /dev/null
@@ -1,105 +0,0 @@
-# 
EC2
-
-This check connects to an AWS account with the specified credentials, launch an EC2 instance with an option for `userData`.
-This test can be used to check the availability of an ami, account service limits, run backup & restore operations, etc.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: ec2-check
-spec:
- interval: 30
- ec2:
- - name: ec2-check
- ami: ami-04f7efe62f419d9f5
- description: test instance
- accessKeyID:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: af-south-1
- userData: |
- #!/bin/bash
- yum install -y httpd
- systemctl start httpd
- systemctl enable httpd
- usermod -a -G apache ec2-user
- chown -R ec2-user:apache /var/www
- chmod 2775 /var/www
- find /var/www -type d -exec chmod 2775 {} \;
- find /var/www -type f -exec chmod 0664 {} \;
- securityGroup: WebAccess
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `ami` | Master image to create EC2 instance from | string | Yes |
-| `canaryRef` | Reference Canary object | \[\][*v1.LocalObjectReference*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#localobjectreference-v1-core) | |
-| `keepAlive` | Toggle keepalive with `true` or `false` | *bool* | |
-| `securityGroup` | Security groups to attach to the EC2 instance | *string* | |
-| `timeout` | Set keep-alive timeout | *int* | |
-| `userData` | Configure EC2 instance with user data | *string* | |
-| `waitTime` | Set wait-time for EC2 instance launch | *int* | |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://aws/instance`/. Mutually exclusive with `accessKey` and `secretKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `endpoint` | Custom AWS endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to aws | *bool* | |
-
-### Connecting to AWS
-
-There are 3 options when connecting to AWS:
-
-1. An AWS [instance profile](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) or [pod identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-configuration.html) (the default if no `connection` or `accessKey` is specified)
-
-2. `connection`, this is the recommended method, connections are reusable and secure
-
- ```yaml title="aws-connection.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfigRule:
- - name: AWS Config Rule Checker
- connection: connection://aws/internal
- rules:
- - "s3-bucket-public-read-prohibited"
- ```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
- ```yaml title="aws.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- awsConfigRule:
- - name: AWS Config Rule Checker
- accessKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: us-east-1
- rules:
- - "s3-bucket-public-read-prohibited"
- ```
diff --git a/docs/canary-checker/reference/elasticsearch.md b/docs/canary-checker/reference/elasticsearch.md
deleted file mode 100644
index e99e236b..00000000
--- a/docs/canary-checker/reference/elasticsearch.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# 
ElasticSearch
-
-This check will try to connect to a specified ElasticSearch database, run a query against it and verify the results.
-
-!!! note "Opensearch"
- To connect to Opensearch use `opensearch` field instead of `elasticsearch`
-
-
-```yaml
-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
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`index`** | Index against which query should be ran | *string* | Yes |
-| **`query`** | Query that needs to be executed on the server | *string* | Yes |
-| **`results`** | Number of expected hits | *int* | Yes |
-| `*` | All other commons field | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://elastic/instance`/ Mutually exclusive with `username` and `password | [Connection](../../concepts/connections) | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `url` | host:port address | *string* | Yes |
diff --git a/docs/canary-checker/reference/exec.md b/docs/canary-checker/reference/exec.md
deleted file mode 100644
index 5c71e46c..00000000
--- a/docs/canary-checker/reference/exec.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# 
Exec
-
-Exec Check executes a command or script file on the target host. The type of scripts executed include:
-
-- Bash scripts
-- Powershell scripts
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: exec-check
-spec:
- interval: 30
- exec:
- - description: "exec dummy check"
- script: |
- echo "hello"
- name: exec-pass-check
- test:
- expr: 'results.Stdout == "hello"'
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`script`** | Script can be a inline script or a path to a script that needs to be executed. On windows executed via Powershell and in darwin and linux executed using bash. | *string* | Yes |
-| `*` | All other commons field | [*Common*](../common) | |
diff --git a/docs/canary-checker/reference/folder.md b/docs/canary-checker/reference/folder.md
deleted file mode 100644
index b3c59d68..00000000
--- a/docs/canary-checker/reference/folder.md
+++ /dev/null
@@ -1,101 +0,0 @@
-# 
Folder
-
-Checks the contents of a folder for size, age and count. Folder based checks are useful in a number of scenarios:
-
-* Verifying that backups have been uploaded and are the appropiate size
-* Checking that logs or other temporary files are being cleaned up
-* For batch processes:
- * Checking if files are being processed (and/or produced)
- * Checking the size of queue processing backlog
- * Checking if any error (`.err` or `.log`) files have been produced.
-
-
-```yaml title="folder-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: folder-check
-spec:
- interval: 30
- folder:
- - path: /etc/
- name: folder-check-min
- description: Checks if there are at least 10 files in the folder
- minCount: 10
-```
-
-
-| Field | Description | Scheme | Required |
-| ---------- | ------------------------------------------------------------ | ------------------------------- | -------- |
-| **`path`** | A local folder path or a remote folder ([SMB](../smb), [SFTP](../sftp), [S3](../s3-bucket), [GCS](../gcs-bucket)) | string | Yes |
-| `filter` | Filter objects out before checking if they are valid | [*FolderFilter*](#folderfilter) | |
-| `minCount` | The minimum number of files inside the `path` | int | |
-| `maxCount` | The maximum number of files inside the `path`, can be used in conjunction with `filter.regex` to detect error files | *int* | |
-| `minAge` | The youngest age a file can be | [*Duration*](#duration) | |
-| `maxAge` | The oldest age a file can be, often used to check for unprocessed files or files that have not been cleaned up | [*Duration*](#duration) | |
-| `minSize` | The minimum file size, can be used to detect backups that did not upload successfully | [Size](#size) | |
-| `maxSize` | The maximim file size | [Size](#size) | |
-| `*` | All other commons field | [*Common*](../common) | |
-
-## Duration
-
-Durations are strings with an optional fraction and unit e.g. `300ms`, `1.5h` or `2h45m`. Valid time units are `ms`, `s`, `m`, `h`.
-
-## Size
-
-Sizes are string with a unit suffix e.g. `100` / `100b`, `10mb`, Valid size units are `kb`, `mb`, `gb`, `tb`
-
-## FolderFilter
-
-| Field | Description | Scheme | Required |
-| --------- | ----------------------------------------------------------- | ---------------------------------------------------- | -------- |
-| `maxAge` | MaxAge the latest object should be younger than defined age | [*Duration*](#duration) | |
-| `maxSize` | MaxSize of the files inside the searchPath | [Size](#size) | |
-| `minAge` | MinAge the latest object should be older than defined age | [*Duration*](#duration) | |
-| `minSize` | MinSize of the files inside the searchPath | [Size](#size) | |
-| `regex` | Filter files based on regular expression | *[regex](https://github.com/google/re2/wiki/Syntax)* | |
-
-e.g. to verify that database backups are being performed
-
-```yaml title="postgres-backup-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: folder-check
-spec:
- interval: 30
- folder:
- - path: /data/backups
- filter:
- regex: "pg-backups-.*.zip"
- maxAge: 1d # require a daily backup
- minSize: 10mb # the backup should be at least 10mb
-```
-
-
-
-## Result Variables
-
-The following fields are available in `test`, `display` and `transform` scripts.
-
-| Field | Scheme |
-| --------------------- | -------------------------------------------------- |
-| `Oldest` | [os.FileInfo](https://pkg.go.dev/io/fs#FileInfo) |
-| `Newest` | [os.FileInfo](https://pkg.go.dev/io/fs#FileInfo) |
-| `MinSize` | [os.FileInfo](https://pkg.go.dev/io/fs#FileInfo) |
-| `MaxSize` | [os.FileInfo](https://pkg.go.dev/io/fs#FileInfo) |
-| `SupportsTotalSize` (Only true for SMB folders) | bool |
-| `SupportsAvailableSize` (Only true for SMB folders) | bool |
-| `TotalSize` | int64 |
-| `AvailableSize` | int64 |
-| `Files` | [[]os.FileInfo](https://pkg.go.dev/io/fs#FileInfo) |
-
-### FolderFilter
-
-| Field | Description | Scheme | Required |
-| --------- | ----------- | ----------------------- | -------- |
-| `minAge` | | [`Duration`](#duration) | |
-| `maxAge` | | [`Duration`](#duration) | |
-| `minSize` | | [`Size`](#size) | |
-| `maxSize` | | [`Size`](#size) | |
-| `regex` | | `string` | |
diff --git a/docs/canary-checker/reference/gcs-bucket.md b/docs/canary-checker/reference/gcs-bucket.md
deleted file mode 100644
index 982410ae..00000000
--- a/docs/canary-checker/reference/gcs-bucket.md
+++ /dev/null
@@ -1,72 +0,0 @@
-# 
GCSBucket
-
-Checks the contents of a GCP bucket for size, age and count.
-
-See [Folder](../folder) for a full description.
-
-```yaml title="gcs-folder-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: gcs-bucket-check
-spec:
- interval: 30
- spec:
- folder:
- - name: gcs auth test
- path: gcs://somegcsbucket
- minCount: 5
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`name`** | Name of the check | *string* | Yes |
-| **`path`** | A path to a GCS bucket and folder e.g. `gcs://bucket/folder` | string | Yes |
-| `gcpConnection` | Connection details for GCP | [GCPConnection](#gcp-connection) | |
-| `*` | All other fields available in the folder check | [*Folder*](../folder) | |
-| `*` | All other common fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of an existing connection e.g. `connection://aws/instance`/. Mutually exclusive with `credentials` | [Connection](../../concepts/connections) | |
-| `credentials` | GCP Access Token File. Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-
-### Connecting to GCP
-
-There are 3 options when connecting to GCP:
-
-1. GKE [workload identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) (the default if no `connection` or `credentials` is specified)
-2. `connection`, this is the recommended method, connections are reusable and secure
-
-```yaml title="aws-connection.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: database-backup-check
-spec:
- interval: 60
- folder:
- - name: gcs auth test
- path: gcs://somegcsbucket
- gcpConnection:
- connection: connection://gcp/internal
-```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
-```yaml title="aws.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: database-backup-check
-spec:
- interval: 60
- folder:
- - name: gcs auth test
- path: gcs://somegcsbucket
- gcpConnection:
- credentials:
- valueFrom:
- secretKeyRef:
- name: gcp-credentials
- key: AUTH_ACCESS_TOKEN
-
-```
diff --git a/docs/canary-checker/reference/gcs-database-backup.md b/docs/canary-checker/reference/gcs-database-backup.md
deleted file mode 100644
index c4baa95c..00000000
--- a/docs/canary-checker/reference/gcs-database-backup.md
+++ /dev/null
@@ -1,82 +0,0 @@
-# 
GCP CloudSQL Backups
-
-Checks if a GCP CloudSQL instance has been successfully backed up recently.
-
-```yaml title="gcp-database.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: database-backup-check
-spec:
- interval: 60
- databaseBackup:
- - maxAge: 6h
- gcp:
- project: google-project-name
- instance: cloudsql-instance-name
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`gcp`** | Connect to GCP project and instance | [*GCPDatabase*](#gcpdatabase) | Yes |
-| **`maxAge`** | Max age for backup allowed, eg. 5h30m | *Duration* | |
-| `*` | All other common fields | [*Common*](../common) | |
-| | | | |
-
-## Duration
-
-Durations are strings with an optional fraction and unit e.g. `300ms`, `1.5h` or `2h45m`. Valid time units are `ms`, `s`, `m`, `h`.
-
-## GCPDatabase
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `project` | GCP project name | *string* | Yes |
-| `instance` | Google CloudSQL instance name | *string* | Yes |
-| **Connection** | | | |
-| `connection` | Path of an existing connection e.g. `connection://aws/instance`/. Mutually exclusive with `credentials` | [Connection](../../concepts/connections) | |
-| `credentials` | GCP Access Token File. Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-
-### Connecting to GCP
-
-There are 3 options when connecting to GCP:
-
-1. GKE [workload identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) (the default if no `connection` or `credentials` is specified)
-2. `connection`, this is the recommended method, connections are reusable and secure
-
-```yaml title="aws-connection.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: database-backup-check
-spec:
- interval: 60
- databaseBackup:
- - maxAge: 6h
- gcp:
- project: google-project-name
- instance: cloudsql-instance-name
- connection: connection://gcp/internal
-```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
-```yaml title="aws.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: database-backup-check
-spec:
- interval: 60
- databaseBackup:
- - name: gcp db check
- maxAge: 6h
- gcp:
- project: google-project-name
- credentials:
- valueFrom:
- secretKeyRef:
- name: gcp-credentials
- key: AUTH_ACCESS_TOKEN
-
-```
diff --git a/docs/canary-checker/reference/git.md b/docs/canary-checker/reference/git.md
deleted file mode 100644
index 4327399b..00000000
--- a/docs/canary-checker/reference/git.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# 
Git
-
-Execute as SQL style query against a github repo using [mergestat-lite](https://github.com/mergestat/mergestat-lite).
-
-```
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: github-check
-spec:
- schedule: "@every 1m"
- github:
- - githubToken: See [mergestat-lite](https://github.com/mergestat/mergestat-lite).for more details regarding syntax. | `string` | | -| `*` | All other common fields | [*Common*](../common) | | -| **Connection** | | | | -| `connection` | Path of an existing connection e.g. `connection://github/org`. Mutually exclusive with `credentials` | [Connection](../../concepts/connections) | | -| `githubToken` | Github access token. Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes | diff --git a/docs/canary-checker/reference/helm.md b/docs/canary-checker/reference/helm.md deleted file mode 100644 index ba950ba0..00000000 --- a/docs/canary-checker/reference/helm.md +++ /dev/null @@ -1,48 +0,0 @@ -#
Helm
-
-Builds and pushes your helm chart to a helm repository.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: helm-check
-spec:
- interval: 30
- helm:
- - chartmuseum: http://chartmuseum.default:8080
- project: library
- auth:
- username:
- valueFrom:
- secretKeyRef:
- name: helm-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: helm-credentials
- key: PASSWORD
-
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `auth` | Username and password value, configMapKeyRef or SecretKeyRef for Helm repository | [Authentication](../concepts/authentication.md) | |
-| `cafile` | Verify certificates of HTTPS-enabled servers in case of self-signed certificates | *string* | |
-| **`chartmuseum`** | Chartmuseum URL | *string* | Yes |
-| `description` | Description for the check | *string* | |
-| `icon` | Icon for overwriting default icon on the dashboard | *string* | |
-| `name` | Name of the check | *string* | |
-| `project` | Specify Helm project | *string* | |
-
----
-
-# Scheme Reference
-
-## Authentication
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`password`** | Set password for authentication using string, configMapKeyRef, or SecretKeyRef. | [*kommons.EnvVar*](https://pkg.go.dev/github.com/flanksource/kommons#EnvVar) | Yes |
-| **`username`** | Set username for authentication using string, configMapKeyRef, or SecretKeyRef. | [*kommons.EnvVar*](https://pkg.go.dev/github.com/flanksource/kommons#EnvVar) | Yes |
diff --git a/docs/canary-checker/reference/http.md b/docs/canary-checker/reference/http.md
deleted file mode 100644
index 50088232..00000000
--- a/docs/canary-checker/reference/http.md
+++ /dev/null
@@ -1,87 +0,0 @@
-# HTTP
-
-This check performs queries on HTTP endpoints, and HTTP Namespaces to monitor their activity.
-
-
-
-```yaml title=http-check.yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: http-check
-spec:
- interval: 30
- http:
- - name: http pass response 200 status code
- endpoint: https://httpbin.demo.aws.flanksource.com/status/200
- thresholdMillis: 3000
- responseCodes: [201, 200, 301]
- maxSSLExpiry: 7
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`url`** | | *string* | Yes |
-| `endpoint` | Deprecated, Use `url` instread | *string* | |
-| `method` | HTTP Request method, default to `GET` | *string* | |
-| `headers` | Header fields to be used in the query | [[]*EnvVar*](../../concepts/authentication/#envvar) | |
-| `body` | Request Body Contents | *string* | |
-| `templateBody` | If true the `body` field will be templated using go templates these [variables](#templateVariables) will be available | boo; | |
-| `responseCodes` | Expected response codes for the HTTP Request. | *[]int* | |
-| `responseContent` | Exact response content expected to be returned by the endpoint. | *string* | |
-| `thresholdMillis` | Maximum duration in milliseconds for the HTTP request. It will fail the check if it takes longer. | *int* | |
-| `maxSSLExpiry` | Maximum number of days until the SSL Certificate expires. | *int* | |
-| `*` | All other common fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://sftp/instance`/ Mutually exclusive with `username`, `password` | [Connection](../../concepts/connections) | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| **`url`** | HTTP URL, if a URL is specified on both the connection and check, the url on the check takes precedence. | *string* | Yes |
-| `ntlm` | When true will do authentication using NTLM v1 protocol | *bool* | |
-| `ntlmv2` | When true will do authentication using NTLM v2 protocol | *bool* | |
-
-### Result Variables
-
-Result variables can be used in `test`, `display` and `transform` [scripts](../concepts/scripting)
-
-| Name | Description | Scheme |
-| --------- | ------------------------------------------------------------ | ------------------- |
-| `code` | HTTP response code | *int* |
-| `headers` | HTTP response headers | *map[string]string* |
-| `elapsed` | HTTP Request duration | *time.Duration* |
-| `sslAge` | Time until SSL certificate expires | *time.Duration* |
-| `content` | HTTP Response body | string |
-| `json` | If `Content-Type=application/json response body converted into JSON object | `JSON` |
-
-The above canary (`http-check.yaml`) is functionally equivalent to `http-check-expr.yaml` below
-
-```yaml title=http-check-expr.yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: http-check-expr
-spec:
- interval: 30
- http:
- - name: http pass response 200 status code
- endpoint: https://httpbin.demo.aws.flanksource.com/status/200
- test:
- expr: "code in [200,201,301] and sslAge > Duration('7d')"
-```
-
-### Template Body Variables
-
-| Name | Scheme |
-| ----- | ------ |
-| `metadata.name` | string |
-| `metadata.metadata.namespace` | *string* |
-| `metadata.labels` | *map[string]string* |
-
-## Metrics
-
-| **HTTP Check Metrics** | | |
-| ------------------------------------------------------------ | ------- | --------------------------------------- |
-| `canary_check_http_response_status{status, statusClass, url}` | Counter | Response code counter for each endpoint |
-| `canary_check_http_ssl_expiry{url}` | Guage | |
-
-Status class is one of `1xx`, `2xx`, `3xx`, `4xx`, `5xx`
diff --git a/docs/canary-checker/reference/icmp.md b/docs/canary-checker/reference/icmp.md
deleted file mode 100644
index 6fde2d81..00000000
--- a/docs/canary-checker/reference/icmp.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# ICMP
-
-Performs ICMP (ping) requests for information on ICMP packet loss, duration and response.
-
-!!! danger "Root Privileges Required"
- ICMP requires either root privileges or the following setting applied:
- ```
- sudo sysctl -w net.ipv4.ping_group_range="0 2147483647"
- ```
-
-```yaml title="imcp-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: icmp-check
-spec:
- interval: 30
- icmp:
- - endpoint: api.github.com
- thresholdMillis: 600
- packetLossThreshold: 10
- packetCount: 2
-
-```
-
-| Field | Description | Scheme | Required |
-| --------------------- | ---------------------------------------------------------- | --------------------- | -------- |
-| **`endpoint`** | Host to ping | _string_ | Yes |
-| `packetCount` | Total number of packets to send per check, defaults to `5` | _int_ | |
-| `packetLossThreshold` | Percent of total packets that are allowed to be lost | _int64_ | |
-| `thresholdMillis` | Expected response time threshold in ms | _int64_ | |
-| `*` | All other common fields | [_Common_](../common) | |
diff --git a/docs/canary-checker/reference/jmeter.md b/docs/canary-checker/reference/jmeter.md
deleted file mode 100644
index 727f1e48..00000000
--- a/docs/canary-checker/reference/jmeter.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# JMeter
-
-This check will execute the JMeter CLI to execute the JMX test plan on the specified host.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: jmeter-check
-spec:
- interval: 30
- jmeter:
- - name: jmeter check
- host: 192.168.1.5
- jmx:
- valueFrom:
- configMapKeyRef:
- name: jmeter-config
- key: sample-test.jmx
- port: 1099
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`jmx`** | Jmx defines the ConfigMap or Secret reference to get the JMX test plan | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `properties` | Properties defines the local JMeter properties | *\[\]string* | |
-| `responseDuration` | duration under which the all the test should pass | *int* | |
-| `systemProperties` | SystemProperties defines the Java system property | *\[\]string* | |
-| `host` | Host is the server against which test plan needs to be executed | *string* | |
-| `port` | Port on which the server is running | *int32* | |
-| `*` | All other common fields | [*Common*](../common) | |
diff --git a/docs/canary-checker/reference/junit.md b/docs/canary-checker/reference/junit.md
deleted file mode 100644
index 7806cacb..00000000
--- a/docs/canary-checker/reference/junit.md
+++ /dev/null
@@ -1,78 +0,0 @@
-# JUnit
-
-JUnit check performs a Unit test, parses the JUnit test reports in a container at a specified path as defined in `testResults`.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: junit-check
- annotations:
- trace: "true"
-spec:
- interval: 120
- owner: DBAdmin
- severity: high
- spec:
- junit:
- - testResults: "/tmp/junit-results/"
- display:
- template: |
- ✅ {{.results.passed}} ❌ {{.results.failed}} in 🕑 {{.results.duration}}
- {{ range $r := .results.suites}}
- {{- if gt (conv.ToInt $r.failed) 0 }}
- {{$r.name}} ✅ {{$r.passed}} ❌ {{$r.failed}} in 🕑 {{$r.duration}}
- {{- end }}
- {{- end }}
- spec:
- containers:
- - name: jes
- image: docker.io/tarun18/junit-test-pass
- command: ["/start.sh"]
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`spec`** | Pod specification | [*v1.PodSpec*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#podspec-v1-core) | Yes |
-| **`testResults`** | Directory where the results will be published | *string* | Yes |
-| `timeout` | Timeout in minutes to wait for specified container to finish its job. Defaults to 5 minutes | *int* | |
-| `*` | All other common fields | [*Common*](../common) | |
-
-
-
-## Test Result Variables
-
-| Name | Description | Scehme |
-| ---------- | --------------------- | ---------------- |
-| `suites` | | [`[]JunitSuite`](#junit-suite) |
-| `passed` | Number of passing tests | *int* |
-| `failed` | Number of failed tests | *int* |
-| `skipped` | NUmber of tests that were skipped | *int* |
-| `error` | Number of errors produced when running the tests | *int* |
-| `duration` | Total time in seconds | *float64* |
-
-### Junit Suite
-
-| Name | Description | Scheme |
-| ---------- | --------------------- | ---------------- |
-| `name` | | *string* |
-| `tests` | | [`[]JunitTest`](#junit-test) |
-| `passed` | Number of passing tests | *int* |
-| `failed` | Number of failed tests | *int* |
-| `skipped` | NUmber of tests that were skipped | *int* |
-| `error` | Number of errors produced when running the tests | *int* |
-| `duration` | Total time in seconds | *float64* |
-
-### Junit Test
-
-| Name | Description | Scheme |
-| ------------ | ------------------------------------------------------- | ------------------- |
-| `name` | | *string* |
-| `classname` | an additional descriptor for the hierarchy of the test. | *string* |
-| `duration` | Time in seconds | *float64* |
-| `status` | One of `passed`, `skipped`, `failed` or `error` | *string* |
-| `message` | Description optionally included with a skipped, | *string* |
-| `properties` | Additional info about the test | `map[string]string` |
-| `error` | Any errors encountered when running atest | *string* |
-| `stdout` | Standard output produced during test | *string* |
-| `stderr` | Standard error output produced during test | *string* |
diff --git a/docs/canary-checker/reference/kubernetes.md b/docs/canary-checker/reference/kubernetes.md
deleted file mode 100644
index ba977bbc..00000000
--- a/docs/canary-checker/reference/kubernetes.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Kubernetes
-
-The Kubernetes check performs requests on Kubernetes resources such as Pods to get the desired information.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: kube-check
-spec:
- interval: 30
- spec:
- kubernetes:
- - namespace:
- name: default
- name: k8s-ready pods
- kind: Pod
- resource:
- labelSelector: app=k8s-ready
- - namespace:
- name: default
- kind: Pod
- name: k8s-not-ready pods
- ready: false
- resource:
- labelSelector: app=k8s-not-ready
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`kind`** | Specifies the kind of Kubernetes object for interaction | *string* | Yes |
-| `resource` | Queries resources related to specified Kubernetes object | [*ResourceSelector*](#resourceselector) | |
-| `namespace` | Specifies namespace for Kubernetes object | [*ResourceSelector*](#resourceselector) | |
-| `ignore` | Ignore the specified resources from the fetched resources. Can be a glob pattern. | *\[\]string* | |
-| `ready` | Boolean value of true or false to query and display resources based on availability | *bool* | |
-| `*` | All other common fields | [*Common*](../common) | |
-
-## ResourceSelector
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `name` | Name of Kubernetes resource | *string* | |
-| `labelSelector` | Select Kubernetes resource based on label. e.g. app, canary. | *string* |
-| `fieldSelector` | Select Kubernetes resource based on the value of specified resource field | *string* |
diff --git a/docs/canary-checker/reference/ldap.md b/docs/canary-checker/reference/ldap.md
deleted file mode 100644
index 0297b0ca..00000000
--- a/docs/canary-checker/reference/ldap.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# LDAP
-
-The LDAP check:
-
-* Binds using the provided username and password to the LDAP host. It supports LDAP/LDAPS protocols.
-* Searches an object type in the provided `bindDN`.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: ldap-check
-spec:
- interval: 30
- ldap:
- - name: ldap-org
- host: ldap://apacheds.ldap.svc:10389
- username:
- # value: uid=admin,ou=system
- valueFrom:
- secretKeyRef:
- name: ldap-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: ldap-credentials
- key: PASSWORD
- bindDN: ou=users,dc=example,dc=com
- userSearch: "(&(objectClass=organizationalPerson))"
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`name`** | Name of the check | *string* | Yes |
-| **`bindDN`** | BindDN to use in query | *string* | Yes |
-| **`userSearch`** | UserSearch to use in query | *string* | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://alertmanager/instance`/ Mutually exclusive with `username`, `password`, `host` | [Connection](../../concepts/connections) | |
-| `host` | Host endpoint mutually exclusive with `connection` | `string` | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `skipTLSVerify` | Skip check of LDAP server TLS certificates | *bool* | |
diff --git a/docs/canary-checker/reference/mongo.md b/docs/canary-checker/reference/mongo.md
deleted file mode 100644
index 8df5ed4d..00000000
--- a/docs/canary-checker/reference/mongo.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# MongoDB
-
-The Mongo check tries to connect to a specified Mongo Database to ensure connectivity.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: mongo-check
-spec:
- interval: 30
- mongodb:
- - name: mongo password
- url: mongodb://$(username):$(password)@mongo.default.svc:27017/?authSource=admin
- username:
- valueFrom:
- secretKeyRef:
- name: mongo-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: mongo-credentials
- key: PASSWORD
-
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `connection` | Path of existing connection e.g. `connection://mongo/instance` or connection url | [Connection](../../concepts/connections) | |
-| url | mongodb://:27017/?authSource=admin, See [connection-string](https://docs.mongodb.com/manual/reference/connection-string/) | | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `*` | All other common fields | [*Common*](../common) | |
diff --git a/docs/canary-checker/reference/mssql.md b/docs/canary-checker/reference/mssql.md
deleted file mode 100644
index 41c20f7a..00000000
--- a/docs/canary-checker/reference/mssql.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# MSSQL
-
-This check will try to connect to a specified SQL Server database, run a query against it and verify the results.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: mssql-check
-spec:
- interval: 30
- mssql:
- - name: mssql pass
- url: "server=mssql.default.svc;user id=$(username);password=$(password);port=1433;database=master"
- username:
- valueFrom:
- secretKeyRef:
- name: mssql-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: mssql-credentials
- key: PASSWORD
- query: SELECT 1
- results: 1
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`url`** | Connection string to connect to the SQL Server server | *string* | Yes |
-| **`query`** | query that needs to be executed on the server | *string* | Yes |
-| **`results`** | Number rows to check for | *int* | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://mssql/instance`/ Mutually exclusive with `username`, `password` | [Connection](../../concepts/connections) | |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | |
-| `url` | If the url is specifed in both the `connection` and in the `url` field, the field takes precedence | | |
diff --git a/docs/canary-checker/reference/mysql.md b/docs/canary-checker/reference/mysql.md
deleted file mode 100644
index d2c8b242..00000000
--- a/docs/canary-checker/reference/mysql.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# MySQL
-
-This check will try to connect to a specified MySQL database, run a query against it and verify the results.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: mysql-check
-spec:
- interval: 30
- mysql:
- - url: "$(username):$(password)@tcp(mysql.default.svc:3306)/mysqldb"
- name: mysql ping check
- username:
- valueFrom:
- secretKeyRef:
- name: mysql-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: mysql-credentials
- key: PASSWORD
- query: Namespace
-
-The Namespace check:
-
-* Creates a new namespace using the labels/annotations provided
-* Create a new pod in the namespace using the provided PodSpec
-* Expose the pod using the provided ingress URL
-* Test an HTTP connection to the pod.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: namespace-check
-spec:
- interval: 30
- namespace:
- - name: namespace check
- namespaceNamePrefix: "test-foo-"
- podSpec: |
- apiVersion: v1
- kind: Pod
- metadata:
- name: test-namespace
- namespace: default
- labels:
- app: hello-world-golang
- spec:
- containers:
- - name: hello
- image: quay.io/toni0/hello-webserver-golang:latest
- port: 8080
- path: /foo/bar
- ingressName: test-namespace-pod
- ingressHost: "test-namespace-pod.127.0.0.1.nip.io"
- readyTimeout: 5000
- httpTimeout: 15000
- deleteTimeout: 12000
- ingressTimeout: 20000
- deadline: 29000
- httpRetryInterval: 200
- expectedContent: bar
- expectedHttpStatuses: [200, 201, 202]
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`checkName`** | Name for the check | *string* | Yes |
-| `deadline` | Overall time before which an HTTP connection to the pod must be established | *int64* | |
-| `deleteTimeout` | | *int64* | |
-| `description` | Description for the check | *string* | |
-| `expectedContent` | Expected content of an HTTP response from the created pod | *string* | |
-| `expectedHttpStatuses` | Expected HTTP status code of the response from the created pod | *\[\]int64* | |
-| `httpRetryInterval` | Interval in ms to retry HTTP connections to the created pod | *int64* | |
-| `httpTimeout` | | int64 | |
-| `icon` | Icon for overwriting default icon on the dashboard | *string* | |
-| `ingressHost` | URL to be used by the ingress to expose the created pod | *string* | |
-| `ingressName` | Name to use for the ingress object that will expose the created pod | *string* | |
-| `ingressTimeout` | Maximum time to wait for an HTTP connection to the created pod | *int64* | |
-| `name` | Name of the check | string | |
-| `namespaceAnnotations` | Metadata annotations to apply to created namespace | *map[string]string* | |
-| `namespaceLabels` | Metadata labels to apply to created namespace | *map[string]string* | |
-| `namespaceNamePrefix` | Prefix string to identity namespace | *string* | |
-| `path` | Path on which the created pod will respond to requests | *string* | |
-| **`podSpec`** | Spec of pod to be created in check namespace | *string* | Yes |
-|`port` | Port on which the created pod will serve traffic | *int64* | |
-| `priorityClass` | Pod priority class | *string* | |
-| `readyTimeout` | Specify readiness timeout for namespace | *int64* | |
-| `scheduleTimeout` | Maximum time between pod created and pod running | *int64* | |
diff --git a/docs/canary-checker/reference/pod.md b/docs/canary-checker/reference/pod.md
deleted file mode 100644
index b1d9794a..00000000
--- a/docs/canary-checker/reference/pod.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# Pod
-
-The Pod check creates a new pod and verifies its reachability.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: pod-check
-spec:
- interval: 30
- pod:
- - name: golang
- spec: |
- apiVersion: v1
- kind: Pod
- metadata:
- name: hello-world-golang
- namespace: default
- labels:
- app: hello-world-golang
- spec:
- containers:
- - name: hello
- image: quay.io/toni0/hello-webserver-golang:latest
- port: 8080
- path: /foo/bar
- scheduleTimeout: 20000
- readyTimeout: 10000
- httpTimeout: 7000
- deleteTimeout: 12000
- ingressTimeout: 10000
- deadline: 60000
- httpRetryInterval: 200
- expectedContent: bar
- expectedHttpStatuses: [200, 201, 202]
- priorityClass: canary-checker-priority
-
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`namespace`** | Namespace to create the pod in | *string* | Yes |
-| **`spec`** | [*Spec*](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#podspec-v1-core) of pod to be created | string | Yes |
-| `scheduleTimeout` | Maximum time between pod created and pod running | *int64* | |
-| `readyTimeout` | | *int64* | |
-| `httpTimeout` | Maximum time to wait for an HTTP connection to the created pod | *int64* | |
-| `deleteTimeout` | Specify timeout for pod deletion | *int64* | |
-| `ingressTimeout` | Maximum time to create an ingress connected to the pod | *int64* | |
-| `httpRetryInterval` | Interval in ms to retry HTTP connections to the created pod | *int64* | |
-| `deadline` | Overall time before which an HTTP connection to the pod must be established | *int64* | |
-| `port` | Port on which the created pod will serve traffic | *int64* | |
-| `path` | Path on which the created pod will respond to requests | *string* | |
-| **`ingressName`** | Name to use for the ingress object that will expose the created pod | *string* | Yes |
-| **`ingressHost`** | URL to be used by the ingress to expose the created pod | *string* | |
-| `expectedContent` | Expected content of an HTTP response from the created pod | *string* | |
-| `expectedHttpStatuses` | Expected HTTP status code of the response from the created pod | *\[\]int64* | |
-| `priorityClass` | Pod priority class | *string* | |
-| `*` | All other common fields | [*Common*](../common) | |
-
-## Metrics
-
-| **Metric** | | |
-| ---------------------------------------------- | --------- | ------------------------------------------- |
-| canary_check_histogram{metric="creation_time"} | Histogram | Time for pod to be `Pending` |
-| canary_check_histogram{metric="delete_time"} | Histogram | Time to delete pod |
-| canary_check_histogram{metric="ingress_time"} | Histogram | Time until ingress is returning requests |
-| canary_check_histogram{metric="request_time"} | Histogram | Duration of http request once ingress is up |
-| canary_check_histogram{metric="schedule_time"} | Histogram | Time for pod to be `Running` |
diff --git a/docs/canary-checker/reference/postgres.md b/docs/canary-checker/reference/postgres.md
deleted file mode 100644
index 52ae3b2f..00000000
--- a/docs/canary-checker/reference/postgres.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Postgres
-
-This check will try to connect to a specified Postgres database, run a query against it and verify the results.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: postgres-check
-spec:
- interval: 30
- postgres:
- - name: postgres schemas check
- url: "postgres://$(username):$(password)@postgres.default.svc:5432/postgres?sslmode=disable"
- username:
- valueFrom:
- secretKeyRef:
- name: postgres-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: postgres-credentials
- key: PASSWORD
- query: SELECT current_schemas(true)
- display:
- template: |
- {{- range $r := .results.rows }}
- {{- $r.current_schemas}}
- {{- end}}
- results: 1
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `auth` | username and password value, configMapKeyRef or SecretKeyRef for Postgres server | [*Authentication*](../concepts/authentication.md) | |
-| **`connection`** | connection string to connect to the server | *string* | Yes |
-| **`query`** | query that needs to be executed on the server | *string* | Yes |
-| **`results`** | Number rows to check for | *int* | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-
-## Result Variables
-
-| Name | Description | Scheme |
-| ------- | ----------------------- | -------------------------- |
-| `rows` | | *[]map[string]interface{}* |
-| `count` | Number of rows returned | *int* |
diff --git a/docs/canary-checker/reference/prometheus.md b/docs/canary-checker/reference/prometheus.md
deleted file mode 100644
index 10de8a11..00000000
--- a/docs/canary-checker/reference/prometheus.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# Prometheus
-
-The Prometheus Check connects to the Prometheus host, performs the desired query, and displays the results.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: prometheus-check
-spec:
- interval: 30
- prometheus:
- - host: http://prometheus-k8s.monitoring.svc:9090
- query: kubernetes_build_info{job!~"kube-dns|coredns"}
- display:
- template: "{{ (index .results 0).git_version }}"
- test:
- template: "true"
-
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`host`** | Address of the Prometheus server | string | Yes |
-| **`query`** | PromQL query | string | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-
-## Result Variables
-
-| Name | Description | Scheme |
-| ------------ | ----------------------- | -------------------------- |
-| `value` | | *float* |
-| `firstValue` | Number of rows returned | *int* |
-| `results` | A list of results | *[]map[string]interface{}* |
diff --git a/docs/canary-checker/reference/redis.md b/docs/canary-checker/reference/redis.md
deleted file mode 100644
index 3afce651..00000000
--- a/docs/canary-checker/reference/redis.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# Redis
-
-The Redis check connects to a specified Redis database instance to check its availability.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: redis-check
-spec:
- interval: 30
- redis:
- - name: redis-check
- addr: "redis.default.svc:6379"
- db: 0
- username:
- valueFrom:
- secretKeyRef:
- name: redis-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: redis-credentials
- key: PASSWORD
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`addr`** | `host:port` address of redis | string | Yes |
-| **`db`** | Database to be selected after connecting to the server | *int* | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-
-## Redis Connection
-
-| Field | Description | Scheme |
-| ------------ | ------------------------------------------------------------ | ------------------------------------------------- |
-| `connection` | Path of existing connection e.g. `connection://redis/instance`/ Mutually exclusive with `accessKey` | [Connection](../../concepts/connections) |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
diff --git a/docs/canary-checker/reference/restic.md b/docs/canary-checker/reference/restic.md
deleted file mode 100644
index d1960fb5..00000000
--- a/docs/canary-checker/reference/restic.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# Restic
-
-The Restic check:
-
-* Queries a Restic Repository for content
-* Checks the integrity and consistency of the repository and data-blobs
-* Checks for backup freshness.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: restic-check
-spec:
- interval: 30
- restic:
- - repository: s3:http://minio.minio:9000/restic-canary-checker
- name: restic check
- password:
- valueFrom:
- secretKeyRef:
- name: restic-credentials
- key: PASSWORD
- maxAge: 1h
- accessKey:
- valueFrom:
- secretKeyRef:
- name: restic-credentials
- key: ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: restic-credentials
- key: SECRET_ACCESS_KEY
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`maxAge`** | MaxAge for backup freshness | string | Yes |
-| **`repository`** | The restic repository path eg: rest: S3
-
-Checks the contents of a S3 bucket for size, age and count.
-
-See [Folder](../folder) for a full description.
-
-!!! note
-
- This check looks at the contents of an S3 bucket, to verify that an S3 compatible
- object storage endpoint is functioning correctly use [S3 Protocol](../s3-protocol)
-
-```yaml title="folder-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: folder-check
-spec:
- interval: 30
- folder:
- - path: s3://some-bucket/folder
- name: folder-check-min
- description: Checks if there are at least 10 files in the folder
- minCount: 10
-```
-
-| Field | Description | Scheme | Required |
-| ---------- | ---------------------------------------------------------- | --------------------- | -------- |
-| **`name`** | Name of the check | *string* | Yes |
-| **`path`** | A path to a S3 bucket and folder e.g. `s3://bucket/folder` | string | Yes |
-| `awsConnection` | AWS Access credentials | [AWSConnection](#aws-connection) | |
-| `*` | All other fields available in the folder check | [*Folder*](../folder) | |
-
-### Connecting to AWS
-
-There are 3 options when connecting to AWS:
-
-1. An AWS [instance profile](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) or [pod identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-configuration.html) (the default if no `connection` or `accessKey` is specified)
-2. `connection`, this is the recommended method, connections are reusable and secure
-
- ```yaml title="aws-connection.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: aws-config-rule
- spec:
- interval: 30
- folder:
- - path: s3://some-bucket/folder
- awsConnection:
- connection: connection://aws/s3
- name: folder-check-min
- minCount: 10
- description: Checks if there are at least 10 files in the folder
-
- ```
-
-3. `accessKey` and `secretKey` [*EnvVar*](../../concepts/authentication/#envvar) with the credentials stored in a secret.
-
- ```yaml title="aws.yaml"
- apiVersion: canaries.flanksource.com/v1
- kind: Canary
- metadata:
- name: s3-bucket
- spec:
- interval: 30
- folder:
- - path: s3://some-bucket/folder
- name: folder-check-min
- minCount: 10
- description: Checks if there are at least 10 files in the folder
- awsConnection:
- accessKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_ACCESS_KEY_ID
- secretKey:
- valueFrom:
- secretKeyRef:
- name: aws-credentials
- key: AWS_SECRET_ACCESS_KEY
- region: us-east-1AWS connection fields
-| Field | Description | Scheme | Required |
-| --------------- | ------------------------------------------------------------ | ------------------------------------------------- | -------- |
-| `connection` | Path of existing connection e.g. `connection://aws/instance`. Mutually exclusive with `accessKey` and `secretKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `endpoint` | Custom AWS endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to aws | *bool* | |
\ No newline at end of file
diff --git a/docs/canary-checker/reference/s3-protocol.md b/docs/canary-checker/reference/s3-protocol.md
deleted file mode 100644
index 0a033f5b..00000000
--- a/docs/canary-checker/reference/s3-protocol.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# S3 Protocol
-
-!!! note
-
- This check if S3 compatible endpoints are functioning correctly, to check the contents of
- a S3 bucket use (S3)(../s3-bucket)
-
-The S3 check:
-
-* Lists objects in the bucket to check for Read permissions
-* Puts an object into the bucket for Write permissions
-* Downloads previously uploaded object to check for Get permissions
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: s3-protocol-check
-spec:
- interval: 30
- s3:
- - name: s3-check
- bucketName: flanksource-public
- objectPath: dummy
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`bucket`** | Bucket name to test against | [*Bucket*](#bucket) | Yes |
-| **`objectPath`** | Path to create a test object e.g. `s3-dummy/` | *string* | Yes |
-| `*` | All other common fields | [*Common*](../common) | |
-| **Connection** | | | |
-| `connection` | Path of existing connection e.g. `connection://aws/instance`. Mutually exclusive with `accessKey` and `secretKey` | [Connection](../concepts/connections) | |
-| `accessKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `secretKey` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) | Yes |
-| `endpoint` | Custom AWS endpoint | *string* | |
-| `region` | AWS region | *string* | |
-| `skipTLSVerify` | Skip TLS verify when connecting to aws | *bool* | |
diff --git a/docs/canary-checker/reference/sftp.md b/docs/canary-checker/reference/sftp.md
deleted file mode 100644
index e2c4de58..00000000
--- a/docs/canary-checker/reference/sftp.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# SFTPConnection
-
-Checks the contents of a folder over SFTP for size, age and count.
-
-See [Folder](../folder) for a full description.
-
-```yaml title="sftp-folder-check.yaml"
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: sftp-check
-spec:
- interval: 30
- folder:
- - path: /tmp
- name: sample sftp check
- sftpConnection:
- host: 192.168.1.5
- auth:
- username:
- valueFrom:
- secretKeyRef:
- name: sftp-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: sftp-credentials
- key: PASSWORD
- maxCount: 10
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`name`** | Name of the check | *string* | Yes |
-| **`path`** | A path to the remote folder | string | Yes |
-| **`sftpConnection`** | SFTP connection details | [SFTPConnection](#sftp-connection) | Yes |
-| `*` | All other fields available in the folder check | [*Folder*](../folder) | |
-
-## SFTP Connection
-
-| Field | Description | Scheme |
-| ------------ | ------------------------------------------------------------ | ------------------------------------------------- |
-| `connection` | Path of existing connection e.g. `connection://sftp/instance`/ Mutually exclusive with `accessKey` | [Connection](../../concepts/connections) |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
-| `host` | Custom AWS Cloudwatch endpoint | *string* |
-| `port` | Default to `22` | int |
diff --git a/docs/canary-checker/reference/smb.md b/docs/canary-checker/reference/smb.md
deleted file mode 100644
index 224f6cc3..00000000
--- a/docs/canary-checker/reference/smb.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# Windows File Share (SMB/CIFS)
-
-Checks the contents of a Windows / CIFS file share for size, age and count.
-
-See [Folder](../folder) for a full description.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: smb-check
-spec:
- interval: 30
- folder:
- - path: smb://192.168.1.9/Some Public Folder/somedir
- name: sample smb check
- smbConnection:
- username:
- valueFrom:
- secretKeyRef:
- name: smb-credentials
- key: USERNAME
- password:
- valueFrom:
- secretKeyRef:
- name: smb-credentials
- key: PASSWORD
- minAge: 10h
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| **`name`** | Name of the check | *string* | Yes |
-| **`path`** | A path to a shared windows folder e.g. `smb://host/folder` | string | Yes |
-| `smbConnection` | SMB connection details | [SMBConnection](#smb-connection) | |
-| `*` | All other fields available in the folder check | [*Folder*](../folder) | |
-
-## SMB Connection
-
-| Field | Description | Scheme |
-| ------------ | ------------------------------------------------------------ | ------------------------------------------------- |
-| `connection` | Path of existing connection e.g. `connection://windows/svc-account. Mutually exclusive with `username` | [Connection](../concepts/connections) |
-| `username` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
-| `password` | Mutually exclusive with `connection` | [*EnvVar*](../../concepts/authentication/#envvar) |
-| `domain` | Windows domain name | *string* |
-| `port` | Default to `445` | *int* |
diff --git a/docs/canary-checker/reference/tcp.md b/docs/canary-checker/reference/tcp.md
deleted file mode 100644
index 26a80838..00000000
--- a/docs/canary-checker/reference/tcp.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# TCP
-
-This checks whether the given address is reachable within the specified timeout period.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: tcp-check
-spec:
- schedule: "*/1 * * * *"
- tcp:
- - name: "flanksource website"
- endpoint: www.flanksource.com:80
- thresholdMillis: 1200
-```
-
-| Field | Description | Scheme | Required |
-| ----------------- | -------------------------------------- | --------------------- | -------- |
-| **`endpoint`** | `host:port` to connect to | `string` | Yes |
-| `thresholdMillis` | Expected response time threshold in ms | `int64` | |
-| `*` | All other common fields | [*Common*](../common) | |
diff --git a/docs/canary-checker/sidebars.js b/docs/canary-checker/sidebars.js
index 3594bdf5..c2d08a2b 100644
--- a/docs/canary-checker/sidebars.js
+++ b/docs/canary-checker/sidebars.js
@@ -1,35 +1,88 @@
module.exports = {
docs: [
+ {
+ type: 'doc',
+ id: 'getting-started',
+ label: 'Getting Started'
+ },
{
type: 'category',
- label: 'Getting Started',
+ label: 'Installation',
+ link: {
+ type: 'generated-index',
+ title: 'Installation',
+ // description: 'Learn about the most important Docusaurus concepts!',
+ slug: '/installation',
+ keywords: ['guides'],
+ },
items: [
+
{
type: 'doc',
- id: 'index',
- label: 'Overview',
+ id: 'helm',
+ label: 'Helm',
},
{
type: 'doc',
- id: 'cli',
- label: 'CLI',
+ id: 'database',
+ label: 'Database',
},
{
type: 'doc',
- id: 'database',
- label: 'Database',
+ id: 'cli',
+ label: 'CLI',
},
{
type: 'doc',
- id: 'helm',
- label: 'Helm',
+ id: 'concepts/image-variants',
+ label: 'Image Variants',
},
- ],
+
+ ]
},
{
type: 'category',
label: 'Concepts',
items: [
+ {
+ type: 'doc',
+ id: 'concepts/metrics-exporter',
+ label: 'Metrics Exporter',
+ },
+ {
+ type: 'doc',
+ id: 'concepts/grafana',
+ label: 'Grafana',
+ },
+
+ {
+ type: 'category',
+ label: 'Expressions',
+ link: {
+ type: 'generated-index',
+ title: 'Expressions',
+ slug: '/concepts/expressions',
+ },
+ items: [
+ {
+ type: 'doc',
+ id: 'concepts/display-formatting',
+ label: 'Display Formatting',
+ },
+ {
+ type: 'doc',
+ id: 'concepts/health-evaluation',
+ label: 'Health Evaluation',
+ },
+
+ {
+ type: 'doc',
+ id: 'concepts/transforms',
+ label: 'Transforms',
+ },
+
+ ]
+ },
{
type: 'doc',
id: 'concepts/authentication',
@@ -37,271 +90,266 @@ module.exports = {
},
{
type: 'doc',
- id: 'concepts/metrics',
- label: 'Metrics',
+ id: 'concepts/troubleshooting',
+ label: 'Troubleshooting',
},
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Probes / Alerts',
+ link: {
+ type: 'generated-index',
+ title: 'Probes / Alerts',
+ // description: 'Learn about the most important Docusaurus concepts!',
+ slug: '/types',
+ keywords: ['guides'],
+ image: '/img/docusaurus.png',
+ },
+ items: [
{
type: 'doc',
- id: 'concepts/transforms',
- label: 'Transforms',
+ id: 'reference/http',
+ label: 'HTTP',
},
+
{
type: 'doc',
- id: 'concepts/scripting',
- label: 'Scripting',
+ id: 'reference/tcp',
+ label: 'TCP',
},
{
type: 'doc',
- id: 'concepts/connections',
- label: 'Connections',
+ id: 'reference/dns',
+ label: 'DNS',
},
+ {
+ type: 'doc',
+ id: 'reference/icmp',
+ label: 'ICMP',
+ },
+
+ {
+ type: 'doc',
+ id: 'reference/alert-manager',
+ label: 'Alert Manager',
+ },
+ {
+ type: 'doc',
+ id: 'reference/cloudwatch',
+ label: 'AWS Cloud Watch',
+ },
+ {
+ type: 'doc',
+ id: 'reference/aws-config-rule',
+ label: 'AWS Config Rule',
+ },
+
+
],
},
+
{
type: 'category',
- label: 'Check Types',
+ label: 'Folder / Backups',
items: [
- 'reference/common',
{
- type: 'category',
- label: 'Alerts',
- items: [
- {
- type: 'doc',
- id: 'reference/alert-manager',
- label: 'Alert Manager (Prometheus)',
- },
- {
- type: 'doc',
- id: 'reference/cloudwatch',
- label: 'AWS Cloud Watch',
- },
- {
- type: 'doc',
- id: 'reference/aws-config-rule',
- label: 'AWS Config Rule',
- },
- ],
+ type: 'doc',
+ id: 'reference/folder',
+ label: 'Folder',
},
{
- type: 'category',
- label: 'Backup Checks',
- items: [
- {
- type: 'doc',
- id: 'reference/gcs-database-backup',
- label: 'GCS Database Backup',
- },
- {
- type: 'doc',
- id: 'reference/restic',
- label: 'Restic',
- },
+ type: 'doc',
+ id: 'reference/gcs-bucket',
+ label: 'GCS Bucket',
+ },
+ {
+ type: 'doc',
+ id: 'reference/s3-bucket',
+ label: 'S3 Bucket',
+ },
+ {
+ type: 'doc',
+ id: 'reference/sftp',
+ label: 'SFTP',
+ },
+ {
+ type: 'doc',
+ id: 'reference/smb',
+ label: 'SMB/CIFS',
+ },
+ {
+ type: 'doc',
+ id: 'reference/gcs-database-backup',
+ label: 'GCS Database Backup',
+ },
+ {
+ type: 'doc',
+ id: 'reference/restic',
+ label: 'Restic',
+ },
- ],
+ ]
+ },
+
+ {
+ type: 'category',
+ label: 'Data / Queries',
+ items: [
+ {
+ type: 'doc',
+ id: 'reference/prometheus',
+ label: 'Prometheus',
},
+
{
- type: 'category',
- label: 'Configuration',
- items: [
- {
- type: 'doc',
- id: 'reference/aws-config',
- label: 'AWS Config',
- },
- {
- type: 'doc',
- id: 'reference/configdb',
- label: 'Config DB',
- },
- {
- type: 'doc',
- id: 'reference/kubernetes',
- label: 'Kubernetes Resources',
- },
- ],
+ type: 'doc',
+ id: 'reference/aws-config',
+ label: 'AWS Config',
},
{
- type: 'category',
- label: 'Data Sources',
- items: [
- {
- type: 'doc',
- id: 'reference/elasticsearch',
- label: 'Elasticsearch',
- },
- {
- type: 'doc',
- id: 'reference/ldap',
- label: 'LDAP',
- },
- {
- type: 'doc',
- id: 'reference/mongo',
- label: 'MongoDB',
- },
- {
- type: 'doc',
- id: 'reference/mssql',
- label: 'MSSQL',
- },
- {
- type: 'doc',
- id: 'reference/mysql',
- label: 'MySQL',
- },
- {
- type: 'doc',
- id: 'reference/postgres',
- label: 'Postgres',
- },
- {
- type: 'doc',
- id: 'reference/redis',
- label: 'Redis',
- },
- ],
+ type: 'doc',
+ id: 'reference/configdb',
+ label: 'Flanksource Config DB',
},
{
- type: 'category',
- label: 'DevOps',
- items: [
- {
- type: 'doc',
- id: 'reference/azure-devops',
- label: 'Azure DevOps',
- },
- ],
+ type: 'doc',
+ id: 'reference/kubernetes',
+ label: 'Kubernetes Resources',
},
{
- type: 'category',
- label: 'Folders',
- items: [
- {
- type: 'doc',
- id: 'reference/folder',
- label: 'Folder',
- },
- {
- type: 'doc',
- id: 'reference/gcs-bucket',
- label: 'GCS Bucket',
- },
- {
- type: 'doc',
- id: 'reference/s3-bucket',
- label: 'S3 Bucket',
- },
- {
- type: 'doc',
- id: 'reference/sftp',
- label: 'SFTP',
- },
- {
- type: 'doc',
- id: 'reference/smb',
- label: 'SMB/CIFS',
- },
- ],
+ type: 'doc',
+ id: 'reference/elasticsearch',
+ label: 'Elasticsearch',
},
{
- type: 'category',
- label: 'Integration Testing',
- items: [
- {
- type: 'doc',
- id: 'reference/jmeter',
- label: 'JMeter',
- },
- {
- type: 'doc',
- id: 'reference/junit',
- label: 'JUnit',
- },
- {
- type: 'doc',
- id: 'reference/k6',
- label: 'K6',
- },
- {
- type: 'doc',
- id: 'reference/newman',
- label: 'Newman (Postman Collection)',
- },
- {
- type: 'doc',
- id: 'reference/playwright',
- label: 'Playwright',
- },
- ],
+ type: 'doc',
+ id: 'reference/ldap',
+ label: 'LDAP',
},
{
- type: 'category',
- label: 'Metrics',
- items: [
- {
- type: 'doc',
- id: 'reference/prometheus',
- label: 'Prometheus',
- },
- ],
+ type: 'doc',
+ id: 'reference/mongo',
+ label: 'MongoDB',
},
{
- type: 'category',
- label: 'Network',
- items: [
- {
- type: 'doc',
- id: 'reference/tcp',
- label: 'TCP',
- },
- {
- type: 'doc',
- id: 'reference/dns',
- label: 'DNS',
- },
- {
- type: 'doc',
- id: 'reference/http',
- label: 'HTTP',
- },
- {
- type: 'doc',
- id: 'reference/icmp',
- label: 'ICMP',
- },
- ],
+ type: 'doc',
+ id: 'reference/mssql',
+ label: 'MSSQL',
},
{
- type: 'category',
- label: 'Infrastructure',
- items: [
- {
- type: 'doc',
- id: 'reference/containerd',
- label: 'Containerd/Docker',
- },
- {
- type: 'doc',
- id: 'reference/helm',
- label: 'Helm',
- },
- {
- type: 'doc',
- id: 'reference/ec2',
- label: 'EC2',
- },
- {
- type: 'doc',
- id: 'reference/pod',
- label: 'Pod',
- },
- {
- type: 'doc',
- id: 'reference/s3-protocol',
- label: 'S3 Protocol',
- },
- ],
+ type: 'doc',
+ id: 'reference/mysql',
+ label: 'MySQL',
+ },
+ {
+ type: 'doc',
+ id: 'reference/postgres',
+ label: 'Postgres',
+ },
+ {
+ type: 'doc',
+ id: 'reference/redis',
+ label: 'Redis',
+ },
+
+ ],
+
+ },
+
+
+ {
+ type: 'category',
+ label: 'Active / Integration',
+ items: [
+
+ {
+ type: 'doc',
+ id: 'reference/exec',
+ label: 'Exec',
+ },
+ {
+ type: 'doc',
+ id: 'reference/jmeter',
+ label: 'JMeter',
+ },
+ {
+ type: 'doc',
+ id: 'reference/junit',
+ label: 'JUnit',
+ },
+ {
+ type: 'doc',
+ id: 'reference/k6',
+ label: 'K6',
+ },
+ {
+ type: 'doc',
+ id: 'reference/newman',
+ label: 'Newman / Postman',
+ },
+ {
+ type: 'doc',
+ id: 'reference/playwright',
+ label: 'Playwright',
+ },
+ {
+ type: 'doc',
+ id: 'reference/azure-devops',
+ label: 'Azure DevOps',
+ },
+
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Infrastructure',
+ items: [
+ {
+ type: 'doc',
+ id: 'reference/containerd',
+ label: 'Containerd/Docker',
+ },
+ {
+ type: 'doc',
+ id: 'reference/helm',
+ label: 'Helm',
+ },
+ {
+ type: 'doc',
+ id: 'reference/ec2',
+ label: 'EC2',
+ },
+ {
+ type: 'doc',
+ id: 'reference/pod',
+ label: 'Pod',
+ },
+ {
+ type: 'doc',
+ id: 'reference/s3-protocol',
+ label: 'S3 Protocol',
+ },
+ ],
+ },
+ {
+ type: 'category',
+ label: 'Scripting',
+ items: [
+ {
+ type: 'doc',
+ id: 'scripting/gotemplate',
+ label: 'Go Templates',
+ },
+ {
+ type: 'doc',
+ id: 'scripting/cel',
+ label: 'Expressions',
+ },
+ {
+ type: 'doc',
+ id: 'scripting/javascript',
+ label: 'Javascript',
},
],
},
diff --git a/docs/canary-checker/src/components/Asciinema.jsx b/docs/canary-checker/src/components/Asciinema.jsx
new file mode 100644
index 00000000..71805169
--- /dev/null
+++ b/docs/canary-checker/src/components/Asciinema.jsx
@@ -0,0 +1,11 @@
+import React from 'react';
+
+export function Asciinema({ id, width = "940px", code }) {
+ return (
+ <>
+
+
+ );
+}
+
diff --git a/docs/canary-checker/src/components/Badges.jsx b/docs/canary-checker/src/components/Badges.jsx
new file mode 100644
index 00000000..741add60
--- /dev/null
+++ b/docs/canary-checker/src/components/Badges.jsx
@@ -0,0 +1,66 @@
+import React from 'react';
+
+
+export function FullImage({ color }) {
+ return (
+
+ Full Image Variant Required
+
+ );
+}
+
+
+export function Commercial({ color }) {
+ return (
+
+ Commercial Edition Required
+
+ );
+}
+
+
+export function Standard({ color }) {
+ return (
+
+ Standard Edition Required
+
+ );
+}
+
+
+export function Enterprise({ color }) {
+ return (
+
+ Enterprise Edition Required
+
+ );
+}
diff --git a/docs/canary-checker/src/components/Connection.jsx b/docs/canary-checker/src/components/Connection.jsx
new file mode 100644
index 00000000..a7f2e27d
--- /dev/null
+++ b/docs/canary-checker/src/components/Connection.jsx
@@ -0,0 +1,27 @@
+
+import React from 'react';
+import { Commercial } from './Highlight';
+
+export var Connection = [
+ {
+ name: "connection",
+ description: <>Path of an existing connection e.g. connection://http/instance http://example.com,
+ scheme: "string",
+ required: true
+ },
+ {
+ name: "username",
+ description: <>Username for HTTP Basic Auth,
+ scheme: EnvVar,
+ },
+ {
+ name: "password",
+ description: <>Password for HTTP Basic Auth,
+ scheme: EnvVar,
+ }
+];
diff --git a/docs/canary-checker/src/components/Feature.jsx b/docs/canary-checker/src/components/Feature.jsx
new file mode 100644
index 00000000..f1ccede8
--- /dev/null
+++ b/docs/canary-checker/src/components/Feature.jsx
@@ -0,0 +1,50 @@
+
+import React from 'react';
+import { FeatureBody } from './FeatureBody';
+export function Feature({ image, title, subtitle, url, left = true, children, }) {
+
+ var icon = image
+ if ((typeof image) === 'string') {
+ icon = 
+ }
+ if (left) {
+ return (
+
+
+ )
+ }
+ return (
+
+
+
+
+
+
+
+ {icon}
+
+
+ {children}
+
+
+
+
+
+ )
+};
diff --git a/docs/canary-checker/src/components/FeatureBody.jsx b/docs/canary-checker/src/components/FeatureBody.jsx
new file mode 100644
index 00000000..9920b596
--- /dev/null
+++ b/docs/canary-checker/src/components/FeatureBody.jsx
@@ -0,0 +1,15 @@
+import React from 'react';
+import { LearnMore } from './LearnMore';
+
+export function FeatureBody({ title, subtitle, url, children }) {
+ return (
+ <>
+
+
+
+ {icon}
+
+
+
+
+
+ {children}
+
+
+ {subtitle}
+{title}
++ {children} +
+
+
+
+ );
+ }
+
+ function Description() {
+ return (
+ <>
+
+
+ {/* Description */}
+
+
+
+ 
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+ + A single pane of glass for health across your stack. +
++ Aggregate alerts, run synthetic checks / tests against your services and infrastructure. +
+
+
+ -
+
+
+
+
+
+
+
+
+
+ 100% Open Source
+ ++ Canary checker is 100% open source under the Apache 2.0 license. We welcome contributions from our awesome community. +
+ 
+ 
+ 
+
+ 
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+ }
+
+ return (
+
+
+
+
+
+
+ Support
+
+ 
+
Support for Canary Checker is available as part of the Flanksource Mission Control Internal Developer Platform + +
+
+ Learn More
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+}
+
+export default Home;
diff --git a/docs/canary-checker/src/components/Icon.jsx b/docs/canary-checker/src/components/Icon.jsx
new file mode 100644
index 00000000..60c03f77
--- /dev/null
+++ b/docs/canary-checker/src/components/Icon.jsx
@@ -0,0 +1,13 @@
+import React from "react";
+export default function Icon({ name, height = "32px", className, url }) {
+ let img = 
;
+
+ if (url != null) {
+ return {img};
+ }
+ return img
+}
diff --git a/docs/canary-checker/src/components/Integrations.jsx b/docs/canary-checker/src/components/Integrations.jsx
new file mode 100644
index 00000000..5a48af32
--- /dev/null
+++ b/docs/canary-checker/src/components/Integrations.jsx
@@ -0,0 +1,66 @@
+
+import React from 'react';
+import { FeatureBody } from './FeatureBody';
+
+const integrations = [
+ { icon: "prometheus" },
+ // { icon: "datadog" },
+ { icon: "dynatrace" },
+ { icon: "aws-cloudwatch" },
+ { icon: "k8s", url: "kubernetes" },
+ // { icon: "argo" },
+ // { icon: "flux" },
+
+ { icon: "http" },
+
+ { icon: "ssl", url: "http#ssl" },
+ { icon: "icmp" },
+ { icon: "dns" },
+ { icon: "ldap" },
+
+ { icon: "sftp" },
+ { icon: "smb" },
+ { icon: "s3" },
+ { icon: "gcs", url: "gcs-bucket" },
+
+ { icon: "redis" },
+ { icon: "mysql" },
+ { icon: "postgres" },
+ { icon: "mssql" },
+ { icon: "mongo" },
+ { icon: "elasticsearch" },
+ { icon: "opensearch", url: "elasticsearch" },
+
+ { icon: "jmeter" },
+ { icon: "k6" },
+ { icon: "postman" },
+ { icon: "playwright" },
+ { icon: "aws-ec2-instance" },
+
+ { icon: "aws-config" },
+ { icon: "helm" },
+ { icon: "docker" },
+ { icon: "bash", url: "exec" },
+ { icon: "powershell", url: "exec" },
+
+ { icon: "github" },
+ { icon: "azure-devops" },
+];
+export function Integrations() {
+ return (
+
+ {integrations.map((integration) => (
+
+ 
+
+ ))}
+
+ )
+}
+
diff --git a/docs/canary-checker/src/components/LearnMore.jsx b/docs/canary-checker/src/components/LearnMore.jsx
new file mode 100644
index 00000000..3baa8cae
--- /dev/null
+++ b/docs/canary-checker/src/components/LearnMore.jsx
@@ -0,0 +1,9 @@
+import React from 'react';
+
+export function LearnMore({ url }) {
+ return (
+
+ Learn more
+
+ );
+}
diff --git a/docs/canary-checker/src/components/Properties.jsx b/docs/canary-checker/src/components/Properties.jsx
new file mode 100644
index 00000000..6081edab
--- /dev/null
+++ b/docs/canary-checker/src/components/Properties.jsx
@@ -0,0 +1,45 @@
+import React from 'react';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+
+export default function Properties({ args = [] }) {
+
+ const { siteConfig } = useDocusaurusContext();
+ const oss = siteConfig.customFields.oss;
+
+
+ return (
+
+ <>
+
+
+ ))}
+ | Field | +Description | +Scheme | +Required | +
|---|---|---|---|
{arg.name} |
+ {arg.description} | +{arg.scheme} |
+ {arg.required ? 'Yes' : 'No'} | +
+ {children}
+
+ );
+}
diff --git a/docs/canary-checker/src/theme/MDXComponents/Head.js b/docs/canary-checker/src/theme/MDXComponents/Head.js
new file mode 100644
index 00000000..6f702303
--- /dev/null
+++ b/docs/canary-checker/src/theme/MDXComponents/Head.js
@@ -0,0 +1,17 @@
+import React from 'react';
+import Head from '@docusaurus/Head';
+// MDX elements are wrapped through the MDX pragma. In some cases (notably usage
+// with Head/Helmet) we need to unwrap those elements.
+function unwrapMDXElement(element) {
+ if (element.props?.mdxType && element.props.originalType) {
+ const {mdxType, originalType, ...newProps} = element.props;
+ return React.createElement(element.props.originalType, newProps);
+ }
+ return element;
+}
+export default function MDXHead(props) {
+ const unwrappedChildren = React.Children.map(props.children, (child) =>
+ React.isValidElement(child) ? unwrapMDXElement(child) : child,
+ );
+ return {unwrappedChildren};
+}
diff --git a/docs/canary-checker/src/theme/MDXComponents/Heading.js b/docs/canary-checker/src/theme/MDXComponents/Heading.js
new file mode 100644
index 00000000..a96288c6
--- /dev/null
+++ b/docs/canary-checker/src/theme/MDXComponents/Heading.js
@@ -0,0 +1,5 @@
+import React from 'react';
+import Heading from '@theme/Heading';
+export default function MDXHeading(props) {
+ return wrapped inside (not inline).
+ var pre = env.element.parentElement;
+ if (!pre || !/pre/i.test(pre.nodeName) || // Abort only if neither the nor the have the class
+ (!CLASS_PATTERN.test(pre.className) && !CLASS_PATTERN.test(env.element.className))) {
+ commandLine.complete = true;
+ return;
+ }
+
+ // The element might be highlighted multiple times, so we just remove the previous prompt
+ var existingPrompt = env.element.querySelector('.' + PROMPT_CLASS);
+ if (existingPrompt) {
+ existingPrompt.remove();
+ }
+
+ var codeLines = env.code.split('\n');
+
+ commandLine.numberOfLines = codeLines.length;
+ /** @type {string[]} */
+ var outputLines = commandLine.outputLines = [];
+
+ var outputSections = pre.getAttribute('data-output');
+ var outputFilter = pre.getAttribute('data-filter-output');
+ if (outputSections !== null) { // The user specified the output lines. -- cwells
+ outputSections.split(',').forEach(function (section) {
+ var range = section.split('-');
+ var outputStart = parseInt(range[0], 10);
+ var outputEnd = range.length === 2 ? parseInt(range[1], 10) : outputStart;
+
+ if (!isNaN(outputStart) && !isNaN(outputEnd)) {
+ if (outputStart < 1) {
+ outputStart = 1;
+ }
+ if (outputEnd > codeLines.length) {
+ outputEnd = codeLines.length;
+ }
+ // Convert start and end to 0-based to simplify the arrays. -- cwells
+ outputStart--;
+ outputEnd--;
+ // Save the output line in an array and clear it in the code so it's not highlighted. -- cwells
+ for (var j = outputStart; j <= outputEnd; j++) {
+ outputLines[j] = codeLines[j];
+ codeLines[j] = '';
+ }
+ }
+ });
+ } else if (outputFilter) { // Treat lines beginning with this string as output. -- cwells
+ for (var i = 0; i < codeLines.length; i++) {
+ if (startsWith(codeLines[i], outputFilter)) { // This line is output. -- cwells
+ outputLines[i] = codeLines[i].slice(outputFilter.length);
+ codeLines[i] = '';
+ }
+ }
+ }
+
+ var continuationLineIndicies = commandLine.continuationLineIndicies = new Set();
+ var lineContinuationStr = pre.getAttribute('data-continuation-str');
+ var continuationFilter = pre.getAttribute('data-filter-continuation');
+
+ // Identify code lines where the command has continued onto subsequent
+ // lines and thus need a different prompt. Need to do this after the output
+ // lines have been removed to ensure we don't pick up a continuation string
+ // in an output line.
+ for (var j = 0; j < codeLines.length; j++) {
+ var line = codeLines[j];
+ if (!line) {
+ continue;
+ }
+
+ // Record the next line as a continuation if this one ends in a continuation str.
+ if (lineContinuationStr && endsWith(line, lineContinuationStr)) {
+ continuationLineIndicies.add(j + 1);
+ }
+ // Record this line as a continuation if marked with a continuation prefix
+ // (that we will remove).
+ if (j > 0 && continuationFilter && startsWith(line, continuationFilter)) {
+ codeLines[j] = line.slice(continuationFilter.length);
+ continuationLineIndicies.add(j);
+ }
+ }
+
+ env.code = codeLines.join('\n');
+ });
+
+ Prism.hooks.add('before-insert', function (env) {
+ var commandLine = getCommandLineInfo(env);
+
+ if (commandLine.complete) {
+ return;
+ }
+
+ // Reinsert the output lines into the highlighted code. -- cwells
+ var codeLines = env.highlightedCode.split('\n');
+ var outputLines = commandLine.outputLines || [];
+ for (var i = 0, l = codeLines.length; i < l; i++) {
+ // Add spans to allow distinction of input/output text for styling
+ if (outputLines.hasOwnProperty(i)) {
+ // outputLines were removed from codeLines so missed out on escaping
+ // of markup so do it here.
+ codeLines[i] = ''
+ + Prism.util.encode(outputLines[i]) + '';
+ } else {
+ codeLines[i] = ''
+ + codeLines[i] + '';
+ }
+ }
+ env.highlightedCode = codeLines.join('\n');
+ });
+
+ Prism.hooks.add('complete', function (env) {
+ if (!hasCommandLineInfo(env)) {
+ // the previous hooks never ran
+ return;
+ }
+
+ var commandLine = getCommandLineInfo(env);
+
+ if (commandLine.complete) {
+ return;
+ }
+
+ var pre = env.element.parentElement;
+ if (CLASS_PATTERN.test(env.element.className)) { // Remove the class "command-line" from the
+ env.element.className = env.element.className.replace(CLASS_PATTERN, ' ');
+ }
+ if (!CLASS_PATTERN.test(pre.className)) { // Add the class "command-line" to the
+ pre.className += ' command-line';
+ }
+
+ function getAttribute(key, defaultValue) {
+ return (pre.getAttribute(key) || defaultValue).replace(/"/g, '"');
+ }
+
+ // Create the "rows" that will become the command-line prompts. -- cwells
+ var promptLines = '';
+ var rowCount = commandLine.numberOfLines || 0;
+ var promptText = getAttribute('data-prompt', '');
+ var promptLine;
+ if (promptText !== '') {
+ promptLine = '';
+ } else {
+ var user = getAttribute('data-user', 'user');
+ var host = getAttribute('data-host', 'localhost');
+ promptLine = '';
+ }
+
+ var continuationLineIndicies = commandLine.continuationLineIndicies || new Set();
+ var continuationPromptText = getAttribute('data-continuation-prompt', '>');
+ var continuationPromptLine = '';
+
+ // Assemble all the appropriate prompt/continuation lines
+ for (var j = 0; j < rowCount; j++) {
+ if (continuationLineIndicies.has(j)) {
+ promptLines += continuationPromptLine;
+ } else {
+ promptLines += promptLine;
+ }
+ }
+
+ // Create the wrapper element. -- cwells
+ var prompt = document.createElement('span');
+ prompt.className = PROMPT_CLASS;
+ prompt.innerHTML = promptLines;
+
+ // Remove the prompt from the output lines. -- cwells
+ var outputLines = commandLine.outputLines || [];
+ for (var i = 0, l = outputLines.length; i < l; i++) {
+ if (outputLines.hasOwnProperty(i)) {
+ var node = prompt.children[i];
+ node.removeAttribute('data-user');
+ node.removeAttribute('data-host');
+ node.removeAttribute('data-prompt');
+ }
+ }
+
+ env.element.insertBefore(prompt, env.element.firstChild);
+ commandLine.complete = true;
+ });
+
+}());
diff --git a/docs/canary-checker/src/theme/prism-include-languages.js b/docs/canary-checker/src/theme/prism-include-languages.js
new file mode 100644
index 00000000..18f884e7
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-include-languages.js
@@ -0,0 +1,29 @@
+import siteConfig from '@generated/docusaurus.config';
+
+export default function prismIncludeLanguages(PrismObject) {
+ const {
+ themeConfig: { prism },
+ } = siteConfig;
+ const { additionalLanguages } = prism;
+ // Prism components work on the Prism instance on the window, while prism-
+ // react-renderer uses its own Prism instance. We temporarily mount the
+ // instance onto window, import components to enhance it, then remove it to
+ // avoid polluting global namespace.
+ // You can mutate PrismObject: registering plugins, deleting languages... As
+ // long as you don't re-assign it
+ globalThis.Prism = PrismObject;
+ require('./prism-jq')
+ require('./prism-log')
+ require('./prism-promql')
+ require('./prism-regex')
+ require('./prism-shell-session')
+ require('./prism-command-line')
+ require('./prism-yaml')
+ require('./prism-bash')
+
+ additionalLanguages.forEach((lang) => {
+ // eslint-disable-next-line global-require, import/no-dynamic-require
+ require(`prismjs/components/prism-${lang}`);
+ });
+
+}
diff --git a/docs/canary-checker/src/theme/prism-jq.js b/docs/canary-checker/src/theme/prism-jq.js
new file mode 100644
index 00000000..3cc030e7
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-jq.js
@@ -0,0 +1,69 @@
+(function (Prism) {
+
+ var interpolation = /\\\((?:[^()]|\([^()]*\))*\)/.source;
+ var string = RegExp(/(^|[^\\])"(?:[^"\r\n\\]|\\[^\r\n(]|__)*"/.source.replace(/__/g, function () { return interpolation; }));
+ var stringInterpolation = {
+ 'interpolation': {
+ pattern: RegExp(/((?:^|[^\\])(?:\\{2})*)/.source + interpolation),
+ lookbehind: true,
+ inside: {
+ 'content': {
+ pattern: /^(\\\()[\s\S]+(?=\)$)/,
+ lookbehind: true,
+ inside: null // see below
+ },
+ 'punctuation': /^\\\(|\)$/
+ }
+ }
+ };
+
+ var jq = Prism.languages.jq = {
+ 'comment': /#.*/,
+ 'property': {
+ pattern: RegExp(string.source + /(?=\s*:(?!:))/.source),
+ lookbehind: true,
+ greedy: true,
+ inside: stringInterpolation
+ },
+ 'string': {
+ pattern: string,
+ lookbehind: true,
+ greedy: true,
+ inside: stringInterpolation
+ },
+
+ 'function': {
+ pattern: /(\bdef\s+)[a-z_]\w+/i,
+ lookbehind: true
+ },
+
+ 'variable': /\B\$\w+/,
+ 'property-literal': {
+ pattern: /\b[a-z_]\w*(?=\s*:(?!:))/i,
+ alias: 'property'
+ },
+ 'keyword': /\b(?:as|break|catch|def|elif|else|end|foreach|if|import|include|label|module|modulemeta|null|reduce|then|try|while)\b/,
+ 'boolean': /\b(?:false|true)\b/,
+ 'number': /(?:\b\d+\.|\B\.)?\b\d+(?:[eE][+-]?\d+)?\b/,
+
+ 'operator': [
+ {
+ pattern: /\|=?/,
+ alias: 'pipe'
+ },
+ /\.\.|[!=<>]?=|\?\/\/|\/\/=?|[-+*/%]=?|[<>?]|\b(?:and|not|or)\b/
+ ],
+ 'c-style-function': {
+ pattern: /\b[a-z_]\w*(?=\s*\()/i,
+ alias: 'function'
+ },
+ 'punctuation': /::|[()\[\]{},:;]|\.(?=\s*[\[\w$])/,
+ 'dot': {
+ pattern: /\./,
+ alias: 'important'
+ }
+ };
+
+ stringInterpolation.interpolation.inside.content.inside = jq;
+
+}(Prism));
diff --git a/docs/canary-checker/src/theme/prism-log.js b/docs/canary-checker/src/theme/prism-log.js
new file mode 100644
index 00000000..d84defcb
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-log.js
@@ -0,0 +1,120 @@
+// This is a language definition for generic log files.
+// Since there is no one log format, this language definition has to support all formats to some degree.
+//
+// Based on https://github.com/MTDL9/vim-log-highlighting
+
+Prism.languages.log = {
+ 'string': {
+ // Single-quoted strings must not be confused with plain text. E.g. Can't isn't Susan's Chris' toy
+ pattern: /"(?:[^"\\\r\n]|\\.)*"|'(?![st] | \w)(?:[^'\\\r\n]|\\.)*'/,
+ greedy: true,
+ },
+
+ 'exception': {
+ pattern: /(^|[^\w.])[a-z][\w.]*(?:Error|Exception):.*(?:(?:\r\n?|\n)[ \t]*(?:at[ \t].+|\.{3}.*|Caused by:.*))+(?:(?:\r\n?|\n)[ \t]*\.\.\. .*)?/,
+ lookbehind: true,
+ greedy: true,
+ alias: ['javastacktrace', 'language-javastacktrace'],
+ inside: Prism.languages['javastacktrace'] || {
+ 'keyword': /\bat\b/,
+ 'function': /[a-z_][\w$]*(?=\()/,
+ 'punctuation': /[.:()]/
+ }
+ },
+
+ 'level': [
+ {
+ pattern: /\b(?:ALERT|CRIT|CRITICAL|EMERG|EMERGENCY|ERR|ERROR|FAILURE|FATAL|SEVERE)\b/,
+ alias: ['error', 'important']
+ },
+ {
+ pattern: /\b(?:WARN|WARNING|WRN)\b/,
+ alias: ['warning', 'important']
+ },
+ {
+ pattern: /\b(?:DISPLAY|INF|INFO|NOTICE|STATUS)\b/,
+ alias: ['info', 'keyword']
+ },
+ {
+ pattern: /\b(?:DBG|DEBUG|FINE)\b/,
+ alias: ['debug', 'keyword']
+ },
+ {
+ pattern: /\b(?:FINER|FINEST|TRACE|TRC|VERBOSE|VRB)\b/,
+ alias: ['trace', 'comment']
+ }
+ ],
+
+ 'property': {
+ pattern: /((?:^|[\]|])[ \t]*)[a-z_](?:[\w-]|\b\/\b)*(?:[. ]\(?\w(?:[\w-]|\b\/\b)*\)?)*:(?=\s)/im,
+ lookbehind: true
+ },
+
+ 'separator': {
+ pattern: /(^|[^-+])-{3,}|={3,}|\*{3,}|- - /m,
+ lookbehind: true,
+ alias: 'comment'
+ },
+
+ 'url': /\b(?:file|ftp|https?):\/\/[^\s|,;'"]*[^\s|,;'">.]/,
+ 'email': {
+ pattern: /(^|\s)[-\w+.]+@[a-z][a-z0-9-]*(?:\.[a-z][a-z0-9-]*)+(?=\s)/,
+ lookbehind: true,
+ alias: 'url'
+ },
+
+ 'ip-address': {
+ pattern: /\b(?:\d{1,3}(?:\.\d{1,3}){3})\b/,
+ alias: 'constant'
+ },
+ 'mac-address': {
+ pattern: /\b[a-f0-9]{2}(?::[a-f0-9]{2}){5}\b/i,
+ alias: 'constant'
+ },
+ 'domain': {
+ pattern: /(^|\s)[a-z][a-z0-9-]*(?:\.[a-z][a-z0-9-]*)*\.[a-z][a-z0-9-]+(?=\s)/,
+ lookbehind: true,
+ alias: 'constant'
+ },
+
+ 'uuid': {
+ pattern: /\b[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\b/i,
+ alias: 'constant'
+ },
+ 'hash': {
+ pattern: /\b(?:[a-f0-9]{32}){1,2}\b/i,
+ alias: 'constant'
+ },
+
+ 'file-path': {
+ pattern: /\b[a-z]:[\\/][^\s|,;:(){}\[\]"']+|(^|[\s:\[\](>|])\.{0,2}\/\w[^\s|,;:(){}\[\]"']*/i,
+ lookbehind: true,
+ greedy: true,
+ alias: 'string'
+ },
+
+ 'date': {
+ pattern: RegExp(
+ /\b\d{4}[-/]\d{2}[-/]\d{2}(?:T(?=\d{1,2}:)|(?=\s\d{1,2}:))/.source +
+ '|' +
+ /\b\d{1,4}[-/ ](?:\d{1,2}|Apr|Aug|Dec|Feb|Jan|Jul|Jun|Mar|May|Nov|Oct|Sep)[-/ ]\d{2,4}T?\b/.source +
+ '|' +
+ /\b(?:(?:Fri|Mon|Sat|Sun|Thu|Tue|Wed)(?:\s{1,2}(?:Apr|Aug|Dec|Feb|Jan|Jul|Jun|Mar|May|Nov|Oct|Sep))?|Apr|Aug|Dec|Feb|Jan|Jul|Jun|Mar|May|Nov|Oct|Sep)\s{1,2}\d{1,2}\b/.source,
+ 'i'
+ ),
+ alias: 'number'
+ },
+ 'time': {
+ pattern: /\b\d{1,2}:\d{1,2}:\d{1,2}(?:[.,:]\d+)?(?:\s?[+-]\d{2}:?\d{2}|Z)?\b/,
+ alias: 'number'
+ },
+
+ 'boolean': /\b(?:false|null|true)\b/i,
+ 'number': {
+ pattern: /(^|[^.\w])(?:0x[a-f0-9]+|0o[0-7]+|0b[01]+|v?\d[\da-f]*(?:\.\d+)*(?:e[+-]?\d+)?[a-z]{0,3}\b)\b(?!\.\w)/i,
+ lookbehind: true
+ },
+
+ 'operator': /[;:?<=>~/@!$%&+\-|^(){}*#]/,
+ 'punctuation': /[\[\].,]/
+};
diff --git a/docs/canary-checker/src/theme/prism-promql.js b/docs/canary-checker/src/theme/prism-promql.js
new file mode 100644
index 00000000..d12f7303
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-promql.js
@@ -0,0 +1,99 @@
+// Thanks to: https://github.com/prometheus-community/monaco-promql/blob/master/src/promql/promql.ts
+// As well as: https://kausal.co/blog/slate-prism-add-new-syntax-promql/
+
+(function (Prism) {
+ // PromQL Aggregation Operators
+ // (https://prometheus.io/docs/prometheus/latest/querying/operators/#aggregation-operators)
+ var aggregations = [
+ 'sum',
+ 'min',
+ 'max',
+ 'avg',
+ 'group',
+ 'stddev',
+ 'stdvar',
+ 'count',
+ 'count_values',
+ 'bottomk',
+ 'topk',
+ 'quantile'
+ ];
+
+ // PromQL vector matching + the by and without clauses
+ // (https://prometheus.io/docs/prometheus/latest/querying/operators/#vector-matching)
+ var vectorMatching = [
+ 'on',
+ 'ignoring',
+ 'group_right',
+ 'group_left',
+ 'by',
+ 'without',
+ ];
+
+ // PromQL offset modifier
+ // (https://prometheus.io/docs/prometheus/latest/querying/basics/#offset-modifier)
+ var offsetModifier = ['offset'];
+
+ var keywords = aggregations.concat(vectorMatching, offsetModifier);
+
+ Prism.languages.promql = {
+ 'comment': {
+ pattern: /(^[ \t]*)#.*/m,
+ lookbehind: true
+ },
+ 'vector-match': {
+ // Match the comma-separated label lists inside vector matching:
+ pattern: new RegExp('((?:' + vectorMatching.join('|') + ')\\s*)\\([^)]*\\)'),
+ lookbehind: true,
+ inside: {
+ 'label-key': {
+ pattern: /\b[^,]+\b/,
+ alias: 'attr-name',
+ },
+ 'punctuation': /[(),]/
+ },
+ },
+ 'context-labels': {
+ pattern: /\{[^{}]*\}/,
+ inside: {
+ 'label-key': {
+ pattern: /\b[a-z_]\w*(?=\s*(?:=|![=~]))/,
+ alias: 'attr-name',
+ },
+ 'label-value': {
+ pattern: /(["'`])(?:\\[\s\S]|(?!\1)[^\\])*\1/,
+ greedy: true,
+ alias: 'attr-value',
+ },
+ 'punctuation': /\{|\}|=~?|![=~]|,/,
+ },
+ },
+ 'context-range': [
+ {
+ pattern: /\[[\w\s:]+\]/, // [1m]
+ inside: {
+ 'punctuation': /\[|\]|:/,
+ 'range-duration': {
+ pattern: /\b(?:\d+(?:[smhdwy]|ms))+\b/i,
+ alias: 'number',
+ },
+ },
+ },
+ {
+ pattern: /(\boffset\s+)\w+/, // offset 1m
+ lookbehind: true,
+ inside: {
+ 'range-duration': {
+ pattern: /\b(?:\d+(?:[smhdwy]|ms))+\b/i,
+ alias: 'number',
+ },
+ },
+ },
+ ],
+ 'keyword': new RegExp('\\b(?:' + keywords.join('|') + ')\\b', 'i'),
+ 'function': /\b[a-z_]\w*(?=\s*\()/i,
+ 'number': /[-+]?(?:(?:\b\d+(?:\.\d+)?|\B\.\d+)(?:e[-+]?\d+)?\b|\b(?:0x[0-9a-f]+|nan|inf)\b)/i,
+ 'operator': /[\^*/%+-]|==|!=|<=|<|>=|>|\b(?:and|or|unless)\b/i,
+ 'punctuation': /[{};()`,.[\]]/,
+ };
+}(Prism));
diff --git a/docs/canary-checker/src/theme/prism-regex.js b/docs/canary-checker/src/theme/prism-regex.js
new file mode 100644
index 00000000..a565e234
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-regex.js
@@ -0,0 +1,104 @@
+(function (Prism) {
+
+ var specialEscape = {
+ pattern: /\\[\\(){}[\]^$+*?|.]/,
+ alias: 'escape'
+ };
+ var escape = /\\(?:x[\da-fA-F]{2}|u[\da-fA-F]{4}|u\{[\da-fA-F]+\}|0[0-7]{0,2}|[123][0-7]{2}|c[a-zA-Z]|.)/;
+ var charSet = {
+ pattern: /\.|\\[wsd]|\\p\{[^{}]+\}/i,
+ alias: 'class-name'
+ };
+ var charSetWithoutDot = {
+ pattern: /\\[wsd]|\\p\{[^{}]+\}/i,
+ alias: 'class-name'
+ };
+
+ var rangeChar = '(?:[^\\\\-]|' + escape.source + ')';
+ var range = RegExp(rangeChar + '-' + rangeChar);
+
+ // the name of a capturing group
+ var groupName = {
+ pattern: /(<|')[^<>']+(?=[>']$)/,
+ lookbehind: true,
+ alias: 'variable'
+ };
+
+ Prism.languages.regex = {
+ 'char-class': {
+ pattern: /((?:^|[^\\])(?:\\\\)*)\[(?:[^\\\]]|\\[\s\S])*\]/,
+ lookbehind: true,
+ inside: {
+ 'char-class-negation': {
+ pattern: /(^\[)\^/,
+ lookbehind: true,
+ alias: 'operator'
+ },
+ 'char-class-punctuation': {
+ pattern: /^\[|\]$/,
+ alias: 'punctuation'
+ },
+ 'range': {
+ pattern: range,
+ inside: {
+ 'escape': escape,
+ 'range-punctuation': {
+ pattern: /-/,
+ alias: 'operator'
+ }
+ }
+ },
+ 'special-escape': specialEscape,
+ 'char-set': charSetWithoutDot,
+ 'escape': escape
+ }
+ },
+ 'special-escape': specialEscape,
+ 'char-set': charSet,
+ 'backreference': [
+ {
+ // a backreference which is not an octal escape
+ pattern: /\\(?![123][0-7]{2})[1-9]/,
+ alias: 'keyword'
+ },
+ {
+ pattern: /\\k<[^<>']+>/,
+ alias: 'keyword',
+ inside: {
+ 'group-name': groupName
+ }
+ }
+ ],
+ 'anchor': {
+ pattern: /[$^]|\\[ABbGZz]/,
+ alias: 'function'
+ },
+ 'escape': escape,
+ 'group': [
+ {
+ // https://docs.oracle.com/javase/10/docs/api/java/util/regex/Pattern.html
+ // https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference?view=netframework-4.7.2#grouping-constructs
+
+ // (), (?), (?'name'), (?>), (?:), (?=), (?!), (?<=), (?']+>|'[^<>']+'|[>:]| ":" ( )?
+ /[^\s@:$#%*!/\\]+@[^\r\n@:$#%*!/\\]+(?::[^\0-\x1F$#%*?"<>:;|]+)?/.source +
+ '|' +
+ //
+ // Since the path pattern is quite general, we will require it to start with a special character to
+ // prevent false positives.
+ /[/~.][^\0-\x1F$#%*?"<>@:;|]*/.source
+ ) +
+ ')?' +
+ // shell symbol
+ /[$#%](?=\s)/.source +
+ // bash command
+ /(?:[^\\\r\n \t'"<$]|[ \t](?:(?!#)|#.*$)|\\(?:[^\r]|\r\n?)|\$(?!')|<(?!<)|<>)+/.source.replace(/<>/g, function () { return strings; }),
+ 'm'
+ ),
+ greedy: true,
+ inside: {
+ 'info': {
+ // foo@bar:~/files$ exit
+ // foo@bar$ exit
+ // ~/files$ exit
+ pattern: /^[^#$%]+/,
+ alias: 'punctuation',
+ inside: {
+ 'user': /^[^\s@:$#%*!/\\]+@[^\r\n@:$#%*!/\\]+/,
+ 'punctuation': /:/,
+ 'path': /[\s\S]+/
+ }
+ },
+ 'bash': {
+ pattern: /(^[$#%]\s*)\S[\s\S]*/,
+ lookbehind: true,
+ alias: 'language-bash',
+ inside: Prism.languages.bash
+ },
+ 'shell-symbol': {
+ pattern: /^[$#%]/,
+ alias: 'important'
+ }
+ }
+ },
+ 'output': /.(?:.*(?:[\r\n]|.$))*/
+ };
+
+ Prism.languages['sh-session'] = Prism.languages['shellsession'] = Prism.languages['shell-session'];
+
+}(Prism));
diff --git a/docs/canary-checker/src/theme/prism-yaml.js b/docs/canary-checker/src/theme/prism-yaml.js
new file mode 100644
index 00000000..a16390bf
--- /dev/null
+++ b/docs/canary-checker/src/theme/prism-yaml.js
@@ -0,0 +1,83 @@
+(function (Prism) {
+
+ // https://yaml.org/spec/1.2/spec.html#c-ns-anchor-property
+ // https://yaml.org/spec/1.2/spec.html#c-ns-alias-node
+ var anchorOrAlias = /[*&][^\s[\]{},]+/;
+ // https://yaml.org/spec/1.2/spec.html#c-ns-tag-property
+ var tag = /!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/;
+ // https://yaml.org/spec/1.2/spec.html#c-ns-properties(n,c)
+ var properties = '(?:' + tag.source + '(?:[ \t]+' + anchorOrAlias.source + ')?|'
+ + anchorOrAlias.source + '(?:[ \t]+' + tag.source + ')?)';
+ // https://yaml.org/spec/1.2/spec.html#ns-plain(n,c)
+ // This is a simplified version that doesn't support "#" and multiline keys
+ // All these long scarry character classes are simplified versions of YAML's characters
+ var plainKey = /(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source
+ .replace(//g, function () { return /[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source; });
+ var string = /"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;
+
+ /**
+ *
+ * @param {string} value
+ * @param {string} [flags]
+ * @returns {RegExp}
+ */
+ function createValuePattern(value, flags) {
+ flags = (flags || '').replace(/m/g, '') + 'm'; // add m flag
+ var pattern = /([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source
+ .replace(/<>/g, function () { return properties; }).replace(/<>/g, function () { return value; });
+ return RegExp(pattern, flags);
+ }
+
+ Prism.languages.yaml = {
+ 'scalar': {
+ pattern: RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source
+ .replace(/<>/g, function () { return properties; })),
+ lookbehind: true,
+ alias: 'string'
+ },
+ 'comment': /#.*/,
+ 'key': {
+ pattern: RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source
+ .replace(/<>/g, function () { return properties; })
+ .replace(/<>/g, function () { return '(?:' + plainKey + '|' + string + ')'; })),
+ lookbehind: true,
+ greedy: true,
+ alias: 'atrule'
+ },
+ 'directive': {
+ pattern: /(^[ \t]*)%.+/m,
+ lookbehind: true,
+ alias: 'important'
+ },
+ 'datetime': {
+ pattern: createValuePattern(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),
+ lookbehind: true,
+ alias: 'number'
+ },
+ 'boolean': {
+ pattern: createValuePattern(/false|true/.source, 'i'),
+ lookbehind: true,
+ alias: 'important'
+ },
+ 'null': {
+ pattern: createValuePattern(/null|~/.source, 'i'),
+ lookbehind: true,
+ alias: 'important'
+ },
+ 'string': {
+ pattern: createValuePattern(string),
+ lookbehind: true,
+ greedy: true
+ },
+ 'number': {
+ pattern: createValuePattern(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source, 'i'),
+ lookbehind: true
+ },
+ 'tag': tag,
+ 'important': anchorOrAlias,
+ 'punctuation': /---|[:[\]{}\-,|>?]|\.\.\./
+ };
+
+ Prism.languages.yml = Prism.languages.yaml;
+
+}(Prism));
diff --git a/docs/canary-checker/static/img/auth-check.png b/docs/canary-checker/static/img/auth-check.png
new file mode 100644
index 00000000..9c1c1dfa
Binary files /dev/null and b/docs/canary-checker/static/img/auth-check.png differ
diff --git a/docs/canary-checker/static/img/canary-ui.png b/docs/canary-checker/static/img/canary-ui.png
new file mode 100644
index 00000000..fd3a33d0
Binary files /dev/null and b/docs/canary-checker/static/img/canary-ui.png differ
diff --git a/docs/canary-checker/static/img/canary.png b/docs/canary-checker/static/img/canary.png
new file mode 100644
index 00000000..a0bd03fb
Binary files /dev/null and b/docs/canary-checker/static/img/canary.png differ
diff --git a/docs/canary-checker/static/img/debug-screenshot.png b/docs/canary-checker/static/img/debug-screenshot.png
new file mode 100644
index 00000000..f2af9d4f
Binary files /dev/null and b/docs/canary-checker/static/img/debug-screenshot.png differ
diff --git a/docs/canary-checker/static/img/display-format.png b/docs/canary-checker/static/img/display-format.png
new file mode 100644
index 00000000..13730b63
Binary files /dev/null and b/docs/canary-checker/static/img/display-format.png differ
diff --git a/docs/canary-checker/static/img/exec-check.png b/docs/canary-checker/static/img/exec-check.png
new file mode 100644
index 00000000..e9e276df
Binary files /dev/null and b/docs/canary-checker/static/img/exec-check.png differ
diff --git a/docs/canary-checker/static/img/grafana-dashboard.png b/docs/canary-checker/static/img/grafana-dashboard.png
new file mode 100644
index 00000000..5c1d0415
Binary files /dev/null and b/docs/canary-checker/static/img/grafana-dashboard.png differ
diff --git a/docs/canary-checker/static/img/graph-blue-line.svg b/docs/canary-checker/static/img/graph-blue-line.svg
new file mode 100644
index 00000000..5698d0fa
--- /dev/null
+++ b/docs/canary-checker/static/img/graph-blue-line.svg
@@ -0,0 +1 @@
+
diff --git a/docs/canary-checker/static/img/icons/activemq-icon.svg b/docs/canary-checker/static/img/icons/activemq-icon.svg
new file mode 100644
index 00000000..fff0071b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/activemq-icon.svg
@@ -0,0 +1,17 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/add-firewall.svg b/docs/canary-checker/static/img/icons/add-firewall.svg
new file mode 100644
index 00000000..30a32585
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/add-firewall.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/aks.svg b/docs/canary-checker/static/img/icons/aks.svg
new file mode 100644
index 00000000..9f253d52
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aks.svg
@@ -0,0 +1,49 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/argo.svg b/docs/canary-checker/static/img/icons/argo.svg
new file mode 100644
index 00000000..c9f5483b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/argo.svg
@@ -0,0 +1,26 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/aws-cloudtrail.png b/docs/canary-checker/static/img/icons/aws-cloudtrail.png
new file mode 100644
index 00000000..361aa7c2
Binary files /dev/null and b/docs/canary-checker/static/img/icons/aws-cloudtrail.png differ
diff --git a/docs/canary-checker/static/img/icons/aws-cloudwatch.svg b/docs/canary-checker/static/img/icons/aws-cloudwatch.svg
new file mode 100644
index 00000000..9f8043dd
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-cloudwatch.svg
@@ -0,0 +1,15 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-config.png b/docs/canary-checker/static/img/icons/aws-config.png
new file mode 100644
index 00000000..fd6e0493
Binary files /dev/null and b/docs/canary-checker/static/img/icons/aws-config.png differ
diff --git a/docs/canary-checker/static/img/icons/aws-config.svg b/docs/canary-checker/static/img/icons/aws-config.svg
new file mode 100644
index 00000000..24b3c6af
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-config.svg
@@ -0,0 +1,15 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-detective.png b/docs/canary-checker/static/img/icons/aws-detective.png
new file mode 100644
index 00000000..5af68e5f
Binary files /dev/null and b/docs/canary-checker/static/img/icons/aws-detective.png differ
diff --git a/docs/canary-checker/static/img/icons/aws-ec2-instance.svg b/docs/canary-checker/static/img/icons/aws-ec2-instance.svg
new file mode 100644
index 00000000..b08a3a16
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-ec2-instance.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-guard-duty.svg b/docs/canary-checker/static/img/icons/aws-guard-duty.svg
new file mode 100644
index 00000000..2f1aae50
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-guard-duty.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-iam.svg b/docs/canary-checker/static/img/icons/aws-iam.svg
new file mode 100644
index 00000000..66b43add
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-iam.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-s3-bucket.svg b/docs/canary-checker/static/img/icons/aws-s3-bucket.svg
new file mode 100644
index 00000000..d4e5b10e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-s3-bucket.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-trusted-advisor-cost.svg b/docs/canary-checker/static/img/icons/aws-trusted-advisor-cost.svg
new file mode 100644
index 00000000..27acdd16
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-trusted-advisor-cost.svg
@@ -0,0 +1,12 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-trusted-advisor-fault-tolerance.svg b/docs/canary-checker/static/img/icons/aws-trusted-advisor-fault-tolerance.svg
new file mode 100644
index 00000000..b5c69eea
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-trusted-advisor-fault-tolerance.svg
@@ -0,0 +1,12 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-trusted-advisor-security.svg b/docs/canary-checker/static/img/icons/aws-trusted-advisor-security.svg
new file mode 100644
index 00000000..b5fdddc3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-trusted-advisor-security.svg
@@ -0,0 +1,12 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws-trusted-advisor.svg b/docs/canary-checker/static/img/icons/aws-trusted-advisor.svg
new file mode 100644
index 00000000..4684a8d4
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws-trusted-advisor.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/aws.svg b/docs/canary-checker/static/img/icons/aws.svg
new file mode 100644
index 00000000..4adee97e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/aws.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/azure-devops-pipeline.svg b/docs/canary-checker/static/img/icons/azure-devops-pipeline.svg
new file mode 100644
index 00000000..c74c1803
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/azure-devops-pipeline.svg
@@ -0,0 +1,14 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/azure-devops.svg b/docs/canary-checker/static/img/icons/azure-devops.svg
new file mode 100644
index 00000000..a8f87bea
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/azure-devops.svg
@@ -0,0 +1,15 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/azure.svg b/docs/canary-checker/static/img/icons/azure.svg
new file mode 100644
index 00000000..a6f62622
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/azure.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/bash.svg b/docs/canary-checker/static/img/icons/bash.svg
new file mode 100644
index 00000000..b3012456
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/bash.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/cel.svg b/docs/canary-checker/static/img/icons/cel.svg
new file mode 100644
index 00000000..79c29cfd
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/cel.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/cert-manager.svg b/docs/canary-checker/static/img/icons/cert-manager.svg
new file mode 100644
index 00000000..ed58647a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/cert-manager.svg
@@ -0,0 +1,54 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/cfg.svg b/docs/canary-checker/static/img/icons/cfg.svg
new file mode 100644
index 00000000..5d09751c
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/cfg.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/changes.svg b/docs/canary-checker/static/img/icons/changes.svg
new file mode 100644
index 00000000..7d8826e1
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/changes.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/cmd.svg b/docs/canary-checker/static/img/icons/cmd.svg
new file mode 100644
index 00000000..3b322524
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/cmd.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/code 2.svg b/docs/canary-checker/static/img/icons/code 2.svg
new file mode 100644
index 00000000..310938e5
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/code 2.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/code.svg b/docs/canary-checker/static/img/icons/code.svg
new file mode 100644
index 00000000..edd43e0a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/code.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/console.svg b/docs/canary-checker/static/img/icons/console.svg
new file mode 100644
index 00000000..b7ca464f
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/console.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/containerd.svg b/docs/canary-checker/static/img/icons/containerd.svg
new file mode 100644
index 00000000..70dc4f07
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/containerd.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/csi.svg b/docs/canary-checker/static/img/icons/csi.svg
new file mode 100644
index 00000000..f5b3e5fc
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/csi.svg
@@ -0,0 +1,44 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/datadog.svg b/docs/canary-checker/static/img/icons/datadog.svg
new file mode 100644
index 00000000..fd748601
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/datadog.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/diff.svg b/docs/canary-checker/static/img/icons/diff.svg
new file mode 100644
index 00000000..167a4786
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/diff.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/dns.svg b/docs/canary-checker/static/img/icons/dns.svg
new file mode 100644
index 00000000..1ac0ce61
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/dns.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/docker.svg b/docs/canary-checker/static/img/icons/docker.svg
new file mode 100644
index 00000000..60e2e909
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/docker.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/dockerPull.svg b/docs/canary-checker/static/img/icons/dockerPull.svg
new file mode 100644
index 00000000..a5ab1a89
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/dockerPull.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/dockerPush.svg b/docs/canary-checker/static/img/icons/dockerPush.svg
new file mode 100644
index 00000000..f6956843
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/dockerPush.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/dotnet.svg b/docs/canary-checker/static/img/icons/dotnet.svg
new file mode 100644
index 00000000..912fb948
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/dotnet.svg
@@ -0,0 +1,31 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/dynatrace.svg b/docs/canary-checker/static/img/icons/dynatrace.svg
new file mode 100644
index 00000000..b7ed5248
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/dynatrace.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/eks.svg b/docs/canary-checker/static/img/icons/eks.svg
new file mode 100644
index 00000000..d96f9e9b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/eks.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/elasticsearch.svg b/docs/canary-checker/static/img/icons/elasticsearch.svg
new file mode 100644
index 00000000..af473e98
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/elasticsearch.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/fluentd.svg b/docs/canary-checker/static/img/icons/fluentd.svg
new file mode 100644
index 00000000..f1d79ac1
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/fluentd.svg
@@ -0,0 +1,51 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/flux.svg b/docs/canary-checker/static/img/icons/flux.svg
new file mode 100644
index 00000000..06e49cd0
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/flux.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/folder-git.svg b/docs/canary-checker/static/img/icons/folder-git.svg
new file mode 100644
index 00000000..2170f412
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/folder-git.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/gcs.svg b/docs/canary-checker/static/img/icons/gcs.svg
new file mode 100644
index 00000000..2e986fa6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/gcs.svg
@@ -0,0 +1,3 @@
+
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/gilab.svg b/docs/canary-checker/static/img/icons/gilab.svg
new file mode 100644
index 00000000..98d10fc3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/gilab.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/git.svg b/docs/canary-checker/static/img/icons/git.svg
new file mode 100644
index 00000000..b490dc23
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/git.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/github.svg b/docs/canary-checker/static/img/icons/github.svg
new file mode 100644
index 00000000..fda3c815
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/github.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/gke.svg b/docs/canary-checker/static/img/icons/gke.svg
new file mode 100644
index 00000000..82ae0525
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/gke.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/go.svg b/docs/canary-checker/static/img/icons/go.svg
new file mode 100644
index 00000000..5ac08428
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/go.svg
@@ -0,0 +1,10 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/google.svg b/docs/canary-checker/static/img/icons/google.svg
new file mode 100644
index 00000000..8ac19607
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/google.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/grafana.svg b/docs/canary-checker/static/img/icons/grafana.svg
new file mode 100644
index 00000000..3c93d8c6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/grafana.svg
@@ -0,0 +1,12 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/helm.svg b/docs/canary-checker/static/img/icons/helm.svg
new file mode 100644
index 00000000..da395c5a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/helm.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/html.svg b/docs/canary-checker/static/img/icons/html.svg
new file mode 100644
index 00000000..ae0a955b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/html.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/http.svg b/docs/canary-checker/static/img/icons/http.svg
new file mode 100644
index 00000000..771b00bd
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/http.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/https.svg b/docs/canary-checker/static/img/icons/https.svg
new file mode 100644
index 00000000..fd74d112
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/https.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/icmp.svg b/docs/canary-checker/static/img/icons/icmp.svg
new file mode 100644
index 00000000..aee30d02
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/icmp.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ifttt.svg b/docs/canary-checker/static/img/icons/ifttt.svg
new file mode 100644
index 00000000..f1d6c41e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ifttt.svg
@@ -0,0 +1,8 @@
+
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/istio.svg b/docs/canary-checker/static/img/icons/istio.svg
new file mode 100644
index 00000000..a168a8d1
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/istio.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/jaegar.svg b/docs/canary-checker/static/img/icons/jaegar.svg
new file mode 100644
index 00000000..7019ae72
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/jaegar.svg
@@ -0,0 +1,25 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/java.svg b/docs/canary-checker/static/img/icons/java.svg
new file mode 100644
index 00000000..2172509e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/java.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/javascript.svg b/docs/canary-checker/static/img/icons/javascript.svg
new file mode 100644
index 00000000..e82325e6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/javascript.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/jira.svg b/docs/canary-checker/static/img/icons/jira.svg
new file mode 100644
index 00000000..e06c7f89
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/jira.svg
@@ -0,0 +1,18 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/jmeter.svg b/docs/canary-checker/static/img/icons/jmeter.svg
new file mode 100644
index 00000000..ee4b3919
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/jmeter.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/js.svg b/docs/canary-checker/static/img/icons/js.svg
new file mode 100644
index 00000000..8ef5c495
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/js.svg
@@ -0,0 +1,50 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/json.svg b/docs/canary-checker/static/img/icons/json.svg
new file mode 100644
index 00000000..73db609c
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/json.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/junit.svg b/docs/canary-checker/static/img/icons/junit.svg
new file mode 100644
index 00000000..1518de32
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/junit.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/jwt.svg b/docs/canary-checker/static/img/icons/jwt.svg
new file mode 100644
index 00000000..4fdb190b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/jwt.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k6.svg b/docs/canary-checker/static/img/icons/k6.svg
new file mode 100644
index 00000000..deb080d1
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k6.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/k8s-configmap.svg b/docs/canary-checker/static/img/icons/k8s-configmap.svg
new file mode 100644
index 00000000..3852b78b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-configmap.svg
@@ -0,0 +1,15 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-customresourcedefinition.svg b/docs/canary-checker/static/img/icons/k8s-customresourcedefinition.svg
new file mode 100644
index 00000000..5dcb4ed6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-customresourcedefinition.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-deployment.svg b/docs/canary-checker/static/img/icons/k8s-deployment.svg
new file mode 100644
index 00000000..31b0db38
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-deployment.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-ingress.svg b/docs/canary-checker/static/img/icons/k8s-ingress.svg
new file mode 100644
index 00000000..cb6c65de
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-ingress.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-namespace.svg b/docs/canary-checker/static/img/icons/k8s-namespace.svg
new file mode 100644
index 00000000..cb396e29
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-namespace.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-node.svg b/docs/canary-checker/static/img/icons/k8s-node.svg
new file mode 100644
index 00000000..bbbff634
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-node.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-pod.svg b/docs/canary-checker/static/img/icons/k8s-pod.svg
new file mode 100644
index 00000000..d08488ad
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-pod.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/k8s-white.svg b/docs/canary-checker/static/img/icons/k8s-white.svg
new file mode 100644
index 00000000..1560429e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s-white.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/k8s.svg b/docs/canary-checker/static/img/icons/k8s.svg
new file mode 100644
index 00000000..dc198d6d
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/k8s.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/kubescape.svg b/docs/canary-checker/static/img/icons/kubescape.svg
new file mode 100644
index 00000000..a516d28e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/kubescape.svg
@@ -0,0 +1,49 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/kustomize.svg b/docs/canary-checker/static/img/icons/kustomize.svg
new file mode 100644
index 00000000..08acc546
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/kustomize.svg
@@ -0,0 +1,17 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ldap.svg b/docs/canary-checker/static/img/icons/ldap.svg
new file mode 100644
index 00000000..796fea2b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ldap.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/linux.svg b/docs/canary-checker/static/img/icons/linux.svg
new file mode 100644
index 00000000..a141905d
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/linux.svg
@@ -0,0 +1,364 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/list.svg b/docs/canary-checker/static/img/icons/list.svg
new file mode 100644
index 00000000..d0c704c8
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/list.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/lua.svg b/docs/canary-checker/static/img/icons/lua.svg
new file mode 100644
index 00000000..1d3c7b4e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/lua.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/matrix.svg b/docs/canary-checker/static/img/icons/matrix.svg
new file mode 100644
index 00000000..4e5bfb4d
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/matrix.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/mattermost.svg b/docs/canary-checker/static/img/icons/mattermost.svg
new file mode 100644
index 00000000..9b055325
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/mattermost.svg
@@ -0,0 +1,2 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/maximize.svg b/docs/canary-checker/static/img/icons/maximize.svg
new file mode 100644
index 00000000..f6e9f67e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/maximize.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/memchache.svg b/docs/canary-checker/static/img/icons/memchache.svg
new file mode 100644
index 00000000..024139a6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/memchache.svg
@@ -0,0 +1,54 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/metrics.svg b/docs/canary-checker/static/img/icons/metrics.svg
new file mode 100644
index 00000000..f245def3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/metrics.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/microsoft.svg b/docs/canary-checker/static/img/icons/microsoft.svg
new file mode 100644
index 00000000..2a96b7e3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/microsoft.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/minimize.svg b/docs/canary-checker/static/img/icons/minimize.svg
new file mode 100644
index 00000000..d5f39a5b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/minimize.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/mongo.svg b/docs/canary-checker/static/img/icons/mongo.svg
new file mode 100644
index 00000000..cc1cc4b3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/mongo.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/mssql.svg b/docs/canary-checker/static/img/icons/mssql.svg
new file mode 100644
index 00000000..518e1ea2
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/mssql.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/mysql.svg b/docs/canary-checker/static/img/icons/mysql.svg
new file mode 100644
index 00000000..c48982c0
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/mysql.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/namespace.svg b/docs/canary-checker/static/img/icons/namespace.svg
new file mode 100644
index 00000000..e0e3d9d7
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/namespace.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/network.svg b/docs/canary-checker/static/img/icons/network.svg
new file mode 100644
index 00000000..89994e32
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/network.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/newrelic.svg b/docs/canary-checker/static/img/icons/newrelic.svg
new file mode 100644
index 00000000..cda76927
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/newrelic.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/nginx.svg b/docs/canary-checker/static/img/icons/nginx.svg
new file mode 100644
index 00000000..7fc3329f
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/nginx.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/nodejs.svg b/docs/canary-checker/static/img/icons/nodejs.svg
new file mode 100644
index 00000000..c3bb507a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/nodejs.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/opensearch.svg b/docs/canary-checker/static/img/icons/opensearch.svg
new file mode 100644
index 00000000..26da9ddb
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/opensearch.svg
@@ -0,0 +1,6 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/openshift.svg b/docs/canary-checker/static/img/icons/openshift.svg
new file mode 100644
index 00000000..cbd43539
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/openshift.svg
@@ -0,0 +1,10 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/opentelemetry.svg b/docs/canary-checker/static/img/icons/opentelemetry.svg
new file mode 100644
index 00000000..fe0097c9
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/opentelemetry.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/opsgenie.svg b/docs/canary-checker/static/img/icons/opsgenie.svg
new file mode 100644
index 00000000..14a605d4
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/opsgenie.svg
@@ -0,0 +1,18 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/oracle.svg b/docs/canary-checker/static/img/icons/oracle.svg
new file mode 100644
index 00000000..a52e1951
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/oracle.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/oracle_icon.svg b/docs/canary-checker/static/img/icons/oracle_icon.svg
new file mode 100644
index 00000000..f5de32ee
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/oracle_icon.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ory-kratos.svg b/docs/canary-checker/static/img/icons/ory-kratos.svg
new file mode 100644
index 00000000..3520a7e6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ory-kratos.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ory-logo.svg b/docs/canary-checker/static/img/icons/ory-logo.svg
new file mode 100644
index 00000000..af7f1b25
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ory-logo.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ory.svg b/docs/canary-checker/static/img/icons/ory.svg
new file mode 100644
index 00000000..5863be8f
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ory.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/passive-check.svg b/docs/canary-checker/static/img/icons/passive-check.svg
new file mode 100644
index 00000000..364e9e53
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/passive-check.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/ping.svg b/docs/canary-checker/static/img/icons/ping.svg
new file mode 100644
index 00000000..662b6f66
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ping.svg
@@ -0,0 +1,19 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/playwright.svg b/docs/canary-checker/static/img/icons/playwright.svg
new file mode 100644
index 00000000..da5b84bb
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/playwright.svg
@@ -0,0 +1,10 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/postgres.svg b/docs/canary-checker/static/img/icons/postgres.svg
new file mode 100644
index 00000000..2550ca76
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/postgres.svg
@@ -0,0 +1,9 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/postman.svg b/docs/canary-checker/static/img/icons/postman.svg
new file mode 100644
index 00000000..2ca9182e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/postman.svg
@@ -0,0 +1,28 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/powershell.svg b/docs/canary-checker/static/img/icons/powershell.svg
new file mode 100644
index 00000000..eb6b06d3
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/powershell.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/prometheus-white.svg b/docs/canary-checker/static/img/icons/prometheus-white.svg
new file mode 100644
index 00000000..8e3a9357
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/prometheus-white.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/prometheus.svg b/docs/canary-checker/static/img/icons/prometheus.svg
new file mode 100644
index 00000000..8621ba51
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/prometheus.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/pushbullet.svg b/docs/canary-checker/static/img/icons/pushbullet.svg
new file mode 100644
index 00000000..4232dd06
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/pushbullet.svg
@@ -0,0 +1,20 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/pushover.svg b/docs/canary-checker/static/img/icons/pushover.svg
new file mode 100644
index 00000000..28492a9e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/pushover.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/python.svg b/docs/canary-checker/static/img/icons/python.svg
new file mode 100644
index 00000000..75a63773
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/python.svg
@@ -0,0 +1,17 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/question.svg b/docs/canary-checker/static/img/icons/question.svg
new file mode 100644
index 00000000..d5071ebf
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/question.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/rabbitmq.svg b/docs/canary-checker/static/img/icons/rabbitmq.svg
new file mode 100644
index 00000000..2a1f557f
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/rabbitmq.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/rancher.svg b/docs/canary-checker/static/img/icons/rancher.svg
new file mode 100644
index 00000000..a0d050b6
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/rancher.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/redhat.svg b/docs/canary-checker/static/img/icons/redhat.svg
new file mode 100644
index 00000000..220fd628
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/redhat.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/redis.svg b/docs/canary-checker/static/img/icons/redis.svg
new file mode 100644
index 00000000..27a84df7
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/redis.svg
@@ -0,0 +1,15 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/remove-firewall.svg b/docs/canary-checker/static/img/icons/remove-firewall.svg
new file mode 100644
index 00000000..db5d88ee
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/remove-firewall.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/restic.svg b/docs/canary-checker/static/img/icons/restic.svg
new file mode 100644
index 00000000..89b29c0e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/restic.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/rocket.svg b/docs/canary-checker/static/img/icons/rocket.svg
new file mode 100644
index 00000000..89da858f
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/rocket.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/s3.svg b/docs/canary-checker/static/img/icons/s3.svg
new file mode 100644
index 00000000..d4e5b10e
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/s3.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/scripting.svg b/docs/canary-checker/static/img/icons/scripting.svg
new file mode 100644
index 00000000..cc99b7ed
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/scripting.svg
@@ -0,0 +1,38 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/service-now.svg b/docs/canary-checker/static/img/icons/service-now.svg
new file mode 100644
index 00000000..8330ff40
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/service-now.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/sftp.svg b/docs/canary-checker/static/img/icons/sftp.svg
new file mode 100644
index 00000000..97ca7e80
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/sftp.svg
@@ -0,0 +1,4 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/shield.svg b/docs/canary-checker/static/img/icons/shield.svg
new file mode 100644
index 00000000..27767aa0
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/shield.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/slack.svg b/docs/canary-checker/static/img/icons/slack.svg
new file mode 100644
index 00000000..1802195d
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/slack.svg
@@ -0,0 +1,13 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/smb.svg b/docs/canary-checker/static/img/icons/smb.svg
new file mode 100644
index 00000000..bd06ea63
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/smb.svg
@@ -0,0 +1,11 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/sms.svg b/docs/canary-checker/static/img/icons/sms.svg
new file mode 100644
index 00000000..5ad74920
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/sms.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/spring.svg b/docs/canary-checker/static/img/icons/spring.svg
new file mode 100644
index 00000000..847b4374
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/spring.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/ssl.svg b/docs/canary-checker/static/img/icons/ssl.svg
new file mode 100644
index 00000000..d3e90455
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/ssl.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/swagger.svg b/docs/canary-checker/static/img/icons/swagger.svg
new file mode 100644
index 00000000..f8b5c3b0
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/swagger.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/teams.svg b/docs/canary-checker/static/img/icons/teams.svg
new file mode 100644
index 00000000..84f6b46a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/teams.svg
@@ -0,0 +1,100 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/telegram.svg b/docs/canary-checker/static/img/icons/telegram.svg
new file mode 100644
index 00000000..6f88d42b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/telegram.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/icons/terraform.svg b/docs/canary-checker/static/img/icons/terraform.svg
new file mode 100644
index 00000000..2db97d21
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/terraform.svg
@@ -0,0 +1,7 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/trivy.svg b/docs/canary-checker/static/img/icons/trivy.svg
new file mode 100644
index 00000000..0e808ee8
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/trivy.svg
@@ -0,0 +1,8 @@
+
diff --git a/docs/canary-checker/static/img/icons/user.svg b/docs/canary-checker/static/img/icons/user.svg
new file mode 100644
index 00000000..caa7159b
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/user.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/vault.svg b/docs/canary-checker/static/img/icons/vault.svg
new file mode 100644
index 00000000..87be266a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/vault.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/vsphere.svg b/docs/canary-checker/static/img/icons/vsphere.svg
new file mode 100644
index 00000000..3211cb48
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/vsphere.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/webhook.svg b/docs/canary-checker/static/img/icons/webhook.svg
new file mode 100644
index 00000000..f67934f9
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/webhook.svg
@@ -0,0 +1,8 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/world.svg b/docs/canary-checker/static/img/icons/world.svg
new file mode 100644
index 00000000..24997f76
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/world.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/www.svg b/docs/canary-checker/static/img/icons/www.svg
new file mode 100644
index 00000000..ff7fb9dc
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/www.svg
@@ -0,0 +1,6 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/xml.svg b/docs/canary-checker/static/img/icons/xml.svg
new file mode 100644
index 00000000..dcfd4dcf
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/xml.svg
@@ -0,0 +1,85 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/yaml.svg b/docs/canary-checker/static/img/icons/yaml.svg
new file mode 100644
index 00000000..bda45910
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/yaml.svg
@@ -0,0 +1,46 @@
+
+
diff --git a/docs/canary-checker/static/img/icons/zulip.svg b/docs/canary-checker/static/img/icons/zulip.svg
new file mode 100644
index 00000000..7343b55a
--- /dev/null
+++ b/docs/canary-checker/static/img/icons/zulip.svg
@@ -0,0 +1,16 @@
+
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/infrastructure-check.png b/docs/canary-checker/static/img/infrastructure-check.png
new file mode 100644
index 00000000..e5da20e6
Binary files /dev/null and b/docs/canary-checker/static/img/infrastructure-check.png differ
diff --git a/docs/canary-checker/static/img/metrics-exporter.png b/docs/canary-checker/static/img/metrics-exporter.png
new file mode 100644
index 00000000..bcf66d43
Binary files /dev/null and b/docs/canary-checker/static/img/metrics-exporter.png differ
diff --git a/docs/canary-checker/static/img/metrics-exporter2.png b/docs/canary-checker/static/img/metrics-exporter2.png
new file mode 100644
index 00000000..d0ef5d3f
Binary files /dev/null and b/docs/canary-checker/static/img/metrics-exporter2.png differ
diff --git a/docs/canary-checker/static/img/mission-control-logo-350.svg b/docs/canary-checker/static/img/mission-control-logo-350.svg
new file mode 100644
index 00000000..85e48dac
--- /dev/null
+++ b/docs/canary-checker/static/img/mission-control-logo-350.svg
@@ -0,0 +1,68 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/mission-control-logo.svg b/docs/canary-checker/static/img/mission-control-logo.svg
new file mode 100644
index 00000000..85eb88fb
--- /dev/null
+++ b/docs/canary-checker/static/img/mission-control-logo.svg
@@ -0,0 +1,66 @@
+
+
\ No newline at end of file
diff --git a/docs/canary-checker/static/img/postgres-check.png b/docs/canary-checker/static/img/postgres-check.png
new file mode 100644
index 00000000..58a2a67b
Binary files /dev/null and b/docs/canary-checker/static/img/postgres-check.png differ
diff --git a/docs/canary-checker/static/img/trace-screenshot.png b/docs/canary-checker/static/img/trace-screenshot.png
new file mode 100644
index 00000000..2c9ceca3
Binary files /dev/null and b/docs/canary-checker/static/img/trace-screenshot.png differ
diff --git a/docs/canary-checker/tailwind.config.js b/docs/canary-checker/tailwind.config.js
new file mode 100644
index 00000000..b7e3aea9
--- /dev/null
+++ b/docs/canary-checker/tailwind.config.js
@@ -0,0 +1,12 @@
+module.exports = {
+ purge: ['./src/**/*.html', './src/**/*.js', './src/**/*.tsx'],
+ corePlugins: { preflight: false },
+ // important: '#tailwind',
+ theme: {
+ extend: {
+ maxWidth: {
+ xxs: '18rem',
+ },
+ },
+ },
+};
diff --git a/docs/canary-checker/tutorials/images/dashboard-http-pass-canary.png b/docs/canary-checker/tutorials/images/dashboard-http-pass-canary.png
deleted file mode 100644
index 68a9529e..00000000
Binary files a/docs/canary-checker/tutorials/images/dashboard-http-pass-canary.png and /dev/null differ
diff --git a/docs/config-db/tutorials/example-git-file.md b/docs/config-db/tutorials/example-git-file.md
index a1568c19..7ab47168 100644
--- a/docs/config-db/tutorials/example-git-file.md
+++ b/docs/config-db/tutorials/example-git-file.md
@@ -20,7 +20,7 @@ metadata:
spec:
interval: 40
http:
- - endpoint: http://status.savanttools.com/?code=200
+ - url: https://httpbin.demo.aws.flanksource.com/status/200
name: sample-check
thresholdMillis: 3000
responseCodes: [201, 200, 301]
diff --git a/docs/http-212dcd5f1d.png b/docs/http-212dcd5f1d.png
new file mode 100644
index 00000000..a15bd076
Binary files /dev/null and b/docs/http-212dcd5f1d.png differ
diff --git a/docs/snippets/http.yaml b/docs/snippets/http.yaml
new file mode 100644
index 00000000..d8375fbb
--- /dev/null
+++ b/docs/snippets/http.yaml
@@ -0,0 +1,22 @@
+apiVersion: canaries.flanksource.com/v1
+kind: Canary
+metadata:
+ name: http-check
+spec:
+ interval: 30
+ http:
+ - url: https://httpbin.demo.aws.flanksource.com/status/200
+ thresholdMillis: 3000
+ responseCodes: [201, 200, 301]
+ responseContent: ""
+ maxSSLExpiry: 7
+ - url: https://httpbin.demo.aws.flanksource.com/status/404
+ thresholdMillis: 3000
+ responseCodes: [404]
+ responseContent: ""
+ maxSSLExpiry: 7
+ - url: https://httpbin.demo.aws.flanksource.com/status/500
+ thresholdMillis: 3000
+ responseCodes: [500]
+ responseContent: ""
+ maxSSLExpiry: 7
diff --git a/docs/topology/common/selector.md b/docs/topology/common/selector.md
index d7aff4d2..355531f5 100644
--- a/docs/topology/common/selector.md
+++ b/docs/topology/common/selector.md
@@ -25,7 +25,7 @@ The examples shown below show the possible use cases
schedule: "@every 1m"
http:
- name: http-pass
- endpoint: http://status.savanttools.com/?code=202
+ url: https://httpbin.demo.aws.flanksource.com/status/202
responseCodes:
- 202
name: http-component-canary
@@ -34,7 +34,7 @@ The examples shown below show the possible use cases
schedule: "@every 1m"
http:
- name: http-202
- endpoint: http://status.savanttools.com/?code=201
+ url: https://httpbin.demo.aws.flanksource.com/status/201
responseCodes:
- 202
name: second-inline-canary
@@ -59,11 +59,12 @@ The examples shown below show the possible use cases
- labelSelector: "canary=http-check"
- inline:
- http:
- endpoint: "http://status.savanttools.com/?code=200"
+ endpoint: ""
test:
expr: 'code == 200'
name: selector
type: aggregator
+
```
| Field | Description | Scheme | Required |
diff --git a/docs/topology/concepts/health-checks.md b/docs/topology/concepts/health-checks.md
index 0bb5183b..5598c035 100644
--- a/docs/topology/concepts/health-checks.md
+++ b/docs/topology/concepts/health-checks.md
@@ -14,8 +14,6 @@ Health checks can be associated in 2 ways:
### Selector
-
-
```yaml
apiVersion: canaries.flanksource.com/v1
kind: SystemTemplate
@@ -40,7 +38,7 @@ metadata:
spec:
interval: 30
- name: inline-check
- endpoint: http://status.savanttools.com/?code=202
+ url: https://httpbin.demo.aws.flanksource.com/status/202
responseCodes:
- 202
```
@@ -71,7 +69,7 @@ spec:
- inline:
http:
- name: inline-check
- endpoint: http://status.savanttools.com/?code=202
+ url: https://httpbin.demo.aws.flanksource.com/status/202
responseCodes:
- 202
name: inline-canary
diff --git a/docs/topology/overview.md b/docs/topology/overview.md
index bc55df83..01fe0c97 100644
--- a/docs/topology/overview.md
+++ b/docs/topology/overview.md
@@ -1,9 +1,8 @@
-
+---
+---
# Topology
-
-
Topology is a way for you to describe the different parts of your infrastructure, like servers, databases, applications, or any other elements that make up your system, in a structured way. It is represented as a tree-like structure where the nodes are called Components.
diff --git a/docs/topology/references/http.md b/docs/topology/references/http.md
deleted file mode 100644
index 9b91f92a..00000000
--- a/docs/topology/references/http.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# HTTP
-
-This check performs queries on HTTP endpoints, and HTTP Namespaces to monitor their activity.
-
-```yaml
-apiVersion: canaries.flanksource.com/v1
-kind: Canary
-metadata:
- name: http-check
-spec:
- interval: 30
- http:
- - endpoint: http://status.savanttools.com/?code=200
- thresholdMillis: 3000
- responseCodes: [201, 200, 301]
- responseContent: ""
- maxSSLExpiry: 7
- - endpoint: http://status.savanttools.com/?code=404
- thresholdMillis: 3000
- responseCodes: [404]
- responseContent: ""
- maxSSLExpiry: 7
- - endpoint: http://status.savanttools.com/?code=500
- thresholdMillis: 3000
- responseCodes: [500]
- responseContent: ""
- maxSSLExpiry: 7
-```
-
-| Field | Description | Scheme | Required |
-| ----- | ----------- | ------ | -------- |
-| `authentication` | Credentials for authentication headers | [*Authentication*](../concepts/authentication.md) | |
-| `body` | Request Body Contents | *string* | |
-| `description` | Description for the check | *string* | |
-| `display` | template to display server response in text (overrides default bar format for UI) | [*Template*](../concepts/templating.md) | |
-| **`endpoint`** | HTTP endpoint to check. Mutually exclusive with Namespace | *string* | Yes |
-| `headers` | Header fields to be used in the query | [*kommons.EnvVar*](https://pkg.go.dev/github.com/flanksource/kommons#EnvVar) | |
-| `icon` | Icon for overwriting default icon on the dashboard | *string* | |
-| `method` | Method to use - defaults to GET | *string* | |
-| `name` | Name of the check | *string* | |
-| `ntlm` | NTLM when set to true will do authentication using NTLM v1 protocol | *bool* | |
-| `ntlmv2` | NTLM when set to true will do authentication using NTLM v2 protocol | *bool* | |
diff --git a/docs/topology/references/http.mdx b/docs/topology/references/http.mdx
new file mode 100644
index 00000000..09038aeb
--- /dev/null
+++ b/docs/topology/references/http.mdx
@@ -0,0 +1,57 @@
+# HTTP
+
+This check performs queries on HTTP endpoints, and HTTP Namespaces to monitor their activity.
+
+export default function Highlight({ children, color }) {
+ return (
+
+ `
+| **Connection** | | | |
+| `connection` | Path of existing connection e.g. `connection://sftp/instance`/ Mutually exclusive with `username`, `password` | [Connection](../../concepts/connections) | |
+| `username` | Mutually exclusive with `connection` | [_EnvVar_](../../concepts / authentication / #envvar) | |
+| `password` | Mutually exclusive with `connection` | [_EnvVar_](../../concepts / authentication / #envvar) | |
+| **`url`** | HTTP URL, if a URL is specified on both the connection and check, the url on the check takes precedence. | _string_ | Yes |
+| `ntlm` | When true will do authentication using NTLM v1 protocol | _bool_ | |
+| `ntlmv2` | When true will do authentication using NTLM v2 protocol | _bool_ | |
+ `
+ );
+
+