From a842b3ac6fc2fb9f939b720a85e722444a65c8da Mon Sep 17 00:00:00 2001 From: rickbrouwer <75609067+rickbrouwer@users.noreply.github.com> Date: Tue, 23 Jul 2024 15:05:00 +0200 Subject: [PATCH] feat: update IBM MQ scaler docs for TLS support Signed-off-by: rickbrouwer <75609067+rickbrouwer@users.noreply.github.com> --- content/docs/2.15/scalers/ibm-mq.md | 69 +++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/content/docs/2.15/scalers/ibm-mq.md b/content/docs/2.15/scalers/ibm-mq.md index 786e66ee2..dd1e83934 100644 --- a/content/docs/2.15/scalers/ibm-mq.md +++ b/content/docs/2.15/scalers/ibm-mq.md @@ -23,6 +23,7 @@ triggers: activationQueueDepth: # OPTIONAL - Activation queue depth target. Default: 0 messages usernameFromEnv: # Optional: Provide admin username from env instead of as a secret passwordFromEnv: # Optional: Provide admin password from env instead of as a secret + unsafeSsl: # OPTIONAL - Set 'true' for unsafe SSL. Default: false ``` **Parameter list:** @@ -35,6 +36,7 @@ triggers: - `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) +- `unsafeSsl` - Whether to allow unsafe SSL (Values: `true`, `false`, Default: `false` ) ### Authentication Parameters @@ -44,11 +46,17 @@ TriggerAuthentication CRD is used to connect and authenticate to IBM MQ: - `ADMIN_USER` - REQUIRED - The admin REST endpoint username for your MQ Queue Manager`. - `ADMIN_PASSWORD` - REQUIRED - The admin REST endpoint API key for your MQ Queue Manager. +- `ca` - Certificate authority file for TLS client authentication. (Optional) +- `cert` - Certificate for client authentication. (Optional) +- `key` - Key for client authentication. (Optional) +- `keyPassword` - If set the keyPassword is used to decrypt the provided key. (Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) ### Example +Example with Basic Auth + ```yaml apiVersion: v1 kind: Secret @@ -98,3 +106,64 @@ spec: name: keda-ibmmq-secret key: ADMIN_PASSWORD ``` + +### Example + +Example with Basic Auth and TLS + +```yaml +apiVersion: v1 +kind: Secret +metadata: + name: keda-ibmmq-secret +data: + ADMIN_USER: # REQUIRED - Admin Username + ADMIN_PASSWORD: # REQUIRED - Admin Password + cert: + key: +--- +apiVersion: keda.sh/v1alpha1 +kind: ScaledObject +metadata: + name: ibmmq-scaledobject + namespace: default + labels: + deploymentName: ibmmq-deployment +spec: + scaleTargetRef: + name: ibmmq-deployment + pollingInterval: 5 # OPTIONAL - Default: 30 seconds + cooldownPeriod: 30 # OPTIONAL - Default: 300 seconds + maxReplicaCount: 18 # OPTIONAL - Default: 100 + triggers: + - type: ibmmq + metadata: + host: # REQUIRED - IBM MQ Queue Manager Admin REST Endpoint + queueManager: # REQUIRED - Your queue manager + queueName: # REQUIRED - Your queue name + tlsDisabled: # OPTIONAL - Set 'true' to disable TLS. Default: false + queueDepth: # OPTIONAL - Queue depth target for HPA. Default: 5 messages + authenticationRef: + name: keda-ibmmq-trigger-auth +--- +apiVersion: keda.sh/v1alpha1 +kind: TriggerAuthentication +metadata: + name: keda-ibmmq-trigger-auth + namespace: default +spec: + secretTargetRef: + - parameter: username + name: keda-ibmmq-secret + key: ADMIN_USER + - parameter: password + name: keda-ibmmq-secret + key: ADMIN_PASSWORD + - parameter: cert + name: keda-ibmmq-secret + key: cert + - parameter: key + name: keda-ibmmq-secret + key: key +``` +