Skip to content

Commit 6305595

Browse files
moshloopmoshloop
authored
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
1 parent 7c505f4 commit 6305595

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+367
-478
lines changed

‎.gitmodules

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
[submodule "mission-control/modules/canary-checker"]
2-
path = mission-control/modules/canary-checker
3-
url = https://github.com/flanksource/canary-checker.git
1+
[submodule "mission-control/canary-checker/canary-checker"]
2+
path = mission-control/canary-checker/canary-checker
3+
url = https://github.com/flanksource/canary-checker
44
[submodule "mission-control/modules/config-db"]
55
path = mission-control/modules/config-db
66
url = https://github.com/flanksource/config-db.git
77
[submodule "mission-control/modules/mission-control"]
88
path = mission-control/modules/mission-control
99
url = https://github.com/flanksource/mission-control.git
10-
[submodule "mission-control/canary-checker/canary-checker"]
11-
path = mission-control/canary-checker/canary-checker
10+
[submodule "mission-control/modules/canary-checker"]
11+
path = mission-control/modules/canary-checker
1212
url = https://github.com/flanksource/canary-checker

‎.markdownlint.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"MD033": false,
3+
"MD004": false,
4+
"MD045": false,
5+
"MD013": false,
6+
"MD012": false,
7+
"MD024": false,
8+
"MD040": false
9+
}

‎canary-checker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Metrics exposed by. anary-checler
140140

141141
| Metric | Type | Description |
142142
| ---------------------------------------------- | --------- | ------------------------------------------- |
143-
| canary_check | Guage | Set to 0 when passing and 1 when failing |
143+
| canary_check | Gauge | Set to 0 when passing and 1 when failing |
144144
| canary_check_success_count | Counter | |
145145
| canary_check_failed_count | Counter | |
146146
| canary_check_info | Info | |

‎canary-checker/docs/comparisons/blackbox-exporter.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# Canary-Checker vs Prometheus blackbox exporter
22

3-
4-
53
[Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) is a prometheus exporter for probing HTTP, HTTPS, DNS, TCP, ICMP and gRPC.
64

7-
85
| | Blackbox Exporter | Canary Checker |
96
| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
107
| Prometheus Exporter | Yes | Yes |
@@ -22,8 +19,7 @@
2219
| Secrets | Via [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) | |
2320
| **Check Types** | | |
2421
| Synthetic | No | Builtin check types for any test exporting JUnit test results e.g. (k6, playwright, robot, postman, etc) |
25-
| Infrastructre | No | Verify the ability to launch new pods, create new EC2 instances or push and pull from docker / helm / git repositories |
22+
| Infrastructure | No | Verify the ability to launch new pods, create new EC2 instances or push and pull from docker / helm / git repositories |
2623
| Backup | No | Check backups via Restic, S3, SMB, SFTP, GCS |
2724
| Compliance | No | AWS Config Rules, Flanksource Config DB |
2825
| Alert Aggregation | No | Alert Manager, AWS Cloudwatch, Dynatrace |
29-

‎canary-checker/docs/concepts/grafana.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Default grafana dashboards are available. After you deploy Grafana, these dashbo
1010

1111
![](/img/grafana-dashboard.png)
1212

13-
14-
1513
### Prometheus
1614

1715
The helm chart can install a `ServiceMonitor` for the prometheus operator, by enabling the serviceMonitor flag

‎canary-checker/docs/concepts/image-variants.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎canary-checker/docs/concepts/metrics-exporter.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ metadata:
140140
```
141141
142142
This snippet will retrieve the `last_result.results.max` value from the last execution ensuring data is not duplicated or missed
143+
143144
```go
144145
"@timestamp" : {
145146
{{- if last_result.results.max }}
@@ -183,7 +184,7 @@ The max value is saved in the `transform` section using:
183184
| `valueExpr` | An expression to derive the header value from | `Expression` | |
184185
| `labels` | Labels for prometheus metric (values can be templated) | `map[string]string` | |
185186

186-
Expresions can make use of the following variables:
187+
Expressions can make use of the following variables:
187188

188189
### **Expression Variables**
189190

@@ -194,7 +195,7 @@ Expresions can make use of the following variables:
194195
| `check.name` | Check name | `string` |
195196
| `check.description` | Check description | `string` |
196197
| `check.labels` | Dynamic labels attached to the check | `map[string]string` |
197-
| `check.endpoint` | Endpoint (usally a URL) | `string` |
198+
| `check.endpoint` | Endpoint (usually a URL) | `string` |
198199
| `check.duration` | Duration in milliseconds | `int64` |
199200
| `canary.name` | Canary name | `string` |
200201
| `canary.namespace` | Canary namespace | `string` |

‎canary-checker/docs/concepts/secret-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ rules:
186186

187187
:::
188188

189-
# Recommendations
189+
## Recommendations
190190

191191
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.
192192
You may consider the following for your encryption and security needs:

‎canary-checker/docs/examples/newman.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ spec:
3232
command: ["/start.sh"]
3333
```
3434
35-
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.
35+
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.
3636

3737
```bash title="start.sh"
3838
set -x

‎canary-checker/docs/examples/playwright.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ spec:
3232
command: ["/start.sh"]
3333
```
3434
35-
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.
35+
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.
3636

3737
```bash title="start.sh"
3838
mkdir -p /tmp/junit-results

0 commit comments

Comments
 (0)