From 69f05524e947bf14aa9a112b5a9723e1af8bbd66 Mon Sep 17 00:00:00 2001 From: Yash Mehrotra Date: Thu, 5 Sep 2024 15:11:20 +0530 Subject: [PATCH] chore: fix vale suggestions (#276) --- canary-checker/docs/database.md | 2 +- canary-checker/docs/getting-started.mdx | 5 ++- canary-checker/docs/health-checks.mc.mdx | 6 ++-- .../docs/reference/1-alert-manager.mdx | 2 +- canary-checker/docs/reference/1-exec.mdx | 7 ++-- canary-checker/docs/reference/1-folder.mdx | 4 +-- canary-checker/docs/reference/1-http.mdx | 2 +- canary-checker/docs/reference/1-icmp.mdx | 2 +- canary-checker/docs/reference/1-junit.mdx | 2 +- .../docs/reference/1-kubernetes.mdx | 2 +- canary-checker/docs/reference/1-sql.mdx | 2 +- .../docs/reference/3-containerd.mdx | 4 +-- .../docs/reference/3-gcs-database-backup.mdx | 2 +- canary-checker/docs/reference/3-namespace.mdx | 6 ++-- canary-checker/docs/reference/3-restic.mdx | 2 +- .../docs/reference/_connections.mdx | 2 +- canary-checker/docs/reference/jmeter.mdx | 2 +- canary-checker/docs/troubleshooting.mdx | 2 +- mission-control/docs/how-it-works.mdx | 4 +-- .../docs/notifications/channels/matrix.mdx | 2 +- modules/canary-checker | 2 +- modules/config-db | 2 +- modules/duty | 2 +- modules/mission-control | 2 +- styles/Flanksource/ProfanityUnlikely.yml | 1 - styles/ignore/words-with-suggestions.txt | 33 +++++++++++++++++++ 26 files changed, 67 insertions(+), 37 deletions(-) diff --git a/canary-checker/docs/database.md b/canary-checker/docs/database.md index b7a02131..beba1036 100644 --- a/canary-checker/docs/database.md +++ b/canary-checker/docs/database.md @@ -45,7 +45,7 @@ db: The helm chart creates a postgres server statefulset, with a random password and default port, along with a new database. -To specify a username and password for the chart-managed Postgres server, create a secret in the namespace that the chart will install to, named `postgres-connection`, which contains `POSTGRES_USER` and `POSTGRES_PASSWORD` keys. +To specify a username and password for the chart-managed Postgres server, create a secret in the namespace that the chart installs to, named `postgres-connection`, which contains `POSTGRES_USER` and `POSTGRES_PASSWORD` keys. ## Connecting to an existing database diff --git a/canary-checker/docs/getting-started.mdx b/canary-checker/docs/getting-started.mdx index 709b9225..8615d73f 100644 --- a/canary-checker/docs/getting-started.mdx +++ b/canary-checker/docs/getting-started.mdx @@ -80,7 +80,7 @@ The canary checker itself only presents an API. To view the data graphically, th | Parameter | Description | |------------------------------------|---------------------------------------------------------------| -| `flanksource-ui.ingress.host` | URL at which the UI will be accessed | +| `flanksource-ui.ingress.host` | URL at which the UI is accessed | | `flanksource-ui.ingress.annotations` | Map of annotations required by the ingress controller or certificate issuer | | `flanksource-ui.ingress.tls` | Map of configuration options for TLS | @@ -96,5 +96,4 @@ If you have any questions about canary checker: * File an [issue](https://github.com/flanksource/canary-checker/issues/new) - (We do provide user support via Github Issues, so don't worry if your issue a real bug or not) * [Flanksource](https://www.flanksource.com) provides both commercial support for canary checker and a SaaS offering called Mission Control. -Your feedback is always welcome! - +Your feedback is always welcome. diff --git a/canary-checker/docs/health-checks.mc.mdx b/canary-checker/docs/health-checks.mc.mdx index cd31cb3a..f4bb3c0d 100644 --- a/canary-checker/docs/health-checks.mc.mdx +++ b/canary-checker/docs/health-checks.mc.mdx @@ -9,7 +9,7 @@ title: Health Checks -Mission control provides the ability to define and run periodic health checks against services, infrastructure and applications. +Mission control provides the ability to define and run periodic health checks against services, infrastructure, and applications. Synthetic checks are periodically run by canary checker to directly test services/applications by generating requests using http, sql, mongo, redis, ldap, etc. @@ -46,14 +46,14 @@ Evaluate the health of checks using scripts in CEL, Javascript or Go Templating. ## Dashboard -The health checks page provides a high level view of the overall health of all services, infrastructure and applications. It surfaces recent failures and provides a high level latency and reliability metrics. +The health checks page provides a high level view of the overall health of all services, infrastructure, and applications. It surfaces recent failures and provides a high level latency and reliability metrics. ![](./images/canary-dashboard.png) -Health checks can be associated with components in a [topology](topology/concepts/health-checks) and will then show up in the topology card: +Health checks can be associated with components in a [topology](topology/concepts/health-checks) and then shows up in the topology card: ![](./images/topology-health-checks.png) diff --git a/canary-checker/docs/reference/1-alert-manager.mdx b/canary-checker/docs/reference/1-alert-manager.mdx index 42e3bf9a..da34d91d 100644 --- a/canary-checker/docs/reference/1-alert-manager.mdx +++ b/canary-checker/docs/reference/1-alert-manager.mdx @@ -8,7 +8,7 @@ sidebar_class_name: popular Checks [Prometheus AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) for any firing alerts. -The following example [transforms](../concepts/expressions/transforms) 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. +The following example [transforms](../concepts/expressions/transforms) the list of alerts so that each alert becomes a single check result. Without the transform the health check fails if any alerts are firing. ```yaml title="alert-manager-check.yaml" file=../../../modules/canary-checker/fixtures/datasources/alertmanager_mix.yaml apiVersion: canaries.flanksource.com/v12 diff --git a/canary-checker/docs/reference/1-exec.mdx b/canary-checker/docs/reference/1-exec.mdx index 40fcff68..806e6ac8 100644 --- a/canary-checker/docs/reference/1-exec.mdx +++ b/canary-checker/docs/reference/1-exec.mdx @@ -40,7 +40,7 @@ See [image-variants](/reference/canary-checker/image-variants) }, { field: "connections", - description: "Setup connections for the script (eg: aws credentials)", + description: "Setup connections for the script (e.g.: aws credentials)", scheme: "[`ExecConnection`](#exec-connection)", } ]}/> @@ -57,8 +57,7 @@ See [image-variants](/reference/canary-checker/image-variants) ### Exec Connection -Exec connections allow you to specify credentials for a list of CLI tools that are needed by your scripts. Eg: You can specify the AWS connection name and the credential files along with the necessary environment variables -will be setup on the host running the script. +Exec connections allow you to specify credentials for a list of CLI tools that are needed by your scripts. Eg: You can specify the AWS connection name and the credential files along with the necessary environment variables are setup on the host running the script. | Field | Description | Type | Required | | ------- | ---------------- | ------------------------------------------------------- | -------- | @@ -104,6 +103,6 @@ See [artifacts](/installation/artifacts) diff --git a/canary-checker/docs/reference/1-folder.mdx b/canary-checker/docs/reference/1-folder.mdx index 2e11455b..3cc90c7d 100644 --- a/canary-checker/docs/reference/1-folder.mdx +++ b/canary-checker/docs/reference/1-folder.mdx @@ -4,7 +4,7 @@ title: Folder # Folder -Checks the contents of a folder for size, age and count. Folder based checks are useful in a number of scenarios: +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 appropriate size - Checking that logs or other temporary files are being cleaned up @@ -43,7 +43,7 @@ spec: {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 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"} + {field: "maxSize", description: "The maximum file size", scheme: "Size"} ]}/> diff --git a/canary-checker/docs/reference/1-http.mdx b/canary-checker/docs/reference/1-http.mdx index da645806..5044a0a5 100644 --- a/canary-checker/docs/reference/1-http.mdx +++ b/canary-checker/docs/reference/1-http.mdx @@ -118,7 +118,7 @@ spec: | `metadata.labels` | _map[string]string_ | | `{fields from []env}` | any | -Variables defined in `env` will be available to template with the name that's configured on the spec. +Variables defined in `env` are available to template with the name that's configured on the spec. Eg: In the following spec, the vars `my_secret_path` and `my_secret_var`, defined in `env`, are available during templating.
diff --git a/canary-checker/docs/reference/1-icmp.mdx b/canary-checker/docs/reference/1-icmp.mdx index 696ce2e9..f72574fd 100644 --- a/canary-checker/docs/reference/1-icmp.mdx +++ b/canary-checker/docs/reference/1-icmp.mdx @@ -4,7 +4,7 @@ title: ICMP # ICMP -Performs ICMP (ping) requests for information on ICMP packet loss, duration and response. +Performs ICMP (ping) requests for information on ICMP packet loss, duration, and response. :::info Canary checker supports both `privileged` and `unprivileged` ping modes using the `PING_MODE` environment variable or `pingMode` helm value. diff --git a/canary-checker/docs/reference/1-junit.mdx b/canary-checker/docs/reference/1-junit.mdx index 9eb28644..0e402ce5 100644 --- a/canary-checker/docs/reference/1-junit.mdx +++ b/canary-checker/docs/reference/1-junit.mdx @@ -66,7 +66,7 @@ JUnit check performs a Unit test, parses the JUnit test reports in a container a | `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_ | +| `error` | Any errors encountered when running a test | _string_ | | `stdout` | Standard output produced during test | _string_ | | `stderr` | Standard error output produced during test | _string_ | diff --git a/canary-checker/docs/reference/1-kubernetes.mdx b/canary-checker/docs/reference/1-kubernetes.mdx index db97681a..fefcffce 100644 --- a/canary-checker/docs/reference/1-kubernetes.mdx +++ b/canary-checker/docs/reference/1-kubernetes.mdx @@ -15,7 +15,7 @@ The Kubernetes check performs requests on Kubernetes resources such as Pods to g {field: "kind", description: "Kubernetes object kind", scheme: 'string', required: true}, {field: "resource", description: " Queries resources related to specified Kubernetes object ", scheme: 'ResourceSelector'}, {field: "namespaceSelector", description: "Namespace of the Kubernetes object",scheme: 'ResourceSelector'}, - {field: "namespace", description: "Failing checks will be placed in this namespace, useful if you have shared namespaces"}, + {field: "namespace", description: "Failing checks are placed in this namespace, useful if you have shared namespaces"}, {field: "ignore", description: "Ignore the specified resources from the fetched resources. Can be a glob pattern.", scheme: '[]glob'}, {field: "healthy", description: "Fail the check if any resources are unhealthy", scheme: 'bool'}, {field: "ready", description: "Fail the check if any resources are not ready", scheme: 'bool'}, diff --git a/canary-checker/docs/reference/1-sql.mdx b/canary-checker/docs/reference/1-sql.mdx index 14c7c2e3..823dd012 100644 --- a/canary-checker/docs/reference/1-sql.mdx +++ b/canary-checker/docs/reference/1-sql.mdx @@ -6,7 +6,7 @@ import { AzureSqlServer} from "@flanksource/icons/mi" # SQL -This check will try to connect to a specified Postgres database, run a query against it and verify the results. +This check connects to a specified Postgres database, run a query against it and verify the results. ```yaml apiVersion: canaries.flanksource.com/v1 diff --git a/canary-checker/docs/reference/3-containerd.mdx b/canary-checker/docs/reference/3-containerd.mdx index 562baa74..6a6a3296 100644 --- a/canary-checker/docs/reference/3-containerd.mdx +++ b/canary-checker/docs/reference/3-containerd.mdx @@ -6,7 +6,7 @@ sidebar_class_name: beta # ContainerD / Docker -This check will try to pull a Docker image from specified registry using containerd and then verify its checksum and size. +This check pulls a Docker image from specified registry using containerd and then verify its checksum and size. :::note Root Privileges Required The containerd and docker health checks require access to a working socket that is mounted at runtime @@ -63,7 +63,7 @@ spec: ## Pushing images -This check will try to push a Docker image to a specified registry using containerd. +This check pushes a Docker image to a specified registry using containerd. ```yaml apiVersion: canaries.flanksource.com/v1 diff --git a/canary-checker/docs/reference/3-gcs-database-backup.mdx b/canary-checker/docs/reference/3-gcs-database-backup.mdx index aa2a7821..b128a923 100644 --- a/canary-checker/docs/reference/3-gcs-database-backup.mdx +++ b/canary-checker/docs/reference/3-gcs-database-backup.mdx @@ -24,7 +24,7 @@ spec: | Field | Description | Scheme | Required | | ------------- | ----------------------------------------------------------- | ---------------------------------------------- | -------- | | **`gcp`** | Connect to GCP project and instance | [_GCPDatabase_](#gcpdatabase) | Yes | -| **`maxAge`** | Max age for backup allowed, eg. 5h30m | _Duration_ | | +| **`maxAge`** | Max age for backup allowed, e.g. 5h30m | _Duration_ | | | **`name`** | Name of the check, must be unique within the canary | `string` | Yes | | `description` | Description for the check | `string` | | | `icon` | Icon for overwriting default icon on the dashboard | `string` | | diff --git a/canary-checker/docs/reference/3-namespace.mdx b/canary-checker/docs/reference/3-namespace.mdx index 2d2a6a14..c1428c81 100644 --- a/canary-checker/docs/reference/3-namespace.mdx +++ b/canary-checker/docs/reference/3-namespace.mdx @@ -61,15 +61,15 @@ spec: | `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* | | +| `ingressName` | Name to use for the ingress object that exposes 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* | | +| `path` | Path on which the created pod responds 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* | | +|`port` | Port on which the created pod serves 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/canary-checker/docs/reference/3-restic.mdx b/canary-checker/docs/reference/3-restic.mdx index edf37bf4..e3188f20 100644 --- a/canary-checker/docs/reference/3-restic.mdx +++ b/canary-checker/docs/reference/3-restic.mdx @@ -19,7 +19,7 @@ The Restic check: Mutually exclusive with `username`
| *Connection* | -| `username` | utually exclusive with `connection` | *EnvVar* | +| `username` | Mutually exclusive with `connection` | *EnvVar* | | `password` | Mutually exclusive with `connection` | *EnvVar* | | `host` | Custom AWS Cloudwatch endpoint | *string* | | `port` | Default to `22` | int | diff --git a/canary-checker/docs/reference/jmeter.mdx b/canary-checker/docs/reference/jmeter.mdx index c2c5509a..fa8111e8 100644 --- a/canary-checker/docs/reference/jmeter.mdx +++ b/canary-checker/docs/reference/jmeter.mdx @@ -7,7 +7,7 @@ title: Jmeter -This check will execute the JMeter CLI to execute the JMX test plan on the specified host. +This check executes the JMeter CLI to execute the JMX test plan on the specified host. ```yaml apiVersion: canaries.flanksource.com/v1 diff --git a/canary-checker/docs/troubleshooting.mdx b/canary-checker/docs/troubleshooting.mdx index 8940c561..95f45b51 100644 --- a/canary-checker/docs/troubleshooting.mdx +++ b/canary-checker/docs/troubleshooting.mdx @@ -90,7 +90,7 @@ which results in an output similar to the below: ![](/img/trace-screenshot.png) :::danger Sensitive Data & Excessive Logging -Trace level logging returns the HTTP response body which may contain sensitive data (The authorization headers will be sanitized) +Trace level logging returns the HTTP response body which may contain sensitive data (The authorization headers are sanitized) ::: **Trace Levels** diff --git a/mission-control/docs/how-it-works.mdx b/mission-control/docs/how-it-works.mdx index 64fe095a..3ee22bf9 100644 --- a/mission-control/docs/how-it-works.mdx +++ b/mission-control/docs/how-it-works.mdx @@ -36,8 +36,8 @@ Mission Control uses Kubernetes Custom Resources Definitions as the underlying c |
ScrapeConfig
 | Configures scrapers to run periodically | Config items, analysis, change, cost | | Canary | Runs health checks using HTTP, SQL, S3, kubectl, etc. | 1 or more checks (Health) | | Notification | Sends notifications based on events | Email, Slack, etc | -| Playbook | Defines playbooks that can be run on config items, health checks and componets | Pull Request, CLI, Webhook | - Connection | Re-usable connections with secure external lookup to Kuebrnetes secrets, configmaps, service accounts and Helm values | URL, username, password, etc | +| Playbook | Defines playbooks that can be run on config items, health checks and components | Pull Request, CLI, Webhook | + Connection | Re-usable connections with secure external lookup to Kubernetes secrets, configmaps, service accounts and Helm values | URL, username, password, etc | Topology | Combines configs, health checks and lookups to form cards | Component | diff --git a/mission-control/docs/notifications/channels/matrix.mdx b/mission-control/docs/notifications/channels/matrix.mdx index 3340cfc8..35ae5968 100644 --- a/mission-control/docs/notifications/channels/matrix.mdx +++ b/mission-control/docs/notifications/channels/matrix.mdx @@ -41,4 +41,4 @@ Either omit them or URL encode them, I.E. `rooms=%23alias:server` or `rooms=alia ### TLS If you do not have TLS enabled on the server you can disable it by providing `disableTLS=yes`. This will effectively -use `http` intead of `https` for the API calls. +use `http` instead of `https` for the API calls. diff --git a/modules/canary-checker b/modules/canary-checker index 91f944ac..71273e2e 160000 --- a/modules/canary-checker +++ b/modules/canary-checker @@ -1 +1 @@ -Subproject commit 91f944acbd36f47158ae5212d2781fd27d8347fc +Subproject commit 71273e2e8ab6e843e64b550282762115db63e202 diff --git a/modules/config-db b/modules/config-db index e62e306b..646ea613 160000 --- a/modules/config-db +++ b/modules/config-db @@ -1 +1 @@ -Subproject commit e62e306b824b786ca54326a2d67848190dbbbcd5 +Subproject commit 646ea613f0be21b0a2bf85421fd281254f05dbec diff --git a/modules/duty b/modules/duty index e3655c38..31f7d431 160000 --- a/modules/duty +++ b/modules/duty @@ -1 +1 @@ -Subproject commit e3655c38c85cb156dbce1481b701cca1c2a26b64 +Subproject commit 31f7d43133caac8e9ceebb888fcaa99e901d8102 diff --git a/modules/mission-control b/modules/mission-control index 977fcb66..e6faec47 160000 --- a/modules/mission-control +++ b/modules/mission-control @@ -1 +1 @@ -Subproject commit 977fcb667f7b57cd203ecafa30b179faa5ca2807 +Subproject commit e6faec47f209bc6cb5e961d37a2ae63205194132 diff --git a/styles/Flanksource/ProfanityUnlikely.yml b/styles/Flanksource/ProfanityUnlikely.yml index cbc9fe30..0d5186a4 100644 --- a/styles/Flanksource/ProfanityUnlikely.yml +++ b/styles/Flanksource/ProfanityUnlikely.yml @@ -66,7 +66,6 @@ tokens: - cocktail - coconut - coconuts - - color - colored - coloured - communist diff --git a/styles/ignore/words-with-suggestions.txt b/styles/ignore/words-with-suggestions.txt index 2da684d6..94fd7447 100644 --- a/styles/ignore/words-with-suggestions.txt +++ b/styles/ignore/words-with-suggestions.txt @@ -343,3 +343,36 @@ unencrypted etcd Bitnami imcp +argocd +fluxcd +kustomize +Kustomization +originAnnotations +Gitea +flanksource +AIOps +oneOf +API's +clientHost +fromName +starttls +shoutrrr +botmail +botkey +parseMode +botfather +kustomization +kustomizations +hardcoded +gitops +cel +mysql +templatedBody +workflow_dispatch +buildMetadata +getAction +maxLength +declaratively +CEL's +dependabot +unescaped