From 8f28fcc13f03a2f6653060085d631399a971dda9 Mon Sep 17 00:00:00 2001 From: AndrewChubatiuk Date: Thu, 25 Jul 2024 09:49:38 +0300 Subject: [PATCH] relative url in api docs --- api/operator/v1beta1/common_scrapeparams.go | 4 ++-- config/crd/overlay/crd.yaml | 24 ++++++++++----------- docs/api.md | 4 ++-- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/api/operator/v1beta1/common_scrapeparams.go b/api/operator/v1beta1/common_scrapeparams.go index 4512b950f..d059debb0 100644 --- a/api/operator/v1beta1/common_scrapeparams.go +++ b/api/operator/v1beta1/common_scrapeparams.go @@ -25,7 +25,7 @@ type VMScrapeParams struct { // disable_keepalive allows disabling HTTP keep-alive when scraping targets. // By default, HTTP keep-alive is enabled, so TCP connections to scrape targets // could be re-used. - // See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + // See {{% ref "/vmagent.md#scrape_config-enhancements" %}} // +optional DisableKeepAlive *bool `json:"disable_keep_alive,omitempty"` // +optional @@ -37,7 +37,7 @@ type VMScrapeParams struct { // +optional ScrapeOffset *string `json:"scrape_offset,omitempty"` // ProxyClientConfig configures proxy auth settings for scraping - // See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + // See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} // +optional ProxyClientConfig *ProxyAuth `json:"proxy_client_config,omitempty"` // Headers allows sending custom headers to scrape targets diff --git a/config/crd/overlay/crd.yaml b/config/crd/overlay/crd.yaml index 5064194c8..e33700ba0 100644 --- a/config/crd/overlay/crd.yaml +++ b/config/crd/overlay/crd.yaml @@ -16815,7 +16815,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -16832,7 +16832,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate over @@ -17845,7 +17845,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -17862,7 +17862,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate @@ -19048,7 +19048,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -19065,7 +19065,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate over @@ -23433,7 +23433,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -23450,7 +23450,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate over @@ -24451,7 +24451,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -24468,7 +24468,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate @@ -27192,7 +27192,7 @@ spec: disable_keepalive allows disabling HTTP keep-alive when scraping targets. By default, HTTP keep-alive is enabled, so TCP connections to scrape targets could be re-used. - See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements + See {{% ref "/vmagent.md#scrape_config-enhancements" %}} type: boolean headers: description: |- @@ -27209,7 +27209,7 @@ spec: proxy_client_config: description: |- ProxyClientConfig configures proxy auth settings for scraping - See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy + See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} properties: basic_auth: description: BasicAuth allow an endpoint to authenticate diff --git a/docs/api.md b/docs/api.md index c2534ee02..91194811f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3220,10 +3220,10 @@ _Appears in:_ | Field | Description | Scheme | Required | | --- | --- | --- | --- | | `disable_compression` | DisableCompression | _boolean_ | false | -| `disable_keep_alive` | disable_keepalive allows disabling HTTP keep-alive when scraping targets.
By default, HTTP keep-alive is enabled, so TCP connections to scrape targets
could be re-used.
See https://docs.victoriametrics.com/vmagent.html#scrape_config-enhancements | _boolean_ | false | +| `disable_keep_alive` | disable_keepalive allows disabling HTTP keep-alive when scraping targets.
By default, HTTP keep-alive is enabled, so TCP connections to scrape targets
could be re-used.
See {{% ref "/vmagent.md#scrape_config-enhancements" %}} | _boolean_ | false | | `headers` | Headers allows sending custom headers to scrape targets
must be in of semicolon separated header with it's value
eg:
headerName: headerValue
vmagent supports since 1.79.0 version | _string array_ | false | | `no_stale_markers` | | _boolean_ | false | -| `proxy_client_config` | ProxyClientConfig configures proxy auth settings for scraping
See feature description https://docs.victoriametrics.com/vmagent.html#scraping-targets-via-a-proxy | _[ProxyAuth](#proxyauth)_ | false | +| `proxy_client_config` | ProxyClientConfig configures proxy auth settings for scraping
See feature description {{% ref "/vmagent.md#scraping-targets-via-a-proxy %}} | _[ProxyAuth](#proxyauth)_ | false | | `scrape_align_interval` | | _string_ | false | | `scrape_offset` | | _string_ | false | | `stream_parse` | | _boolean_ | false |