Skip to content

Commit

Permalink
relative url in api docs (#1046)
Browse files Browse the repository at this point in the history
  • Loading branch information
@AndrewChubatiuk
AndrewChubatiuk authored Jul 25, 2024
1 parent 0f899d1 commit 10f48a6
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
1 change: 1 addition & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ help: ## Display this help.
manifests: controller-gen kustomize ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
$(KUSTOMIZE) build config/crd > config/crd/overlay/crd.yaml
sed -i 's/{{% ref "\(.*\)\(\.md\)\(.*\)" %}}/https:\/\/docs.victoriametrics.com\/operator\/\1\3/g' config/crd/overlay/crd.yaml

.PHONY: generate
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
Expand Down
4 changes: 2 additions & 2 deletions api/operator/v1beta1/common_scrapeparams.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
24 changes: 12 additions & 12 deletions config/crd/overlay/crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate over
Expand Down Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate
Expand Down Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate over
Expand Down Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate over
Expand Down Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate
Expand Down Expand Up @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scrape_config-enhancements
type: boolean
headers:
description: |-
Expand All @@ -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 https://docs.victoriametrics.com/operator/../vmagent#scraping-targets-via-a-proxy
properties:
basic_auth:
description: BasicAuth allow an endpoint to authenticate
Expand Down
4 changes: 2 additions & 2 deletions docs/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br />By default, HTTP keep-alive is enabled, so TCP connections to scrape targets<br />could be re-used.<br />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.<br />By default, HTTP keep-alive is enabled, so TCP connections to scrape targets<br />could be re-used.<br />See {{% ref "../vmagent.md#scrape_config-enhancements" %}} | _boolean_ | false |
| `headers` | Headers allows sending custom headers to scrape targets<br />must be in of semicolon separated header with it's value<br />eg:<br />headerName: headerValue<br />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<br />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<br />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 |
Expand Down

0 comments on commit 10f48a6

Please sign in to comment.