VictoriaMetrics / VictoriaMetrics/operator
VMAlert datasource bearer token isn't documented
Open
Beginner friendly
Nobody has claimed this yet.
docs
- Dominant language
- Go
- Stars
- 589
- Forks
- 229
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 77
Description
The CRD reference in the API docs for vmalert doesn't show that bearer tokens are a possibility to use with the datasource options. VMAlert supports this option and the operator successfully applies this configuration when the fields are present in the CRD.
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMAlert
metadata:
name: vmalert
namespace: victoria-metrics
spec:
datasource:
url: http://vmauth-vmalert:8427
bearerTokenSecret:
name: vmalert-token
key: token
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API documentation and CRD reference for VMAlert, locating the datasource options shown in the issue. Document the bearerTokenSecret name and key fields, using the provided manifest as the example, and verify the generated or rendered reference includes this supported configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100