Skip to content

Commit

Permalink
enhance README documentation for CRDs
Browse files Browse the repository at this point in the history
  • Loading branch information
scrayos committed Nov 21, 2024
1 parent 56fddef commit e8070bc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ jobs:
- name: Install required cargo
run: cargo install clippy-sarif sarif-fmt

- name: Check OpenSSL
run: (! cargo tree -i openssl 2> /dev/null)

- name: Build with cargo
run: cargo build --verbose

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ metadata:
namespace: mcexport
spec:
prober:
url: 'mcexport.mcexport:10026'
url: 'mcexport.mcexport.cluster.local:10026'
interval: 60s
scrapeTimeout: 30s
targets:
Expand All @@ -162,6 +162,10 @@ spec:
- 'example.com'
```

Depending on your setup, you may also need to add a label, so that the configuration is picked up by your Prometheus
instance. If you've installed it through the `kube-prometheus-stack` helm chart, it could, for example, be
`release: kube-prometheus-stack`. You can check the required labels in your Prometheus CRD.

## Reporting Security Issues

To report a security issue for this project, please note our [Security Policy][security-policy].
Expand Down

0 comments on commit e8070bc

Please sign in to comment.