diff --git a/docs/canary-checker/docs/comparisons/blackbox-exporter.md b/docs/canary-checker/docs/comparisons/blackbox-exporter.md new file mode 100644 index 00000000..208f7e72 --- /dev/null +++ b/docs/canary-checker/docs/comparisons/blackbox-exporter.md @@ -0,0 +1,29 @@ +# 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 | +| Internal DB | No | Runs with an embedded postgres database, making it possible to monitor prometheus itself | +| Check types | HTTP, ICMP, DNS, TCP, gRPC | 30+ | +| Custom Metrics | No | Create custom metrics from HTTP / SQL / Elasticsearch / etc queries | +| Exports | Metrics and labels only | Metrics, labels and error messages | +| Run in CI/CD | No | Run as a CLI for rapid feedback loops and export JUnit results in CI pipelines | +| Cron | No | Stop running checks when environments are shut down, or after hours | +| Scripting | No | Evaluate the health of a response using CEL, Javascript, Go Templates | +| **Kubernetes** | | | +| CRDs | Via [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) | Yes | +| Conditions | No | Status conditions enable canaries to be used as health checks in Helm, Flux, and Argo | +| Events | No | Kubernetes events are fired on failure | +| 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 | +| 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/docs/canary-checker/docs/getting-started.md b/docs/canary-checker/docs/getting-started.md index a0d45a01..7545cb5e 100644 --- a/docs/canary-checker/docs/getting-started.md +++ b/docs/canary-checker/docs/getting-started.md @@ -5,7 +5,7 @@ ```bash helm repo add flanksource https://flanksource.github.io/charts helm repo update - helm install canary-checker flanksource/canary-checker -n "canary-checker" + helm install canary-checker flanksource/canary-checker -n "canary-checker" --create-namespace ``` 2. Create a new check diff --git a/docs/canary-checker/docs/helm.md b/docs/canary-checker/docs/helm.md index e011d9ef..14485a76 100644 --- a/docs/canary-checker/docs/helm.md +++ b/docs/canary-checker/docs/helm.md @@ -7,32 +7,24 @@ image: /static/img/icons/helm.svg The recommended method for installing Canary Checker is using [helm](https://helm.sh/) -### 1. Install Helm - -The following steps will install the latest version of helm - -```bash -curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 -chmod 700 get_helm.sh -./get_helm.sh -``` - -### 2. Add the Flanksource helm repository +### 1. Add the Flanksource helm repository ```bash helm repo add flanksource https://flanksource.github.io/charts helm repo update ``` -### 3. Deploy Canary Checker using Helm +### 2. Deploy Canary Checker using Helm To install into a new `canary-checker` namespace, run ```bash -helm install canary-checker \ - --wait \ +helm install \ + canary-checker \ + flanksource/canary-checker \ -n canary-checker \ - --create-namespace flanksource/canary-checker \ + --create-namespace \ + --wait \ -f values.yaml ``` @@ -53,7 +45,7 @@ flanksource-ui: Note the default installation of canary-checker uses an embedded postgres database and does not persist history, see: [Database](database) ::: -## 4. Create a canary +## 3. Create a canary ```bash cat < - -
-
- Canary Checker -

- Kubernetes Native Synthetic Testing Platform -

-

- -

-
- - Get started - + <> +
+ +
+
+ Canary Checker +

+ Kubernetes Native

Health Check Platform +

+

+ +

+
-
-
-
-
- canary checker +
+
+
+ canary checker +
-
+ ); } diff --git a/docs/canary-checker/src/pages/index.js b/docs/canary-checker/src/pages/index.js index 241f3ac1..20d03b51 100644 --- a/docs/canary-checker/src/pages/index.js +++ b/docs/canary-checker/src/pages/index.js @@ -7,8 +7,8 @@ function HomePage() { return (