From 7bd5101c18372b9523d6ae4fc8e79a9633683764 Mon Sep 17 00:00:00 2001 From: dttung2905 Date: Wed, 17 May 2023 22:04:00 +0800 Subject: [PATCH 1/2] Add doc changes for tls argument in external scaler Signed-off-by: dttung2905 --- content/docs/2.11/scalers/external-push.md | 15 ++++++++++++--- content/docs/2.11/scalers/external.md | 10 ++++++++-- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/content/docs/2.11/scalers/external-push.md b/content/docs/2.11/scalers/external-push.md index 592db3523..48236181c 100644 --- a/content/docs/2.11/scalers/external-push.md +++ b/content/docs/2.11/scalers/external-push.md @@ -15,13 +15,19 @@ triggers: - type: external-push metadata: scalerAddress: external-scaler-service:8080 - tlsCertFile: /path/to/tls/cert.pem # optional + caCert : /path/to/tls/ca.pem + tlsClientCert: /path/to/tls/cert.pem + tlsClientKey: /path/to/tls/key.pem + unsafeSsl: false ``` **Parameter list:** - `scalerAddress` - Address of the external push scaler implementing `ExternalScaler.StreamIsActive` in externalscaler.proto. Format must be `host:port`. -- `tlsCertFile` - Location of a certificate to use for the GRPC connection to authenticate with. (Optional) +- `caCert` - Location of a Certificate Authority (CA) certificate to use for the GRPC connection to authenticate with. (Optional) +- `tlsClientCert` - Location of a client certificate to use for the GRPC connection to authenticate with. (Optional) +- `tlsClientKey` - Location of a client private key to use for the GRPC connection to authenticate with. (Optional) +- `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) The entire metadata object is passed to the external scaler in `ScaledObjectRef.scalerMetadata`. @@ -46,5 +52,8 @@ spec: - type: external-push metadata: scalerAddress: external-scaler-service:8080 - tlsCertFile: /path/to/tls/cert.pem # optional + caCert : /path/to/tls/ca.pem + tlsClientCert: /path/to/tls/cert.pem + tlsClientKey: /path/to/tls/key.pem + unsafeSsl: false ``` diff --git a/content/docs/2.11/scalers/external.md b/content/docs/2.11/scalers/external.md index 71658fd8c..7ab555b5f 100644 --- a/content/docs/2.11/scalers/external.md +++ b/content/docs/2.11/scalers/external.md @@ -15,13 +15,19 @@ triggers: - type: external metadata: scalerAddress: external-scaler-service:8080 - tlsCertFile : /path/to/tls/cert.pem + caCert : /path/to/tls/ca.pem + tlsClientCert: /path/to/tls/cert.pem + tlsClientKey: /path/to/tls/key.pem + unsafeSsl: false ``` **Parameter list:** - `scalerAddress` - Address of the external scaler. Format must be `host:port`. -- `tlsCertFile` - Location of a certificate to use for the GRPC connection to authenticate with. (Optional) +- `caCert` - Location of a Certificate Authority (CA) certificate to use for the GRPC connection to authenticate with. (Optional) +- `tlsClientCert` - Location of a client certificate to use for the GRPC connection to authenticate with. (Optional) +- `tlsClientKey` - Location of a client private key to use for the GRPC connection to authenticate with. (Optional) +- `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) > For implementing an external scaler, refer to [External Scalers Concept](../concepts/external-scalers.md). From 0cd9c63e6efef486dbd0eb547bfbed08532331f1 Mon Sep 17 00:00:00 2001 From: dttung2905 Date: Thu, 18 May 2023 21:16:05 +0800 Subject: [PATCH 2/2] Add back and mark as deprecated arg Signed-off-by: dttung2905 --- content/docs/2.11/scalers/external-push.md | 1 + content/docs/2.11/scalers/external.md | 1 + 2 files changed, 2 insertions(+) diff --git a/content/docs/2.11/scalers/external-push.md b/content/docs/2.11/scalers/external-push.md index 48236181c..dd9dc8b5f 100644 --- a/content/docs/2.11/scalers/external-push.md +++ b/content/docs/2.11/scalers/external-push.md @@ -16,6 +16,7 @@ triggers: metadata: scalerAddress: external-scaler-service:8080 caCert : /path/to/tls/ca.pem + tlsCertFile: /path/to/tls/cert.pem # Deprecated. https://github.com/kedacore/keda/issues/4549 tlsClientCert: /path/to/tls/cert.pem tlsClientKey: /path/to/tls/key.pem unsafeSsl: false diff --git a/content/docs/2.11/scalers/external.md b/content/docs/2.11/scalers/external.md index 7ab555b5f..8fc486d21 100644 --- a/content/docs/2.11/scalers/external.md +++ b/content/docs/2.11/scalers/external.md @@ -16,6 +16,7 @@ triggers: metadata: scalerAddress: external-scaler-service:8080 caCert : /path/to/tls/ca.pem + tlsCertFile: /path/to/tls/cert.pem # Deprecated. https://github.com/kedacore/keda/issues/4549 tlsClientCert: /path/to/tls/cert.pem tlsClientKey: /path/to/tls/key.pem unsafeSsl: false