mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2025-03-11 15:34:56 +00:00
Automatic update operator docs from VictoriaMetrics/operator@26d1b3b (#5130)
This commit is contained in:
parent
09e6606b38
commit
b576acff5e
30 changed files with 205 additions and 2 deletions
|
@ -2,6 +2,11 @@
|
||||||
sort: 10
|
sort: 10
|
||||||
weight: 10
|
weight: 10
|
||||||
title: CHANGELOG
|
title: CHANGELOG
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 10
|
||||||
|
identifier: "operator-changelog"
|
||||||
---
|
---
|
||||||
|
|
||||||
# CHANGELOG
|
# CHANGELOG
|
||||||
|
|
|
@ -2,6 +2,11 @@
|
||||||
sort: 9
|
sort: 9
|
||||||
weight: 9
|
weight: 9
|
||||||
title: FAQ
|
title: FAQ
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 9
|
||||||
|
identifier: "operator-faq"
|
||||||
---
|
---
|
||||||
|
|
||||||
# FAQ (Frequency Asked Questions)
|
# FAQ (Frequency Asked Questions)
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 0
|
sort: 0
|
||||||
weight: 0
|
weight: 0
|
||||||
title: VictoriaMetrics Operator
|
title: VictoriaMetrics Operator
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 0
|
||||||
---
|
---
|
||||||
|
|
||||||
# VictoriaMetrics Operator
|
# VictoriaMetrics Operator
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 12
|
sort: 12
|
||||||
weight: 12
|
weight: 12
|
||||||
title: API Docs
|
title: API Docs
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 12
|
||||||
---
|
---
|
||||||
|
|
||||||
<!-- this doc autogenerated - don't edit it manually -->
|
<!-- this doc autogenerated - don't edit it manually -->
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 7
|
sort: 7
|
||||||
weight: 7
|
weight: 7
|
||||||
title: Authorization and exposing components
|
title: Authorization and exposing components
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 7
|
||||||
---
|
---
|
||||||
|
|
||||||
# Authorization and exposing components
|
# Authorization and exposing components
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 4
|
sort: 4
|
||||||
weight: 4
|
weight: 4
|
||||||
title: Configuration
|
title: Configuration
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 4
|
||||||
---
|
---
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 13
|
sort: 13
|
||||||
weight: 13
|
weight: 13
|
||||||
title: Enterprise features
|
title: Enterprise features
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 13
|
||||||
---
|
---
|
||||||
|
|
||||||
# Using operator with enterprise features
|
# Using operator with enterprise features
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 8
|
sort: 8
|
||||||
weight: 8
|
weight: 8
|
||||||
title: High Availability
|
title: High Availability
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 8
|
||||||
---
|
---
|
||||||
|
|
||||||
# High Availability
|
# High Availability
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 5
|
sort: 5
|
||||||
weight: 5
|
weight: 5
|
||||||
title: Migration from Prometheus
|
title: Migration from Prometheus
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 5
|
||||||
---
|
---
|
||||||
|
|
||||||
# Migration from prometheus-operator
|
# Migration from prometheus-operator
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 6
|
sort: 6
|
||||||
weight: 6
|
weight: 6
|
||||||
title: Monitoring
|
title: Monitoring
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 6
|
||||||
---
|
---
|
||||||
|
|
||||||
# Monitoring of VictoriaMetrics Operator
|
# Monitoring of VictoriaMetrics Operator
|
||||||
|
@ -14,7 +18,7 @@ These metrics can be scraped via [vmagent](./resources/vmagent.md) or Prometheus
|
||||||
|
|
||||||
Official Grafana dashboard available for [vmoperator](https://grafana.com/grafana/dashboards/17869-victoriametrics-operator/).
|
Official Grafana dashboard available for [vmoperator](https://grafana.com/grafana/dashboards/17869-victoriametrics-operator/).
|
||||||
|
|
||||||
<img src="monitoring_operator-dashboard.jpeg" width=1200>
|
<img src="monitoring_operator-dashboard.png" width=1200>
|
||||||
|
|
||||||
Graphs on the dashboards contain useful hints - hover the `i` icon in the top left corner of each graph to read it.
|
Graphs on the dashboards contain useful hints - hover the `i` icon in the top left corner of each graph to read it.
|
||||||
|
|
||||||
|
|
BIN
docs/operator/monitoring_operator-dashboard.png
Normal file
BIN
docs/operator/monitoring_operator-dashboard.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1 MiB |
|
@ -2,6 +2,10 @@
|
||||||
sort: 1
|
sort: 1
|
||||||
weight: 1
|
weight: 1
|
||||||
title: QuickStart
|
title: QuickStart
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
# VictoriaMetrics Operator QuickStart
|
# VictoriaMetrics Operator QuickStart
|
||||||
|
|
|
@ -2,6 +2,11 @@
|
||||||
sort: 14
|
sort: 14
|
||||||
weight: 14
|
weight: 14
|
||||||
title: Custom resources
|
title: Custom resources
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
identifier: operator-custom-resources
|
||||||
|
parent: "operator"
|
||||||
|
weight: 14
|
||||||
---
|
---
|
||||||
|
|
||||||
# Custom resource kinds
|
# Custom resource kinds
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 1
|
||||||
|
weight: 1
|
||||||
|
title: VMAgent
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
# VMAgent
|
# VMAgent
|
||||||
|
|
||||||
`VMAgent` represents agent, which helps you collect metrics from various sources and stores them in VictoriaMetrics.
|
`VMAgent` represents agent, which helps you collect metrics from various sources and stores them in VictoriaMetrics.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 2
|
||||||
|
weight: 2
|
||||||
|
title: VMAlert
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 2
|
||||||
|
---
|
||||||
|
|
||||||
# VMAlert
|
# VMAlert
|
||||||
|
|
||||||
`VMAlert` - executes a list of given [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
|
`VMAlert` - executes a list of given [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 3
|
||||||
|
weight: 3
|
||||||
|
title: VMAlertmanager
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 3
|
||||||
|
---
|
||||||
|
|
||||||
# VMAlertmanager
|
# VMAlertmanager
|
||||||
|
|
||||||
`VMAlertmanager` - represents [alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) configuration.
|
`VMAlertmanager` - represents [alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) configuration.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 4
|
||||||
|
weight: 4
|
||||||
|
title: VMAlertmanagerConfig
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 4
|
||||||
|
---
|
||||||
|
|
||||||
# VMAlertmanagerConfig
|
# VMAlertmanagerConfig
|
||||||
|
|
||||||
The `VMAlertmanagerConfig` provides way to configure [VMAlertmanager](./vmalertmanager.md)
|
The `VMAlertmanagerConfig` provides way to configure [VMAlertmanager](./vmalertmanager.md)
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 5
|
||||||
|
weight: 5
|
||||||
|
title: VMAuth
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 5
|
||||||
|
---
|
||||||
|
|
||||||
# VMAuth
|
# VMAuth
|
||||||
|
|
||||||
The `VMAuth` CRD provides mechanism for exposing application with authorization to outside world or to other applications inside kubernetes cluster.
|
The `VMAuth` CRD provides mechanism for exposing application with authorization to outside world or to other applications inside kubernetes cluster.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 6
|
||||||
|
weight: 6
|
||||||
|
title: VMCluster
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 6
|
||||||
|
---
|
||||||
|
|
||||||
# VMCluster
|
# VMCluster
|
||||||
|
|
||||||
`VMCluster` represents a high-available and fault-tolerant version of VictoriaMetrics database.
|
`VMCluster` represents a high-available and fault-tolerant version of VictoriaMetrics database.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 7
|
||||||
|
weight: 7
|
||||||
|
title: VMNodeScrape
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 7
|
||||||
|
---
|
||||||
|
|
||||||
# VMNodeScrape
|
# VMNodeScrape
|
||||||
|
|
||||||
The `VMNodeScrape` CRD provides discovery mechanism for scraping metrics kubernetes nodes,
|
The `VMNodeScrape` CRD provides discovery mechanism for scraping metrics kubernetes nodes,
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 8
|
||||||
|
weight: 8
|
||||||
|
title: VMPodScrape
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 8
|
||||||
|
---
|
||||||
|
|
||||||
# VMPodScrape
|
# VMPodScrape
|
||||||
|
|
||||||
The `VMPodScrape` CRD allows to declaratively define how a dynamic set of pods should be monitored.
|
The `VMPodScrape` CRD allows to declaratively define how a dynamic set of pods should be monitored.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 9
|
||||||
|
weight: 9
|
||||||
|
title: VMProbe
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 9
|
||||||
|
---
|
||||||
|
|
||||||
# VMProbe
|
# VMProbe
|
||||||
|
|
||||||
The `VMProbe` CRD provides probing target ability with some external prober.
|
The `VMProbe` CRD provides probing target ability with some external prober.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 10
|
||||||
|
weight: 10
|
||||||
|
title: VMRule
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 10
|
||||||
|
---
|
||||||
|
|
||||||
# VMRule
|
# VMRule
|
||||||
|
|
||||||
`VMRule` represents [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
|
`VMRule` represents [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 11
|
||||||
|
weight: 11
|
||||||
|
title: VMServiceScrape
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 11
|
||||||
|
---
|
||||||
|
|
||||||
# VMServiceScrape
|
# VMServiceScrape
|
||||||
|
|
||||||
The `VMServiceScrape` CRD allows to define a dynamic set of services for monitoring. Services
|
The `VMServiceScrape` CRD allows to define a dynamic set of services for monitoring. Services
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 12
|
||||||
|
weight: 12
|
||||||
|
title: VMSingle
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 12
|
||||||
|
---
|
||||||
|
|
||||||
# VMSingle
|
# VMSingle
|
||||||
|
|
||||||
`VMSingle` represents database for storing metrics.
|
`VMSingle` represents database for storing metrics.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 13
|
||||||
|
weight: 13
|
||||||
|
title: VMStaticScrape
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 13
|
||||||
|
---
|
||||||
|
|
||||||
# VMStaticScrape
|
# VMStaticScrape
|
||||||
|
|
||||||
The `VMStaticScrape` CRD provides mechanism for scraping metrics from static targets, configured by CRD targets.
|
The `VMStaticScrape` CRD provides mechanism for scraping metrics from static targets, configured by CRD targets.
|
||||||
|
|
|
@ -1,3 +1,13 @@
|
||||||
|
---
|
||||||
|
sort: 14
|
||||||
|
weight: 14
|
||||||
|
title: VMUser
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator-custom-resources"
|
||||||
|
weight: 14
|
||||||
|
---
|
||||||
|
|
||||||
# VMUser
|
# VMUser
|
||||||
|
|
||||||
The `VMUser` CRD describes user configuration, its authentication methods `basic auth` or `Authorization` header.
|
The `VMUser` CRD describes user configuration, its authentication methods `basic auth` or `Authorization` header.
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 3
|
sort: 3
|
||||||
weight: 3
|
weight: 3
|
||||||
title: Security
|
title: Security
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
# Security
|
# Security
|
||||||
|
|
|
@ -2,6 +2,10 @@
|
||||||
sort: 2
|
sort: 2
|
||||||
weight: 2
|
weight: 2
|
||||||
title: Setup
|
title: Setup
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
# VictoriaMetrics Operator Setup
|
# VictoriaMetrics Operator Setup
|
||||||
|
|
|
@ -2,11 +2,15 @@
|
||||||
sort: 11
|
sort: 11
|
||||||
weight: 11
|
weight: 11
|
||||||
title: Variables
|
title: Variables
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "operator"
|
||||||
|
weight: 11
|
||||||
---
|
---
|
||||||
|
|
||||||
<!-- this doc autogenerated - don't edit it manually -->
|
<!-- this doc autogenerated - don't edit it manually -->
|
||||||
# Auto Generated vars for package config
|
# Auto Generated vars for package config
|
||||||
updated at Wed Oct 4 16:46:39 UTC 2023
|
updated at Thu Oct 5 10:42:38 UTC 2023
|
||||||
|
|
||||||
|
|
||||||
| varible name | variable default value | variable required | variable description |
|
| varible name | variable default value | variable required | variable description |
|
||||||
|
|
Loading…
Reference in a new issue