From a5b0efa3ecf90dc95c6849becd256f21b1b05769 Mon Sep 17 00:00:00 2001 From: Xinzhu Zhou Date: Sun, 29 May 2022 16:23:06 +0800 Subject: [PATCH 1/5] update doc for prometheus scaler Signed-off-by: Xinzhu Zhou --- config.toml | 2 +- content/docs/2.8/scalers/prometheus.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/config.toml b/config.toml index caef10f9b..9666ff508 100644 --- a/config.toml +++ b/config.toml @@ -29,7 +29,7 @@ alpine_js_version = "2.2.1" favicon = "favicon.png" [params.versions] -docs = ["2.7", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.5", "1.4"] +docs = ["2.8","2.7", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.5", "1.4"] # Site fonts. For more options see https://fonts.google.com. [[params.fonts]] diff --git a/content/docs/2.8/scalers/prometheus.md b/content/docs/2.8/scalers/prometheus.md index 3f6be6aa7..6e2bafc51 100644 --- a/content/docs/2.8/scalers/prometheus.md +++ b/content/docs/2.8/scalers/prometheus.md @@ -23,6 +23,7 @@ triggers: # Optional fields: namespace: example-namespace # for namespaced queries, eg. Thanos cortexOrgId: my-org # Optional. X-Scope-OrgID header for Cortex. + ignoreNullValues: disable # Default is enable, which means ignoring the empty value list from prometheus. Set to disable the scaler will return error when prometheus target is lost ``` **Parameter list:** @@ -33,6 +34,7 @@ triggers: - `threshold` - Value to start scaling for. - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgId` - The `X-Scope-OrgID` header to query multi tenant [Cortex](https://cortexmetrics.io/). (Optional) +- `ignoreNullValues` - Default is `enable`, set to `disable` to reporting error when prometheus target is lost. (Optional) ### Authentication Parameters @@ -289,4 +291,4 @@ spec: authModes: "tls,basic" authenticationRef: name: keda-prom-creds -``` \ No newline at end of file +``` From a287c42647854c1103c314e710418a9ccb6093b8 Mon Sep 17 00:00:00 2001 From: Xinzhu Zhou Date: Sun, 29 May 2022 16:33:01 +0800 Subject: [PATCH 2/5] revert params.version Signed-off-by: Xinzhu Zhou --- config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.toml b/config.toml index 9666ff508..caef10f9b 100644 --- a/config.toml +++ b/config.toml @@ -29,7 +29,7 @@ alpine_js_version = "2.2.1" favicon = "favicon.png" [params.versions] -docs = ["2.8","2.7", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.5", "1.4"] +docs = ["2.7", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.5", "1.4"] # Site fonts. For more options see https://fonts.google.com. [[params.fonts]] From 3e94d57a17cbcf8b1570611af3d6d05c603bfdd6 Mon Sep 17 00:00:00 2001 From: Xinzhu Zhou Date: Mon, 30 May 2022 11:34:18 +0800 Subject: [PATCH 3/5] update according to review Signed-off-by: Xinzhu Zhou --- content/docs/2.8/scalers/prometheus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/2.8/scalers/prometheus.md b/content/docs/2.8/scalers/prometheus.md index 6e2bafc51..05212a3ea 100644 --- a/content/docs/2.8/scalers/prometheus.md +++ b/content/docs/2.8/scalers/prometheus.md @@ -34,7 +34,7 @@ triggers: - `threshold` - Value to start scaling for. - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgId` - The `X-Scope-OrgID` header to query multi tenant [Cortex](https://cortexmetrics.io/). (Optional) -- `ignoreNullValues` - Default is `enable`, set to `disable` to reporting error when prometheus target is lost. (Optional) +- `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `enable`,`disable`, Default: `enable`, Optional) ### Authentication Parameters From 4f5ea7680a39d50e6cd253d06f9a6fcce3f73e03 Mon Sep 17 00:00:00 2001 From: Xinzhu Zhou Date: Mon, 30 May 2022 14:54:54 +0800 Subject: [PATCH 4/5] use true/false insteads of enable/disable Signed-off-by: Xinzhu Zhou --- content/docs/2.8/scalers/prometheus.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/2.8/scalers/prometheus.md b/content/docs/2.8/scalers/prometheus.md index 05212a3ea..3eadf6591 100644 --- a/content/docs/2.8/scalers/prometheus.md +++ b/content/docs/2.8/scalers/prometheus.md @@ -23,7 +23,7 @@ triggers: # Optional fields: namespace: example-namespace # for namespaced queries, eg. Thanos cortexOrgId: my-org # Optional. X-Scope-OrgID header for Cortex. - ignoreNullValues: disable # Default is enable, which means ignoring the empty value list from prometheus. Set to disable the scaler will return error when prometheus target is lost + ignoreNullValues: false # Default is true, which means ignoring the empty value list from prometheus. Set to false the scaler will return error when prometheus target is lost ``` **Parameter list:** @@ -34,7 +34,7 @@ triggers: - `threshold` - Value to start scaling for. - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgId` - The `X-Scope-OrgID` header to query multi tenant [Cortex](https://cortexmetrics.io/). (Optional) -- `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `enable`,`disable`, Default: `enable`, Optional) +- `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional) ### Authentication Parameters From e1d25388d8a3026d25ba1d2145e559fcc2cabb0b Mon Sep 17 00:00:00 2001 From: Xinzhu Zhou Date: Tue, 31 May 2022 16:35:25 +0800 Subject: [PATCH 5/5] fix typo Signed-off-by: Xinzhu Zhou --- content/docs/2.8/scalers/prometheus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/2.8/scalers/prometheus.md b/content/docs/2.8/scalers/prometheus.md index 3eadf6591..dbe8cdbfe 100644 --- a/content/docs/2.8/scalers/prometheus.md +++ b/content/docs/2.8/scalers/prometheus.md @@ -23,7 +23,7 @@ triggers: # Optional fields: namespace: example-namespace # for namespaced queries, eg. Thanos cortexOrgId: my-org # Optional. X-Scope-OrgID header for Cortex. - ignoreNullValues: false # Default is true, which means ignoring the empty value list from prometheus. Set to false the scaler will return error when prometheus target is lost + ignoreNullValues: false # Default is `true`, which means ignoring the empty value list from Prometheus. Set to `false` the scaler will return error when Prometheus target is lost ``` **Parameter list:**