VictoriaMetrics · f41gh7 · Aug 16, 2024 · Aug 16, 2024 · Aug 16, 2024 · Aug 16, 2024
@@ -344,7 +344,7 @@ type VMAgentSpec struct {
 	// ShardCount - numbers of shards of VMAgent
 	// in this case operator will use 1 deployment/sts per shard with
 	// replicas count according to spec.replicas,
-	// see [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md/#scraping-big-number-of-targets)
+	// see [here](https://docs.victoriametrics.com/vmagent/#scraping-big-number-of-targets)
 	// +optional
 	ShardCount *int `json:"shardCount,omitempty"`
 
@@ -433,7 +433,7 @@ type VMAgentSpec struct {
 
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+	// See [here](https://docs.victoriametrics.com/enterprise)
 	// +optional
 	License *License `json:"license,omitempty"`
 
@@ -480,7 +480,7 @@ type VMAgentRemoteWriteSettings struct {
 	// +optional
 	Labels map[string]string `json:"label,omitempty"`
 	// Configures vmagent accepting data via the same multitenant endpoints as vminsert at VictoriaMetrics cluster does,
-	// see [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md/#multitenancy).
+	// see [here](https://docs.victoriametrics.com/vmagent/#multitenancy).
 	// it's global setting and affects all remote storage configurations
 	// +optional
 	UseMultiTenantMode bool `json:"useMultiTenantMode,omitempty"`

@@ -276,7 +276,7 @@ type VMAlertSpec struct {
 
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+	// See [here](https://docs.victoriametrics.com/enterprise)
 	// +optional
 	License *License `json:"license,omitempty"`
 

@@ -204,7 +204,7 @@ type VMAuthSpec struct {
 	UseStrictSecurity *bool `json:"useStrictSecurity,omitempty"`
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+	// See [here](https://docs.victoriametrics.com/enterprise)
 	// +optional
 	License *License `json:"license,omitempty"`
 	// ConfigSecret is the name of a Kubernetes Secret in the same namespace as the
@@ -268,13 +268,13 @@ type URLMapCommon struct {
 
 	// LoadBalancingPolicy defines load balancing policy to use for backend urls.
 	// Supported policies: least_loaded, first_available.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md#load-balancing) for more details (default "least_loaded")
+	// See [here](https://docs.victoriametrics.com/vmauth#load-balancing) for more details (default "least_loaded")
 	// +optional
 	// +kubebuilder:validation:Enum=least_loaded;first_available
 	LoadBalancingPolicy *string `json:"load_balancing_policy,omitempty"`
 
 	// DropSrcPathPrefixParts is the number of `/`-delimited request path prefix parts to drop before proxying the request to backend.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md#dropping-request-path-prefix) for more details.
+	// See [here](https://docs.victoriametrics.com/vmauth#dropping-request-path-prefix) for more details.
 	// +optional
 	DropSrcPathPrefixParts *int `json:"drop_src_path_prefix_parts,omitempty"`
 }
@@ -288,7 +288,7 @@ type UserConfigOption struct {
 	TLSConfig *TLSConfig `json:"tlsConfig,omitempty"`
 
 	// IPFilters defines per target src ip filters
-	// supported only with enterprise version of [vmauth](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md/#ip-filters)
+	// supported only with enterprise version of [vmauth](https://docs.victoriametrics.com/vmauth/#ip-filters)
 	// +optional
 	IPFilters VMUserIPFilters `json:"ip_filters,omitempty"`
 
@@ -322,13 +322,13 @@ type UserConfigOption struct {
 
 	// LoadBalancingPolicy defines load balancing policy to use for backend urls.
 	// Supported policies: least_loaded, first_available.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md#load-balancing) for more details (default "least_loaded")
+	// See [here](https://docs.victoriametrics.com/vmauth#load-balancing) for more details (default "least_loaded")
 	// +optional
 	// +kubebuilder:validation:Enum=least_loaded;first_available
 	LoadBalancingPolicy *string `json:"load_balancing_policy,omitempty"`
 
 	// DropSrcPathPrefixParts is the number of `/`-delimited request path prefix parts to drop before proxying the request to backend.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md#dropping-request-path-prefix) for more details.
+	// See [here](https://docs.victoriametrics.com/vmauth#dropping-request-path-prefix) for more details.
 	// +optional
 	DropSrcPathPrefixParts *int `json:"drop_src_path_prefix_parts,omitempty"`
 }

@@ -26,7 +26,7 @@ type VMClusterSpec struct {
 	// Note VictoriaMetrics has data/ and indexdb/ folders
 	// metrics from data/ removed eventually as soon as partition leaves retention period
 	// reverse index data at indexdb rotates once at the half of configured
-	// [retention period](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/Single-server-VictoriaMetrics.md/#retention)
+	// [retention period](https://docs.victoriametrics.com/Single-server-VictoriaMetrics/#retention)
 	RetentionPeriod string `json:"retentionPeriod"`
 	// ReplicationFactor defines how many copies of data make among
 	// distinct storage nodes
@@ -51,7 +51,7 @@ type VMClusterSpec struct {
 
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+	// See [here](https://docs.victoriametrics.com/enterprise)
 	// +optional
 	License *License `json:"license,omitempty"`
 
@@ -271,7 +271,7 @@ type VMSelect struct {
 	Port string `json:"port,omitempty"`
 
 	// ClusterNativePort for multi-level cluster setup.
-	// More [details](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/Cluster-VictoriaMetrics.md#multi-level-cluster-setup)
+	// More [details](https://docs.victoriametrics.com/Cluster-VictoriaMetrics#multi-level-cluster-setup)
 	// +optional
 	ClusterNativePort string `json:"clusterNativeListenPort,omitempty"`
 
@@ -456,7 +456,7 @@ type VMInsert struct {
 	Port string `json:"port,omitempty"`
 
 	// ClusterNativePort for multi-level cluster setup.
-	// More [details](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/Cluster-VictoriaMetrics.md#multi-level-cluster-setup)
+	// More [details](https://docs.victoriametrics.com/Cluster-VictoriaMetrics#multi-level-cluster-setup)
 	// +optional
 	ClusterNativePort string `json:"clusterNativeListenPort,omitempty"`
 
@@ -771,14 +771,14 @@ type VMBackup struct {
 	VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`
 
 	// Restore Allows to enable restore options for pod
-	// Read [more](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmbackupmanager.md#restore-commands)
+	// Read [more](https://docs.victoriametrics.com/vmbackupmanager#restore-commands)
 	// +optional
 	Restore *VMRestore `json:"restore,omitempty"`
 }
 
 func (cr *VMBackup) sanityCheck(l *License) error {
 	if !l.IsProvided() && !cr.AcceptEULA {
-		return fmt.Errorf("it is required to provide license key. See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)")
+		return fmt.Errorf("it is required to provide license key. See [here](https://docs.victoriametrics.com/enterprise)")
 	}
 
 	if l.IsProvided() {

@@ -689,10 +689,10 @@ func (m *StringOrArray) UnmarshalJSON(data []byte) error {
 
 // License holds license key for enterprise features.
 // Using license key is supported starting from VictoriaMetrics v1.94.0.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+// See [here](https://docs.victoriametrics.com/enterprise)
 type License struct {
-	// Enterprise license key. This flag is available only in [VictoriaMetrics enterprise](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md).
-	// To request a trial license, [go to](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/products/enterprise/trial.md)
+	// Enterprise license key. This flag is available only in [VictoriaMetrics enterprise](https://docs.victoriametrics.com/enterprise).
+	// To request a trial license, [go to](https://victoriametrics.com/products/enterprise/trial)
 	Key *string `json:"key,omitempty"`
 	// KeyRef is reference to secret with license key for enterprise features.
 	KeyRef *v1.SecretKeySelector `json:"keyRef,omitempty"`

@@ -54,12 +54,12 @@ type RuleGroup struct {
 	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
 	// ExtraFilterLabels optional list of label filters applied to every rule's
 	// request within a group. Is compatible only with VM datasource.
-	// See more details [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/#prometheus-querying-api-enhancements)
+	// See more details [here](https://docs.victoriametrics.com/#prometheus-querying-api-enhancements)
 	// Deprecated, use params instead
 	// +optional
 	ExtraFilterLabels map[string]string `json:"extra_filter_labels,omitempty" yaml:"extra_filter_labels,omitempty"`
 	// Tenant id for group, can be used only with enterprise version of vmalert.
-	// See more details [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmalert.md#multitenancy).
+	// See more details [here](https://docs.victoriametrics.com/vmalert#multitenancy).
 	// +optional
 	Tenant string `json:"tenant,omitempty" yaml:"tenant,omitempty"`
 	// Params optional HTTP URL parameters added to each rule request

@@ -81,7 +81,7 @@ type VMScrapeConfigSpec struct {
 }
 
 // StaticConfig defines a static configuration.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#static_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#static_configs)
 type StaticConfig struct {
 	// List of targets for this static configuration.
 	// +optional
@@ -93,15 +93,15 @@ type StaticConfig struct {
 }
 
 // FileSDConfig defines a file service discovery configuration.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#file_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#file_sd_configs)
 type FileSDConfig struct {
 	// List of files to be used for file discovery.
 	// +kubebuilder:validation:MinItems:=1
 	Files []string `json:"files"`
 }
 
 // HTTPSDConfig defines a HTTP service discovery configuration.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#http_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#http_sd_configs)
 type HTTPSDConfig struct {
 	// URL from which the targets are fetched.
 	// +kubebuilder:validation:MinLength:=1
@@ -120,13 +120,13 @@ type HTTPSDConfig struct {
 	// +optional
 	ProxyURL *string `json:"proxyURL,omitempty"`
 	// ProxyClientConfig configures proxy auth settings for scraping
-	// See [feature description](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md#scraping-targets-via-a-proxy)
+	// See [feature description](https://docs.victoriametrics.com/vmagent#scraping-targets-via-a-proxy)
 	// +optional
 	ProxyClientConfig *ProxyAuth `json:"proxy_client_config,omitempty"`
 }
 
 // KubernetesSDConfig allows retrieving scrape targets from Kubernetes' REST API.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#kubernetes_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#kubernetes_sd_configs)
 // +k8s:openapi-gen=true
 type KubernetesSDConfig struct {
 	// The API server address consisting of a hostname or IP address followed
@@ -155,7 +155,7 @@ type KubernetesSDConfig struct {
 	// +optional
 	ProxyURL *string `json:"proxyURL,omitempty"`
 	// ProxyClientConfig configures proxy auth settings for scraping
-	// See [feature description](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md#scraping-targets-via-a-proxy)
+	// See [feature description](https://docs.victoriametrics.com/vmagent#scraping-targets-via-a-proxy)
 	// +optional
 	ProxyClientConfig *ProxyAuth `json:"proxy_client_config,omitempty"`
 	// Configure whether HTTP requests follow HTTP 3xx redirects.
@@ -195,7 +195,7 @@ type NamespaceDiscovery struct {
 }
 
 // ConsulSDConfig defines a Consul service discovery configuration.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md/#consul_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs/#consul_sd_configs)
 // +k8s:openapi-gen=true
 type ConsulSDConfig struct {
 	// A valid string consisting of a hostname or IP followed by an optional port number.
@@ -234,7 +234,7 @@ type ConsulSDConfig struct {
 	// +mapType:=atomic
 	// +optional
 	NodeMeta map[string]string `json:"nodeMeta,omitempty"`
-	// Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
+	// Allow stale Consul results (see https://developer.hashicorp.com/consul/api-docs/features/consistency). Will reduce load on Consul.
 	// If unset, use its default value.
 	// +optional
 	AllowStale *bool `json:"allowStale,omitempty"`
@@ -251,7 +251,7 @@ type ConsulSDConfig struct {
 	// +optional
 	ProxyURL *string `json:"proxyURL,omitempty"`
 	// ProxyClientConfig configures proxy auth settings for scraping
-	// See [feature description](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md#scraping-targets-via-a-proxy)
+	// See [feature description](https://docs.victoriametrics.com/vmagent#scraping-targets-via-a-proxy)
 	// +optional
 	ProxyClientConfig *ProxyAuth `json:"proxy_client_config,omitempty"`
 	// Configure whether HTTP requests follow HTTP 3xx redirects.
@@ -265,7 +265,7 @@ type ConsulSDConfig struct {
 
 // DNSSDConfig allows specifying a set of DNS domain names which are periodically queried to discover a list of targets.
 // The DNS servers to be contacted are read from /etc/resolv.conf.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#dns_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#dns_sd_configs)
 // +k8s:openapi-gen=true
 type DNSSDConfig struct {
 	// A list of DNS domain names to be queried.
@@ -287,7 +287,7 @@ type DNSSDConfig struct {
 // EC2SDConfig allow retrieving scrape targets from AWS EC2 instances.
 // The private IP address is used by default, but may be changed to the public IP address with relabeling.
 // The IAM credentials used must have the ec2:DescribeInstances permission to discover scrape targets.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#ec2_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#ec2_sd_configs)
 // +k8s:openapi-gen=true
 type EC2SDConfig struct {
 	// The AWS region
@@ -321,7 +321,7 @@ type EC2Filter struct {
 }
 
 // AzureSDConfig allow retrieving scrape targets from Azure VMs.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#azure_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#azure_sd_configs)
 // +k8s:openapi-gen=true
 type AzureSDConfig struct {
 	// The Azure environment.
@@ -357,7 +357,7 @@ type AzureSDConfig struct {
 // GCESDConfig configures scrape targets from GCP GCE instances.
 // The private IP address is used by default, but may be changed to
 // the public IP address with relabeling.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#gce_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#gce_sd_configs)
 //
 // The GCE service discovery will load the Google Cloud credentials
 // from the file specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable.
@@ -387,7 +387,7 @@ type GCESDConfig struct {
 }
 
 // OpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#openstack_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#openstack_sd_configs)
 // +k8s:openapi-gen=true
 type OpenStackSDConfig struct {
 	// The OpenStack role of entities that should be discovered.
@@ -463,7 +463,7 @@ type OpenStackSDConfig struct {
 
 // DigitalOceanSDConfig allow retrieving scrape targets from DigitalOcean's Droplets API.
 // This service discovery uses the public IPv4 address by default, by that can be changed with relabeling.
-// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/sd_configs.md#digitalocean_sd_configs)
+// See [here](https://docs.victoriametrics.com/sd_configs#digitalocean_sd_configs)
 // +k8s:openapi-gen=true
 type DigitalOceanSDConfig struct {
 	// Authorization header to use on every scrape request.
@@ -476,7 +476,7 @@ type DigitalOceanSDConfig struct {
 	// +optional
 	ProxyURL *string `json:"proxyURL,omitempty"`
 	// ProxyClientConfig configures proxy auth settings for scraping
-	// See [feature description](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmagent.md#scraping-targets-via-a-proxy)
+	// See [feature description](https://docs.victoriametrics.com/vmagent#scraping-targets-via-a-proxy)
 	// +optional
 	ProxyClientConfig *ProxyAuth `json:"proxy_client_config,omitempty"`
 	// Configure whether HTTP requests follow HTTP 3xx redirects.

@@ -164,14 +164,14 @@ type VMSingleSpec struct {
 	// RetentionPeriod for the stored metrics
 	// Note VictoriaMetrics has data/ and indexdb/ folders
 	// metrics from data/ removed eventually as soon as partition leaves retention period
-	// reverse index data at indexdb rotates once at the half of configured [retention period](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/Single-server-VictoriaMetrics.md/#retention)
+	// reverse index data at indexdb rotates once at the half of configured [retention period](https://docs.victoriametrics.com/Single-server-VictoriaMetrics/#retention)
 	RetentionPeriod string `json:"retentionPeriod"`
 	// VMBackup configuration for backup
 	// +optional
 	VMBackup *VMBackup `json:"vmBackup,omitempty"`
 	// License allows to configure license key to be used for enterprise features.
 	// Using license key is supported starting from VictoriaMetrics v1.94.0.
-	// See [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/enterprise.md)
+	// See [here](https://docs.victoriametrics.com/enterprise)
 	// +optional
 	License *License `json:"license,omitempty"`
 	// ExtraArgs that will be passed to  VMSingle pod

@@ -79,7 +79,7 @@ type TargetRef struct {
 }
 
 // VMUserIPFilters defines filters for IP addresses
-// supported only with enterprise version of [vmauth](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs/vmauth.md#ip-filters)
+// supported only with enterprise version of [vmauth](https://docs.victoriametrics.com/vmauth#ip-filters)
 type VMUserIPFilters struct {
 	DenyList  []string `json:"deny_list,omitempty"`
 	AllowList []string `json:"allow_list,omitempty"`