From d0a9fff70c8cf27e8eaf2a56a0329de83b2fe91c Mon Sep 17 00:00:00 2001 From: Dmytro Kozlov Date: Fri, 30 Sep 2022 08:55:12 +0300 Subject: [PATCH] docs, app/vmgateway: add description about new `auth.httpHeader` flag (#3134) * docs, app/vmgateway: add description about new `auth.httpHeader` flag * Update docs/CHANGELOG.md Co-authored-by: Aliaksandr Valialkin --- app/vmgateway/README.md | 2 ++ docs/CHANGELOG.md | 1 + docs/vmgateway.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/app/vmgateway/README.md b/app/vmgateway/README.md index c55a4a8b7..5297d5143 100644 --- a/app/vmgateway/README.md +++ b/app/vmgateway/README.md @@ -176,6 +176,8 @@ curl 'http://localhost:8431/api/v1/labels' -H 'Authorization: Bearer eyJhbGciOiJ The shortlist of configuration flags include the following: ```console + -auth.httpHeader + HTTP header name to look for JWT authorization token -clusterMode enable this for the cluster version -datasource.appendTypePrefix diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 33153b8c0..b5eabc002 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -34,6 +34,7 @@ The following tip changes can be tested by building VictoriaMetrics components f * FEATURE: [vmagent](https://docs.victoriametrics.com/vmagent.html): minimize the time needed for reading large responses from scrape targets in [stream parsing mode](https://docs.victoriametrics.com/vmagent.html#stream-parsing-mode). This should reduce scrape durations for such targets as [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) running in a big Kubernetes cluster. * FEATURE: [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html): add [sort_by_label_numeric](https://docs.victoriametrics.com/MetricsQL.html#sort_by_label_numeric) and [sort_by_label_numeric_desc](https://docs.victoriametrics.com/MetricsQL.html#sort_by_label_numeric_desc) functions for [numeric sort](https://www.gnu.org/software/coreutils/manual/html_node/Version-sort-is-not-the-same-as-numeric-sort.html) of input time series by the specified labels. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2938). * FEATURE: [vmbackup](https://docs.victoriametrics.com/vmbackup.html) and [vmrestore](https://docs.victoriametrics.com/vmrestore.html): retry GCS operations for up to 3 minutes on temporary failures. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3147). +* FEATURE: [vmgateway](https://docs.victoriametrics.com/vmgateway.html): add ability to extract JWT authorization token from non-standard HTTP header by passing it via `-auth.httpHeader` command-line flag. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3054). * BUGFIX: [vmagent](https://docs.victoriametrics.com/vmagent.html): properly encode query params for aws signed requests, use `%20` instead of `+` as api requires. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3171). * BUGFIX: [vmagent](https://docs.victoriametrics.com/vmagent.html): properly parse relabel config when regex ending with escaped `$`. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3131). diff --git a/docs/vmgateway.md b/docs/vmgateway.md index 35179bf1d..a563e6b57 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -180,6 +180,8 @@ curl 'http://localhost:8431/api/v1/labels' -H 'Authorization: Bearer eyJhbGciOiJ The shortlist of configuration flags include the following: ```console + -auth.httpHeader + HTTP header name to look for JWT authorization token -clusterMode enable this for the cluster version -datasource.appendTypePrefix