Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 20:37:12 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Automatic update operator docs from VictoriaMetrics/operator@9f1c910 (#5895)

Browse Source
This commit is contained in:
Github Actions 2024-02-29 19:56:13 +08:00 committed by GitHub
parent 62498a1e68
commit 1217c1f2da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 34 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/operator/api.md
View File

@ -138,6 +138,7 @@ This Document documents the types introduced by the VictoriaMetrics to be consum
* [VMAuth](#vmauth) * [VMAuth](#vmauth)
* [VMAuthList](#vmauthlist) * [VMAuthList](#vmauthlist)
* [VMAuthSpec](#vmauthspec) * [VMAuthSpec](#vmauthspec)
* [VMAuthStatus](#vmauthstatus)
* [VMAuthUnauthorizedPath](#vmauthunauthorizedpath) * [VMAuthUnauthorizedPath](#vmauthunauthorizedpath)
* [TargetEndpoint](#targetendpoint) * [TargetEndpoint](#targetendpoint)
* [VMStaticScrape](#vmstaticscrape) * [VMStaticScrape](#vmstaticscrape)
@ -159,7 +160,7 @@ VMAlertmanager represents Victoria-Metrics deployment for Alertmanager.
| ----- | ----------- | ------ | -------- | | ----- | ----------- | ------ | -------- |
| metadata | | [metav1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta) | false | | metadata | | [metav1.ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta) | false |
| spec | Specification of the desired behavior of the VMAlertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | [VMAlertmanagerSpec](#vmalertmanagerspec) | true | | spec | Specification of the desired behavior of the VMAlertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | [VMAlertmanagerSpec](#vmalertmanagerspec) | true |
| status | Most recent observed status of the VMAlertmanager cluster. Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | *[VMAlertmanagerStatus](#vmalertmanagerstatus) | false | | status | Most recent observed status of the VMAlertmanager cluster. Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | [VMAlertmanagerStatus](#vmalertmanagerstatus) | false |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -243,15 +244,12 @@ VMAlertmanagerSpec is a specification of the desired behavior of the VMAlertmana
## VMAlertmanagerStatus ## VMAlertmanagerStatus
VMAlertmanagerStatus is the most recent observed status of the VMAlertmanager cluster Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status VMAlertmanagerStatus is the most recent observed status of the VMAlertmanager cluster Operator API itself. More info:
| Field | Description | Scheme | Required | | Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- | | ----- | ----------- | ------ | -------- |
| paused | Paused Represents whether any actions on the underlaying managed objects are being performed. Only delete actions will be performed. | bool | true | | updateStatus | Status defines a status of object update | UpdateStatus | false |
| replicas | ReplicaCount Total number of non-terminated pods targeted by this VMAlertmanager cluster (their labels match the selector). | int32 | true | | reason | Reason has non empty reason for update failure | string | false |
| updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMAlertmanager cluster that have the desired version spec. | int32 | true |
| availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMAlertmanager cluster. | int32 | true |
| unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMAlertmanager cluster. | int32 | true |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -914,12 +912,14 @@ VMAgentStatus defines the observed state of VMAgent
| Field | Description | Scheme | Required | | Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- | | ----- | ----------- | ------ | -------- |
| shards | Shards represents total number of vmagent deployments with uniq scrape targets | int32 | true | | shards | Shards represents total number of vmagent deployments with uniq scrape targets | int32 | false |
| selector | Selector string form of label value set for autoscaling | string | true | | selector | Selector string form of label value set for autoscaling | string | false |
| replicas | ReplicaCount Total number of pods targeted by this VMAgent | int32 | true | | replicas | ReplicaCount Total number of pods targeted by this VMAgent | int32 | false |
| updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMAgent cluster that have the desired version spec. | int32 | true | | updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMAgent cluster that have the desired version spec. | int32 | false |
| availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMAlert cluster. | int32 | true | | availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMAlert cluster. | int32 | false |
| unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMAgent cluster. | int32 | true | | unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMAgent cluster. | int32 | false |
| updateStatus | UpdateStatus defines a status for update rollout, effective only for statefuleMode | UpdateStatus | false |
| reason | Reason defines fail reason for update process, effective only for statefuleMode | string | false |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -1282,10 +1282,12 @@ VMAlertStatus defines the observed state of VMAlert
| Field | Description | Scheme | Required | | Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- | | ----- | ----------- | ------ | -------- |
| replicas | ReplicaCount Total number of non-terminated pods targeted by this VMAlert cluster (their labels match the selector). | int32 | true | | replicas | ReplicaCount Total number of non-terminated pods targeted by this VMAlert cluster (their labels match the selector). | int32 | false |
| updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMAlert cluster that have the desired version spec. | int32 | true | | updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMAlert cluster that have the desired version spec. | int32 | false |
| availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMAlert cluster. | int32 | true | | availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMAlert cluster. | int32 | false |
| unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMAlert cluster. | int32 | true | | unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMAlert cluster. | int32 | false |
| updateStatus | UpdateStatus defines a status for update rollout, effective only for statefuleMode | UpdateStatus | false |
| reason | Reason defines fail reason for update process, effective only for statefuleMode | string | false |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -1379,8 +1381,8 @@ VMSingleStatus defines the observed state of VMSingle
| updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMSingle. | int32 | true | | updatedReplicas | UpdatedReplicas Total number of non-terminated pods targeted by this VMSingle. | int32 | true |
| availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMSingle. | int32 | true | | availableReplicas | AvailableReplicas Total number of available pods (ready for at least minReadySeconds) targeted by this VMSingle. | int32 | true |
| unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMSingle. | int32 | true | | unavailableReplicas | UnavailableReplicas Total number of unavailable pods targeted by this VMSingle. | int32 | true |
| singleStatus | | SingleStatus | true | | singleStatus | UpdateStatus defines a status of single node rollout | UpdateStatus | false |
| reason | | string | false | | reason | Reason defines a reason in case of update failure | string | false |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -1859,7 +1861,7 @@ VMClusterStatus defines the observed state of VMCluster
| ----- | ----------- | ------ | -------- | | ----- | ----------- | ------ | -------- |
| updateFailCount | Deprecated. | int | true | | updateFailCount | Deprecated. | int | true |
| lastSync | Deprecated. | string | false | | lastSync | Deprecated. | string | false |
| clusterStatus | | string | true | | clusterStatus | | UpdateStatus | false |
| reason | | string | false | | reason | | string | false |
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
@ -2300,6 +2302,17 @@ VMAuthSpec defines the desired state of VMAuth
[Back to TOC](#table-of-contents) [Back to TOC](#table-of-contents)
## VMAuthStatus
VMAuthStatus defines the observed state of VMAuth
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| updateStatus | UpdateStatus defines a status for update rollout, effective only for statefuleMode | UpdateStatus | false |
| reason | Reason defines fail reason for update process, effective only for statefuleMode | string | false |
[Back to TOC](#table-of-contents)
## VMAuthUnauthorizedPath ## VMAuthUnauthorizedPath
VMAuthUnauthorizedPath defines url_map for unauthorized access VMAuthUnauthorizedPath defines url_map for unauthorized access

2
docs/operator/vars.md
View File

@ -10,7 +10,7 @@ menu:
<!-- 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 Feb 21 14:28:51 UTC 2024 updated at Thu Feb 29 01:43:08 UTC 2024
| varible name | variable default value | variable required | variable description | | varible name | variable default value | variable required | variable description |