Moshloop (#208)

* wip * chore: updates * chore: updates * chore: docs * chore: wip * chore update * chore: doc updates * chore: doc updates * chore: markdown and spelling fixes * chore: add submodules * chore: markdown fixes
flanksource · May 14, 2024 · 6305595 · 6305595
1 parent 7c505f4
commit 6305595
Show file tree

Hide file tree

Showing 64 changed files with 367 additions and 478 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,12 +1,12 @@
-[submodule "mission-control/modules/canary-checker"]
-	path = mission-control/modules/canary-checker
-	url = https://github.com/flanksource/canary-checker.git
+[submodule "mission-control/canary-checker/canary-checker"]
+	path = mission-control/canary-checker/canary-checker
+	url = https://github.com/flanksource/canary-checker
 [submodule "mission-control/modules/config-db"]
 	path = mission-control/modules/config-db
 	url = https://github.com/flanksource/config-db.git
 [submodule "mission-control/modules/mission-control"]
 	path = mission-control/modules/mission-control
 	url = https://github.com/flanksource/mission-control.git
-[submodule "mission-control/canary-checker/canary-checker"]
-	path = mission-control/canary-checker/canary-checker
+[submodule "mission-control/modules/canary-checker"]
+	path = mission-control/modules/canary-checker
 	url = https://github.com/flanksource/canary-checker
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,9 @@
+{
+    "MD033": false,
+    "MD004": false,
+    "MD045": false,
+    "MD013": false,
+    "MD012": false,
+    "MD024": false,
+    "MD040": false
+}
diff --git a/canary-checker/README.md b/canary-checker/README.md
@@ -140,7 +140,7 @@ Metrics exposed by. anary-checler
 
 | Metric                                         | Type      | Description                                 |
 | ---------------------------------------------- | --------- | ------------------------------------------- |
-| canary_check                                   | Guage     | Set to 0 when passing and 1 when failing    |
+| canary_check                                   | Gauge     | Set to 0 when passing and 1 when failing    |
 | canary_check_success_count                     | Counter   |                                             |
 | canary_check_failed_count                      | Counter   |                                             |
 | canary_check_info                              | Info      |                                             |

diff --git a/canary-checker/docs/comparisons/blackbox-exporter.md b/canary-checker/docs/comparisons/blackbox-exporter.md
@@ -1,10 +1,7 @@
 # Canary-Checker vs Prometheus blackbox exporter
 
-
-
 [Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) is a prometheus exporter for probing HTTP, HTTPS, DNS, TCP, ICMP and gRPC.
 
-
 |                     | Blackbox Exporter                                            | Canary Checker                                               |
 | ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | Prometheus Exporter | Yes                                                          | Yes                                                          |
@@ -22,8 +19,7 @@
 | Secrets             | Via [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) |                                                              |
 | **Check Types**     |                                                              |                                                              |
 | Synthetic           | No                                                           | Builtin check types for any test exporting JUnit test results e.g.  (k6, playwright, robot, postman, etc) |
-| Infrastructre       | No                                                           | Verify the ability to launch new pods, create new EC2 instances or push and pull from docker / helm / git repositories |
+| Infrastructure       | No                                                           | Verify the ability to launch new pods, create new EC2 instances or push and pull from docker / helm / git repositories |
 | Backup              | No                                                           | Check backups via Restic, S3, SMB, SFTP, GCS                 |
 | Compliance          | No                                                           | AWS Config Rules, Flanksource Config DB                      |
 | Alert Aggregation   | No                                                           | Alert Manager, AWS Cloudwatch, Dynatrace                     |
-
diff --git a/canary-checker/docs/concepts/grafana.md b/canary-checker/docs/concepts/grafana.md
@@ -10,8 +10,6 @@ Default grafana dashboards are available. After you deploy Grafana, these dashbo
 
 ![](/img/grafana-dashboard.png)
 
-
-
 ### Prometheus
 
 The helm chart can install a `ServiceMonitor` for the prometheus operator, by enabling the serviceMonitor flag

diff --git a/canary-checker/docs/concepts/image-variants.md b/canary-checker/docs/concepts/image-variants.md
diff --git a/canary-checker/docs/concepts/metrics-exporter.md b/canary-checker/docs/concepts/metrics-exporter.md
@@ -140,6 +140,7 @@ metadata:
 ```
 
 This snippet will retrieve the `last_result.results.max` value from the last execution ensuring data is not duplicated or missed
+
 ```go
  "@timestamp" : {
                     {{-  if last_result.results.max }}
@@ -183,7 +184,7 @@ The max value is saved in the `transform` section using:
 | `valueExpr` | An expression to derive the header value from          | `Expression`        |          |
 | `labels`    | Labels for prometheus metric (values can be templated) | `map[string]string` |          |
 
-Expresions can make use of the following variables:
+Expressions can make use of the following variables:
 
 ### **Expression Variables**
 
@@ -194,7 +195,7 @@ Expresions can make use of the following variables:
 | `check.name`              | Check name                                 | `string`                                  |
 | `check.description`       | Check description                          | `string`                                  |
 | `check.labels`            | Dynamic labels attached to the check       | `map[string]string`                       |
-| `check.endpoint`          | Endpoint (usally a URL)                    | `string`                                  |
+| `check.endpoint`          | Endpoint (usually a URL)                    | `string`                                  |
 | `check.duration`          | Duration in milliseconds                   | `int64`                                   |
 | `canary.name`             | Canary name                                | `string`                                  |
 | `canary.namespace`        | Canary namespace                           | `string`                                  |

diff --git a/canary-checker/docs/concepts/secret-management.md b/canary-checker/docs/concepts/secret-management.md
@@ -186,7 +186,7 @@ rules:
 
 :::
 
-# Recommendations
+## Recommendations
 
 Kubernetes Secrets are, by default, stored unencrypted in the API server's underlying data store (etcd). Anyone with API access can retrieve or modify a Secret, and so can anyone with access to etcd. With this in mind, it is recommended to implement some level of security to prevent unauthorized access to your Kubernetes secrets.
 You may consider the following for your encryption and security needs:

diff --git a/canary-checker/docs/examples/newman.mdx b/canary-checker/docs/examples/newman.mdx
@@ -32,7 +32,7 @@ spec:
             command: ["/start.sh"]
 ```
 
-By configuring newman to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formating and health evaluation.
+By configuring newman to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formatting and health evaluation.
 
 ```bash title="start.sh"
 set -x

diff --git a/canary-checker/docs/examples/playwright.mdx b/canary-checker/docs/examples/playwright.mdx
@@ -32,7 +32,7 @@ spec:
             command: ["/start.sh"]
 ```
 
-By configuring playwright to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formating and health evaluation.
+By configuring playwright to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formatting and health evaluation.
 
 ```bash title="start.sh"
 mkdir -p /tmp/junit-results

diff --git a/canary-checker/docs/health-checks.mdx b/canary-checker/docs/health-checks.mdx
@@ -1,4 +1,6 @@
 ---
+pagination_next: notifications/index
+pagination_prev: topology/index
 slug: /canary-checker
 title: Health Checks
 ---
@@ -22,7 +24,7 @@ Active infrastructure checks provision infrastructure (e.g. EC2 Instances, Kuber
 
 </Step>
 
-<Step step={3} name="Integration" style="list">
+<Step step={4} name="Integration" style="list">
 Integration checks run automated test suites using tools like Playwright, JUnit, Newman and K6 to validate end-to-end functionality across services and infrastructure.
 </Step>
 

diff --git a/canary-checker/docs/reference/1-alert-manager.mdx b/canary-checker/docs/reference/1-alert-manager.mdx
@@ -47,11 +47,6 @@ spec:
     description: "A list of alert prefix names to include",
     scheme: '[]string'
   },
-  {
-    field: "relationships",
-    description: "Link the check results to components and configs using lookup expressions.",
-    scheme: '[Relationships](#relationships)'
-  },
   {
     field: "ignore",
     description: "A list of alert prefix names to exclude",

diff --git a/canary-checker/docs/reference/1-folder.mdx b/canary-checker/docs/reference/1-folder.mdx
@@ -43,7 +43,7 @@ spec:
   {field: "minCount", description: "The minimum number of files inside the `path`", scheme: "int"},
   {field: "maxCount", description: "The maximum number of files inside the `path`, can be used in conjunction with `filter.regex` to detect error files", scheme: "int"},
   {field: "minAge", description: "The youngest age a file can be", scheme: "Duration"},
-  {field: "maxAge", description: "The oldest age a file can be, often used to check for unprocessed files or filess that have not been cleaned up", scheme: "Duration"},
+  {field: "maxAge", description: "The oldest age a file can be, often used to check for unprocessed files or files that have not been cleaned up", scheme: "Duration"},
   {field: "minSize", description: "The minimum file size, can be used to detect backups that did not upload successfully", scheme: "Size"},
   {field: "maxSize", description: "The maximim file size", scheme: "Size"}
 

diff --git a/canary-checker/docs/reference/1-git.mdx b/canary-checker/docs/reference/1-git.mdx
@@ -16,7 +16,7 @@ spec:
   schedule: "@every 1m"
   github:
     - githubToken: <token>
-     query: SELECT count(*) FROM commits WHERE author_email = '[email protected]'
+      query: SELECT count(*) FROM commits WHERE author_email = '[email protected]'
 ```
 
 <HealthCheck name="github" rows={[

diff --git a/canary-checker/docs/reference/1-http.mdx b/canary-checker/docs/reference/1-http.mdx
@@ -42,10 +42,10 @@ Result variables can be used in `test`, `display` and `transform` [expressions](
 
 | 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_     |
+| `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`              |
 
@@ -107,7 +107,7 @@ See <CommonLink to="gotemplate" anchor="escaping">Escaping variables</CommonLink
 | **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   |                                         |
+| `canary_check_http_ssl_expiry{url}`                           | Gauge   |                                         |
 
 Status class is one of `1xx`, `2xx`, `3xx`, `4xx`, `5xx`
 
@@ -120,7 +120,7 @@ Status class is one of `1xx`, `2xx`, `3xx`, `4xx`, `5xx`
 </details>
 
 
-<details summary="Transformings metrics into individual checks">
+<details summary="Transforming metrics into individual checks">
 
 <div>
 ```yaml title="metrics.yaml"   file=../../../modules/canary-checker/fixtures/minimal/metrics-transformed.yaml

diff --git a/canary-checker/docs/reference/1-kubernetes.mdx b/canary-checker/docs/reference/1-kubernetes.mdx
@@ -7,8 +7,8 @@ sidebar_class_name: popular
 
 The Kubernetes check performs requests on Kubernetes resources such as Pods to get the desired information.
 
-```yaml title="junit.yaml"  file=../../../modules/canary-checker/fixtures/k8s/kubernetes-minimal_pass.yaml
 
+```yaml title="junit.yaml"  file=../../../modules/canary-checker/fixtures/k8s/kubernetes-minimal_pass.yaml
 ```
 
 <HealthCheck name="kubernetes" edition="standard" connection="kubeconfig"  rows={[
@@ -67,8 +67,6 @@ dyn(results).all(x, k8s.isReady(x))
 <div>
 
 ```yaml title="junit.yaml"  file=../../../modules/canary-checker/fixtures/k8s/certmanager.yaml
-
 ```
-
 </div>
 </details>
diff --git a/canary-checker/docs/reference/1-prometheus.mdx b/canary-checker/docs/reference/1-prometheus.mdx
@@ -8,7 +8,7 @@ sidebar_class_name: popular
 The Prometheus Check connects to the Prometheus host, performs the desired query, and displays the results.
 
 
-```yaml title="promtheus.yaml"  file=../../../modules/canary-checker/fixtures/datasources/prometheus.yaml
+```yaml title="prometheus.yaml"  file=../../../modules/canary-checker/fixtures/datasources/prometheus.yaml
 ```
 <HealthCheck name="prometheus" connection="url" rows={[
   {field: "url", description: "Prometheus instance, if not specified in installation it is required", required: true},

diff --git a/canary-checker/docs/reference/1-redis.mdx b/canary-checker/docs/reference/1-redis.mdx
@@ -6,7 +6,7 @@ title: Redis
 
 The Redis check connects to a specified Redis database instance to check its availability.
 
-```yaml title="promtheus.yaml"  file=../../../modules/canary-checker/fixtures/datasources/redis_pass.yaml
+```yaml title="redis.yaml"  file=../../../modules/canary-checker/fixtures/datasources/redis_pass.yaml
 ```
 <HealthCheck name="redis" connection="url" rows={[
   {field: "url", description: "Redis instance", required: true},