From cd287b2e4c795e50b3bc84cc352bd122c599a2a9 Mon Sep 17 00:00:00 2001 From: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Date: Fri, 26 Jan 2024 17:21:52 +0800 Subject: [PATCH] Automatic update operator docs from VictoriaMetrics/operator@0628def (#5694) --- docs/operator/CHANGELOG.md | 3 ++- docs/operator/api.md | 7 +++++++ docs/operator/vars.md | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index 9233549245..1ea541c212 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -15,7 +15,8 @@ aliases: # CHANGELOG ## Next release - +- [vmauth](./api.html#vmauth): add new fields for `unauthorized_user` like `src_hosts`, `headers`, `retry_status_codes` and `load_balancing_policy`. See [vmauth docs](https://docs.victoriametrics.com/vmauth.htm) for more details. + ## [v0.40.0](https://github.com/VictoriaMetrics/operator/releases/tag/v0.40.0) - 23 Jan 2024 diff --git a/docs/operator/api.md b/docs/operator/api.md index d81082e445..ae38846252 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -2131,6 +2131,7 @@ TargetRef describes target for user traffic forwarding. one of target types can | crd | CRD describes exist operator's CRD object, operator generates access url based on CRD params. | *[CRDRef](#crdref) | false | | static | Static - user defined url for traffic forward, for instance http://vmsingle:8429 | *[StaticRef](#staticref) | false | | paths | Paths - matched path to route. | []string | false | +| hosts | | []string | false | | target_path_suffix | QueryParams []string `json:\"queryParams,omitempty\"` TargetPathSuffix allows to add some suffix to the target path It allows to hide tenant configuration from user with crd as ref. it also may contain any url encoded params. | string | false | | headers | Headers represent additional http headers, that vmauth uses in form of [\"header_key: header_value\"] multiple values for header key: [\"header_key: value1,value2\"] it's available since 1.68.0 version of vmauth | []string | false | | response_headers | ResponseHeaders represent additional http headers, that vmauth adds for request response in form of [\"header_key: header_value\"] multiple values for header key: [\"header_key: value1,value2\"] it's available since 1.93.0 version of vmauth | []string | false | @@ -2308,6 +2309,12 @@ VMAuthUnauthorizedPath defines url_map for unauthorized access | src_paths | Paths src request paths | []string | false | | url_prefix | URLs defines url_prefix for dst routing | []string | false | | ip_filters | IPFilters defines filter for src ip address enterprise only | [VMUserIPFilters](#vmuseripfilters) | false | +| src_hosts | SrcHosts is the list of regular expressions, which match the request hostname. | []string | false | +| headers | Headers represent additional http headers, that vmauth uses in form of [\"header_key: header_value\"] multiple values for header key: [\"header_key: value1,value2\"] it's available since 1.68.0 version of vmauth | []string | false | +| response_headers | ResponseHeaders represent additional http headers, that vmauth adds for request response in form of [\"header_key: header_value\"] multiple values for header key: [\"header_key: value1,value2\"] it's available since 1.93.0 version of vmauth | []string | false | +| retry_status_codes | RetryStatusCodes defines http status codes in numeric format for request retries e.g. [429,503] | []int | false | +| load_balancing_policy | LoadBalancingPolicy defines load balancing policy to use for backend urls. Supported policies: least_loaded, first_available. See https://docs.victoriametrics.com/vmauth.html#load-balancing for more details (default \"least_loaded\") | *string | false | +| drop_src_path_prefix_parts | DropSrcPathPrefixParts is the number of `/`-delimited request path prefix parts to drop before proxying the request to backend. See https://docs.victoriametrics.com/vmauth.html#dropping-request-path-prefix for more details. | *int | false | [Back to TOC](#table-of-contents) diff --git a/docs/operator/vars.md b/docs/operator/vars.md index d7526bae17..923adbf358 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -10,7 +10,7 @@ menu: # Auto Generated vars for package config - updated at Thu Jan 25 14:20:46 UTC 2024 + updated at Fri Jan 26 09:07:18 UTC 2024 | varible name | variable default value | variable required | variable description |