From 4e0a2bd39df5140b5290028e6f8a7de0574aaacf Mon Sep 17 00:00:00 2001 From: Dao Thanh Tung Date: Thu, 18 May 2023 22:27:19 +0800 Subject: [PATCH] docs: Add doc changes for tls argument in external scaler (#1133) Signed-off-by: dttung2905 --- content/docs/2.11/scalers/external-push.md | 16 +++++++++++++--- content/docs/2.11/scalers/external.md | 11 +++++++++-- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/content/docs/2.11/scalers/external-push.md b/content/docs/2.11/scalers/external-push.md index 592db35231e..dd9dc8b5fc7 100644 --- a/content/docs/2.11/scalers/external-push.md +++ b/content/docs/2.11/scalers/external-push.md @@ -15,13 +15,20 @@ triggers: - type: external-push metadata: scalerAddress: external-scaler-service:8080 - tlsCertFile: /path/to/tls/cert.pem # optional + 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 ``` **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 +53,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 71658fd8c10..8fc486d21a7 100644 --- a/content/docs/2.11/scalers/external.md +++ b/content/docs/2.11/scalers/external.md @@ -15,13 +15,20 @@ triggers: - type: external metadata: scalerAddress: external-scaler-service:8080 - tlsCertFile : /path/to/tls/cert.pem + 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 ``` **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).