Skip to content

Commit

Permalink
chore: format and bump submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
adityathebe committed Dec 26, 2024
1 parent 2f1ead8 commit 9ed43a1
Show file tree
Hide file tree
Showing 40 changed files with 251 additions and 286 deletions.
1 change: 1 addition & 0 deletions canary-checker/docs/comparisons/blackbox-exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Blackbox Exporter
sidebar_custom_props:
icon: prometheus
---

# 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.
Expand Down
1 change: 1 addition & 0 deletions canary-checker/docs/comparisons/kuberhealthy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
draft: true
---

### Kuberhealthy

https://github.com/kuberhealthy/kuberhealthy
Expand Down
1 change: 1 addition & 0 deletions canary-checker/docs/concepts/performance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
draft: true
---

## Disable Check Status Aggregation

jobs.AggregateCheckStatuses1h.disable=true
Expand Down
105 changes: 50 additions & 55 deletions canary-checker/docs/helm.canary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,81 +5,76 @@ sidebar_class_name: hidden-mission-control
slug: /guide/canary-checker/helm
---



import Schema from '@site/modules/canary-checker/chart/values.schema.json'


# Quick Start

The recommended method for installing Canary Checker is using [helm](https://helm.sh/)

1. Install [canary-checker](https://github.com/flanksource/canary-checker) helm chart

<Helm chart="canary-checker"
schema={Schema}
namespace="canary-checker"
values={{
"global.ui.host": "canary-checker.127.0.0.1.nip.io",
}}
/>
<Helm chart="canary-checker"
schema={Schema}
namespace="canary-checker"
values={{
"global.ui.host": "canary-checker.127.0.0.1.nip.io",
}}
/>

:::info
Note the default installation of canary-checker uses an embedded postgres database and does not persist history, see: [Database](database)
:::
:::info
Note the default installation of canary-checker uses an embedded postgres database and does not persist history, see: [Database](database)
:::

1. Create a canary

```bash
cat <<EOF | kubectl apply -f -
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: http-check
spec:
interval: 30
http:
- name: http pass response 200 status code
url: https://httpbin.demo.aws.flanksource.com/status/200
EOF
```
<p/>
1. Check the results via the [CLI](./cli)
```bash
cat <<EOF | kubectl apply -f -
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: http-check
spec:
interval: 30
http:
- name: http pass response 200 status code
url: https://httpbin.demo.aws.flanksource.com/status/200
EOF
```
<p/>
1. Check the results via the [CLI](./cli)
<TerminalOutput command="kubectl get canary" >
NAME INTERVAL STATUS LAST CHECK UPTIME 1H LATENCY 1H LAST TRANSITIONED
http-check 30 Passed 13s 18/18 (100.0%) 480ms 13s
</TerminalOutput>
<TerminalOutput command="kubectl get canary" >
NAME INTERVAL STATUS LAST CHECK UPTIME 1H LATENCY 1H LAST TRANSITIONED
http-check 30 Passed 13s 18/18 (100.0%) 480ms 13s
</TerminalOutput>
1. Access the dashboard
You can access the web [dashboard](http://localhost:8080) by forwarding the port:
<TerminalOutput command="kubectl -n canary-checker port-forward svc/canary-checker-ui 8080:80" >
&nbsp;
</TerminalOutput>
<Screenshot shadow={false} img="/img/health-checks.png" alt="Canary Checker Dashboard"/>
You can access the web [dashboard](http://localhost:8080) by forwarding the port:
<TerminalOutput command="kubectl -n canary-checker port-forward svc/canary-checker-ui 8080:80" >
&nbsp;
</TerminalOutput>
<Screenshot shadow={false} img="/img/health-checks.png" alt="Canary Checker Dashboard"/>
:::tip
:::tip
To deploy an ingress for the dashboard, update the `values.yaml`:
To deploy an ingress for the dashboard, update the `values.yaml`:
```yaml
flanksource-ui:
enabled: true
ingress:
annotations:
kubernetes.io/tls-acme: 'true'
host: <DOMAIN>
tls:
- hosts:
- <DOMAIN>
secretName: ingress-tls
```
```yaml
flanksource-ui:
enabled: true
ingress:
annotations:
kubernetes.io/tls-acme: 'true'
host: <DOMAIN>
tls:
- hosts:
- <DOMAIN>
secretName: ingress-tls
```
:::
:::
2 changes: 0 additions & 2 deletions canary-checker/docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_custom_props:
icon: codicon:pass
---



import DocCardList from '@theme/DocCardList';

<DocCardList />
1 change: 1 addition & 0 deletions canary-checker/docs/scripting/jsonpath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
draft: true
---

Testing JSONPath expressions:

```
Expand Down
12 changes: 3 additions & 9 deletions mission-control/blog/canary-checker-v1.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ tags: [release, canary-checker]
hide_table_of_contents: false
---


<!--truncate-->

We are happy to announce the latest release of canary-checker, the highlight of which is Kubernetes resource checker that enables continuous testing of Crossplane, Helm, Flux and other K8s resources.

## Checks

- ⛰️`kubernetes`, `kubernetesResource` - Added support for external `kubeconfig`
- ⛰️ `kubernetesResource` - Improved the speed of deleting Kubernetes resources
- ⛰️ `http`, `prometheus` - Added OAuth and TLS Client options
- ⛰️ `http`, `prometheus` - Added OAuth and TLS Client options
- ⛰️ `http` - Support templating `url` from env vars
- ⛰️ `aws*` - Added support for assumeRole
- 🐛 `webhook` - Fixed webhook handling and added 📚 example for githubstatus.com
Expand Down Expand Up @@ -42,19 +42,13 @@ We are happy to announce the latest release of canary-checker, the highlight of
- ⛰️ Added [`jq`](/reference/scripting/cel#jq)
- ⛰️ Added support for custom delimiters using `# gotemplate: left-delim=$[[ right-delim=]]`


## Breaking

- Removed `configDb` check, Use `catalog` (Config DB) instead
- Removed `configDb` check, Use `catalog` (Config DB) instead
- Removed `ec2` check, Use `kubernetesResource` with Crossplane or ACK instead


## New Contributors ❤️


Big thanks to our contributors: [@nalshamaajc](https://github.com/nalshamaajc), [@bosunski](https://github.com/bosunski), [@DanielCastronovo](https://github.com/DanielCastronovo), [@dmorrowjc](https://github.com/dmorrowjc), [@RaymiiOrg](https://github.com/RaymiiOrg), [@fullykubed](https://github.com/fullykubed), [@krohrsb](https://github.com/krohrsb), [@sosheskaz](https://github.com/sosheskaz), [@PrestonCS](https://github.com/PrestonCS), [@miry](https://github.com/miry), [@oc-christopher-billett](https://github.com/oc-christopher-billett), [@LarsFronius](https://github.com/LarsFronius), [@christianshub](https://github.com/christianshub), [@EugeneBad](https://github.com/EugeneBad)

<img src="https://contrib.rocks/image?repo=flanksource/canary-checker" className="pt-10" />



1 change: 0 additions & 1 deletion mission-control/docs/guide/config-db/concepts/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Changes
sidebar_custom_props:
icon: octicon:diff-16

---

When you save a config item to Config DB, it tracks its changes. These changes come from external sources like Kubernetes events or Azure activities. Alternatively, Mission Control can automatically detect changes by comparing the old config with the new one.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Health & Status
sidebar_custom_props:
icon: mdi-light:heart

---

Each config item has attributes used to determine the health and status of an item.
Expand Down
1 change: 0 additions & 1 deletion mission-control/docs/guide/config-db/concepts/transform.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Transformation
sidebar_custom_props:
icon: hugeicons:code

---

Transformations allow you to modify scraped config items before they are saved, common use cases include:
Expand Down
20 changes: 10 additions & 10 deletions mission-control/docs/guide/config-db/scrapers/_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

Custom scrapers require defining the `id`, `type`, and `class` for each scraped item. For example, when scraping a file containing a JSON array, where each array element represents a config item, you need to specify the `id`, `type`, and config `class` for these items. Achieve this by utilizing mappings in your custom scraper configuration.

| Field | Description | Scheme | Required |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------- |
| Field | Description | Scheme | Required |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------- |
| `items` | A path pointing to an array, each item is created as a separate config item, all other JSONPath is evaluated from the new items root | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | `true` |
| `id` | ID for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | `true` |
| `type` | Type for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | `true` |
| `class` | Class for the config item. _(Defaults to `type`)_ | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | |
| `name` | Name for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | |
| `format` | Format of the config source. Defaults to `json` | `json`, `xml` or `properties` See [Formats](#formats) | |
| `createFields` | Fields to use to determine the items created date, if not specified or the field is not found, defaults to scrape time | <CommonLink to="jsonpath">_`[]JSONPath`_</CommonLink> | |
| `id` | ID for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | `true` |
| `type` | Type for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | `true` |
| `class` | Class for the config item. _(Defaults to `type`)_ | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | |
| `name` | Name for the config item | <CommonLink to="jsonpath">_`JSONPath`_</CommonLink> | |
| `format` | Format of the config source. Defaults to `json` | `json`, `xml` or `properties` See [Formats](#formats) | |
| `createFields` | Fields to use to determine the items created date, if not specified or the field is not found, defaults to scrape time | <CommonLink to="jsonpath">_`[]JSONPath`_</CommonLink> | |
| `deleteFields` | Fields to use to determine when an item was deleted if not specified or the field is not found, defaults to scrape time of when the item is no longer detected | <CommonLink to="jsonpath">_`[]JSONPath`_</CommonLink> | |
| `timestampFormat` | Timestamp format of `createFields` and `deleteFields`. _(Default 2006-01-02T15:04:05Z07:00)_ | [`time.Format`](https://golang.org/pkg/time/#Time.Format) | |
| `full` | Scrape result includes the full metadata of a config, including possible changes, See [Change Extraction](#change-extraction) | `bool` | |
| `timestampFormat` | Timestamp format of `createFields` and `deleteFields`. _(Default 2006-01-02T15:04:05Z07:00)_ | [`time.Format`](https://golang.org/pkg/time/#Time.Format) | |
| `full` | Scrape result includes the full metadata of a config, including possible changes, See [Change Extraction](#change-extraction) | `bool` | |

## Formats

Expand Down
10 changes: 5 additions & 5 deletions mission-control/docs/guide/config-db/scrapers/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ The registry has an [AWS](/registry/aws) Helm chart that provides a pre-configur

```

| Field | Description | Scheme | Required |
| ----------- | ---------------------------------------------------------------------------- | -------------------------------------------- | -------- |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | [Cron](/reference/types#cron) | |
| Field | Description | Scheme | Required |
| ----------- | ---------------------------------------------------------------------------- | -------------------------------------------------- | -------- |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | [Cron](/reference/types#cron) | |
| `retention` | Settings for retaining changes, analysis and scraped items | [`Retention`](/guide/config-db/concepts/retention) | |
| `aws` | Specifies the list of AWS configurations to scrape. | [`[]AWS`](#aws) | |
| `aws` | Specifies the list of AWS configurations to scrape. | [`[]AWS`](#aws) | |

### AWS

Expand All @@ -35,7 +35,7 @@ The registry has an [AWS](/registry/aws) Helm chart that provides a pre-configur
| `exclude` | AWS resources to exclude from scraping | `[]string` | |
| `include` | AWS resources to include for scraping | `[]string` | |
| `properties` | Custom templatable properties for the scraped config items. | [`[]ConfigProperty`](/reference/config-db/properties) | |
| `transform` | Field to transform result | [`Transform`](/guide/config-db/concepts/transform) | |
| `transform` | Field to transform result | [`Transform`](/guide/config-db/concepts/transform) | |
| `tags` | set custom tags on the scraped config items | `map[string]string` | |

## CloudTrail
Expand Down
12 changes: 6 additions & 6 deletions mission-control/docs/guide/config-db/scrapers/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ The Azure scrapers scrapes your azure account to fetch all the resources & save

## Scraper

| Field | Description | Scheme | Required |
| ----------- | ---------------------------------------------------------------------------- | -------------------------------------------- | -------- |
| `logLevel` | Specify the level of logging. | `string` | |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | `string` | |
| Field | Description | Scheme | Required |
| ----------- | ---------------------------------------------------------------------------- | -------------------------------------------------- | -------- |
| `logLevel` | Specify the level of logging. | `string` | |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | `string` | |
| `retention` | Settings for retaining changes, analysis and scraped items | [`Retention`](/guide/config-db/concepts/retention) | |
| `azure` | Azure scrape config | [`[]Azure`](#azure) | |
| `azure` | Azure scrape config | [`[]Azure`](#azure) | |

### Azure

Expand All @@ -38,7 +38,7 @@ The Azure scrapers scrapes your azure account to fetch all the resources & save
| `clientSecret` | Microsoft Entra ID app client secret | <CommonLink to="secrets">_EnvVar_</CommonLink> | |
| `exclusions` | Specifies the Azure projects to scrape | [`Exclusion`](#exclusion) | |
| `properties` | Custom templatable properties for the scraped config items. | [`[]ConfigProperty`](/reference/config-db/properties) | |
| `transform` | Field to transform result | [`Transform`](/guide/config-db/concepts/transform) | |
| `transform` | Field to transform result | [`Transform`](/guide/config-db/concepts/transform) | |
| `tags` | Set custom tags on the scraped config items | `map[string]string` | |

:::note
Expand Down
Loading

0 comments on commit 9ed43a1

Please sign in to comment.