From 729967a466592cd56608d57931972212391de1c7 Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Thu, 12 Sep 2024 10:54:54 +0300 Subject: [PATCH] minor fix --- docs/api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api.md b/docs/api.md index cfc53d51..6abc9f39 100644 --- a/docs/api.md +++ b/docs/api.md @@ -653,8 +653,8 @@ _Appears in:_ | Field | Description | Scheme | Required | | --- | --- | --- | --- | -| `maxUnavailable` | An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable". | _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#intorstring-intstr-util)_ | false | -| `minAvailable` | An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%". | _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#intorstring-intstr-util)_ | false | +| `maxUnavailable` | An eviction is allowed if at most "maxUnavailable" pods selected by
"selector" are unavailable after the eviction, i.e. even in absence of
the evicted pod. For example, one can prevent all voluntary evictions
by specifying 0. This is a mutually exclusive setting with "minAvailable". | _[IntOrString](#intorstring)_ | false | +| `minAvailable` | An eviction is allowed if at least "minAvailable" pods selected by
"selector" will still be available after the eviction, i.e. even in the
absence of the evicted pod. So for example you can prevent all voluntary
evictions by specifying "100%". | _[IntOrString](#intorstring)_ | false | | `selectorLabels` | replaces default labels selector generated by operator
it's useful when you need to create custom budget | _object (keys:string, values:string)_ | false | @@ -721,7 +721,7 @@ _Appears in:_ | `scrapeTimeout` | Timeout after which the scrape is ended | _string_ | false | | `scrape_interval` | ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used | _string_ | false | | `seriesLimit` | SeriesLimit defines per-scrape limit on number of unique time series
a single target can expose during all the scrapes on the time window of 24h. | _integer_ | false | -| `targetPort` | TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. | _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#intorstring-intstr-util)_ | false | +| `targetPort` | TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. | _[IntOrString](#intorstring)_ | false | | `tlsConfig` | TLSConfig configuration to use when scraping the endpoint | _[TLSConfig](#tlsconfig)_ | false | | `vm_scrape_params` | VMScrapeParams defines VictoriaMetrics specific scrape parameters | _[VMScrapeParams](#vmscrapeparams)_ | false | @@ -1357,7 +1357,7 @@ _Appears in:_ | `scrapeTimeout` | Timeout after which the scrape is ended | _string_ | false | | `scrape_interval` | ScrapeInterval is the same as Interval and has priority over it.
one of scrape_interval or interval can be used | _string_ | false | | `seriesLimit` | SeriesLimit defines per-scrape limit on number of unique time series
a single target can expose during all the scrapes on the time window of 24h. | _integer_ | false | -| `targetPort` | TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. | _[IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#intorstring-intstr-util)_ | false | +| `targetPort` | TargetPort
Name or number of the pod port this endpoint refers to. Mutually exclusive with port. | _[IntOrString](#intorstring)_ | false | | `tlsConfig` | TLSConfig configuration to use when scraping the endpoint | _[TLSConfig](#tlsconfig)_ | false | | `vm_scrape_params` | VMScrapeParams defines VictoriaMetrics specific scrape parameters | _[VMScrapeParams](#vmscrapeparams)_ | false | @@ -1489,7 +1489,7 @@ _Appears in:_ | Field | Description | Scheme | Required | | --- | --- | --- | --- | | `action` | Action to perform based on regex matching. Default is 'replace' | _string_ | false | -| `if` | If represents metricsQL match expression (or list of expressions): '\{__name__=~"foo_.*"\}' | _[StringOrArray](#stringorarray)_ | false | +| `if` | If represents metricsQL match expression (or list of expressions): '{__name__=~"foo_.*"}' | _[StringOrArray](#stringorarray)_ | false | | `labels` | Labels is used together with Match for `action: graphite` | _object (keys:string, values:string)_ | false | | `match` | Match is used together with Labels for `action: graphite` | _string_ | false | | `modulus` | Modulus to take of the hash of the source label values. | _integer_ | false | @@ -1525,7 +1525,7 @@ _Appears in:_ | `mute_time_intervals` | MuteTimeIntervals is a list of interval names that will mute matched alert | _string array_ | false | | `receiver` | Name of the receiver for this route. | _string_ | true | | `repeat_interval` | How long to wait before repeating the last notification. | _string_ | false | -| `routes` | Child routes.
https://prometheus.io/docs/alerting/latest/configuration/#route | _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#json-v1-apiextensions-k8s-io) array_ | true | +| `routes` | Child routes.
https://prometheus.io/docs/alerting/latest/configuration/#route | _JSON array_ | true | #### Rule