Skip to content

Commit

Permalink
Make the linters happy
Browse files Browse the repository at this point in the history
Signed-off-by: Pete Wall <pete.wall@grafana.com>
  • Loading branch information
petewall committed Oct 8, 2024
1 parent 76b8420 commit 1512387
Show file tree
Hide file tree
Showing 29 changed files with 26 additions and 13 deletions.
2 changes: 1 addition & 1 deletion charts/feature-annotation-autodiscovery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
Gathers metrics automatically based on Kubernetes Pod and Service annotations

The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any
The annotation-based autodiscovery feature makes it easy to add scrape targets. With this feature enabled, any

Check warning on line 11 in charts/feature-annotation-autodiscovery/README.md

View workflow job for this annotation

GitHub Actions / runner / alex

[alex] reported by reviewdog 🐶 `easy` may be insensitive, try not to use it easy retext-equality Raw Output: 11:53-11:57 warning `easy` may be insensitive, try not to use it easy retext-equality
Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered
and scraped by the collector. There are several other annotations that can be used to customize the behavior of the
scrape configuration, such as:
Expand Down
2 changes: 1 addition & 1 deletion charts/feature-annotation-autodiscovery/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}

The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any
The annotation-based autodiscovery feature makes it easy to add scrape targets. With this feature enabled, any
Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered
and scraped by the collector. There are several other annotations that can be used to customize the behavior of the
scrape configuration, such as:
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ token inside the values file. The Loki destination gets a bearer token from an e
## Values

```yaml
---
cluster:
name: bearer-token-example-cluster

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: bearer-token-example-cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ secret data directly into the destination configuration.
## Values

```yaml
---
cluster:
name: embedded-secrets-example-cluster

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: embedded-secrets-example-cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
This example demonstrates how to use pre-existing secrets to authenticate to external services. This allows for
credentials to be stored in different secret stores, as long as it resolves to a Kubernetes Secret.


## Values

```yaml
---
cluster:
name: external-secrets-example-cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@

This example demonstrates how to use pre-existing secrets to authenticate to external services. This allows for
credentials to be stored in different secret stores, as long as it resolves to a Kubernetes Secret.

Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: external-secrets-example-cluster

Expand Down
1 change: 1 addition & 0 deletions charts/k8s-monitoring/docs/examples/autoscaling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ down based on its CPU and memory utilization.
## Values

```yaml
---
cluster:
name: autoscaling-example-cluster

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: autoscaling-example-cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ store log file positions, so it knows where to start reading logs from after a r
## Values

```yaml
---
cluster:
name: collector-storage-example-cluster

Expand Down Expand Up @@ -64,4 +65,5 @@ alloy-logs:
- name: alloy-log-positions
hostPath:
path: /var/alloy-log-storage
type: DirectoryOrCreate```
type: DirectoryOrCreate
```
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: collector-storage-example-cluster

Expand Down Expand Up @@ -51,4 +52,4 @@ alloy-logs:
- name: alloy-log-positions
hostPath:
path: /var/alloy-log-storage
type: DirectoryOrCreate
type: DirectoryOrCreate
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,5 @@ alloy-singleton:
alloy-logs:
enabled: true
controller:
podAnnotations: {kubernetes.azure.com/set-kube-service-host-fqdn: "true"}```
podAnnotations: {kubernetes.azure.com/set-kube-service-host-fqdn: "true"}
```
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ alloy-singleton:
alloy-logs:
enabled: true
controller:
podAnnotations: {kubernetes.azure.com/set-kube-service-host-fqdn: "true"}
podAnnotations: {kubernetes.azure.com/set-kube-service-host-fqdn: "true"}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ If you do not want to use the `global` object, registry and pull secrets can be
## Values

```yaml
---
cluster:
name: private-image-registries-example-cluster

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
cluster:
name: private-image-registries-example-cluster

Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

Examples have been moved into their own chart directories.

* K8s Monitoring Helm chart v1.x: [v1 chart examples](../charts/k8s-monitoring-v1/docs/examples)
* K8s Monitoring Helm chart v2.x: [v2 chart examples](../charts/k8s-monitoring/docs/examples)
* K8s Monitoring Helm chart v1.x: [v1 chart examples](../charts/k8s-monitoring-v1/docs/examples)
* K8s Monitoring Helm chart v2.x: [v2 chart examples](../charts/k8s-monitoring/docs/examples)
3 changes: 2 additions & 1 deletion scripts/lint-markdown.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ fi
(return 0 2>/dev/null) && sourced=1 || sourced=0

statusCode=0
./node_modules/.bin/markdownlint-cli2 ./*.md ./**/*.md "#node_modules" "#data-alloy" "#charts/**/data-alloy"
# shellcheck disable=SC2046
./node_modules/.bin/markdownlint-cli2 $(find . -name "*.md" ! -path "./node_modules/*" ! -path "./data-alloy/*" ! -path "./charts/**/data-alloy/*")
currentCode="$?"
# only override the statusCode if it is 0
if [[ "${statusCode}" == 0 ]]; then
Expand Down
4 changes: 2 additions & 2 deletions scripts/lint-shell.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ statusCode=0
# shellcheck disable=SC2046 disable=SC2312
shellcheck --rcfile="$(pwd)/.shellcheckrc" $(
comm -23 <(
find . -type f -name "*.sh" -not \( -path "./node_modules/*" -o -path "./data-alloy/*" -o -path "./.git/*" -o -path "./charts/k8s-monitoring-v1/test/spec/*" \) | \
find . -type f -name "*.sh" -not \( -path "./node_modules/*" -o -path "./data-alloy/*" -o -path "./.git/*" -o -path "./charts/k8s-monitoring-v1/test/spec/*" -o -path "./charts/k8s-monitoring/tests/example-checks/spec/*" \) | \
sort
) <(
find . -type f -name "*.sh" -not \( -path "./node_modules/*" -o -path "./data-alloy/*" -o -path "./.git/*" -o -path "./charts/k8s-monitoring-v1/test/spec/*" \) | \
find . -type f -name "*.sh" -not \( -path "./node_modules/*" -o -path "./data-alloy/*" -o -path "./.git/*" -o -path "./charts/k8s-monitoring-v1/test/spec/*" -o -path "./charts/k8s-monitoring/tests/example-checks/spec/*" \) | \
git check-ignore --stdin | \
sort
)
Expand Down

0 comments on commit 1512387

Please sign in to comment.