VictoriaMetrics/docs/operator/resources/vmstaticscrape.md
Github Actions c57e68a0cd
Automatic update operator docs from VictoriaMetrics/operator@64879fb (#6831)
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: f41gh7 <nik@victoriametrics.com>
(cherry picked from commit 015f0b0424)
2024-08-19 17:45:40 +02:00

48 lines
1.6 KiB
Markdown

---
weight: 14
title: VMStaticScrape
menu:
docs:
identifier: operator-cr-vmstaticscrape
parent: operator-cr
weight: 14
aliases:
- /operator/resources/vmstaticscrape/
- /operator/resources/vmstaticscrape/index.html
---
The `VMStaticScrape` CRD provides mechanism for scraping metrics from static targets, configured by CRD targets.
`VMStaticScrape` object generates part of [VMAgent](https://docs.victoriametrics.com/operator/resources/vmagent)
configuration with [static "service discovery"](https://docs.victoriametrics.com/sd_configs#static_configs).
It has various options for scraping configuration of target (with basic auth,tls access, by specific port name etc.).
By specifying configuration at CRD, operator generates config
for [VMAgent](https://docs.victoriametrics.com/operator/resources/vmagent) and syncs it.
It's useful for external targets management, when service-discovery is not available.
`VMAgent` `staticScrapeSelector` must match `VMStaticScrape` labels.
More information about selectors you can find in [this doc](https://docs.victoriametrics.com/operator/resources/vmagent#scraping).
## Specification
You can see the full actual specification of the `VMStaticScrape` resource in
the **[API docs -> VMStaticScrape](https://docs.victoriametrics.com/operator/api#vmstaticscrape)**.
Also, you can check out the [examples](#examples) section.
## Examples
```yaml
apiVersion: operator.victoriametrics.com/v1beta1
kind: VMStaticScrape
metadata:
name: vmstaticscrape-sample
spec:
jobName: static
targetEndpoints:
- targets: ["192.168.0.1:9100", "196.168.0.50:9100"]
labels:
env: dev
project: operator
```