From c92af05e9e0bdc47e94f0dd8e0df8fdfddae5b80 Mon Sep 17 00:00:00 2001 From: Rick Brouwer Date: Mon, 5 Aug 2024 12:08:05 +0200 Subject: [PATCH 1/3] Remove unused variables and correct queueDepth default in IBM MQ scaler Signed-off-by: Rick Brouwer --- content/docs/2.16/scalers/ibm-mq.md | 35 +++++++++++------------------ 1 file changed, 13 insertions(+), 22 deletions(-) diff --git a/content/docs/2.16/scalers/ibm-mq.md b/content/docs/2.16/scalers/ibm-mq.md index dd1e83934..b2c44284b 100644 --- a/content/docs/2.16/scalers/ibm-mq.md +++ b/content/docs/2.16/scalers/ibm-mq.md @@ -16,27 +16,25 @@ 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 + tlsDisabled: # DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.17 + queueDepth: # OPTIONAL - Queue depth target for HPA. Default: 20 messages 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 + 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: "false" # OPTIONAL - Used for skipping certificate check when having self-signed certs 'true'. Default: false ``` **Parameter list:** - `host` - IBM MQ Queue Manager Admin REST Endpoint. Example URI endpoint structure on IBM cloud `https://example.mq.appdomain.cloud/ibmmq/rest/v2/admin/action/qmgr/QM/mqsc`. -- `queueManager` - Name of the queue manager from which messages will be consumed. -- `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. -- `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) -- `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) +- `queueName` - Name of the Queue defined from which messages will be consumed. +- `tlsDisabled` - Can be set to 'true' to disable TLS. (DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.17, Values: `true`, `false` , Default: `false`, Optional) +- `queueDepth` - Queue depth Target for HPA. (Default: `20`, Optional) - `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` ) +- `unsafeSsl` - Whether to allow unsafe SSL (Values: `true`, `false`, Default: `false`, Optional) ### Authentication Parameters @@ -83,12 +81,10 @@ spec: - 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 - usernameFromEnv: # Optional: Provide admin username from env instead of as a secret - passwordFromEnv: # Optional: Provide admin password from env instead of as a secret + queueDepth: # OPTIONAL - Queue depth target for HPA. Default: 20 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 authenticationRef: name: keda-ibmmq-trigger-auth --- @@ -107,8 +103,6 @@ spec: key: ADMIN_PASSWORD ``` -### Example - Example with Basic Auth and TLS ```yaml @@ -139,10 +133,8 @@ spec: - 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 + queueDepth: # OPTIONAL - Queue depth target for HPA. Default: 20 messages authenticationRef: name: keda-ibmmq-trigger-auth --- @@ -166,4 +158,3 @@ spec: name: keda-ibmmq-secret key: key ``` - From 74242f68f6401764f9f0da5c6b93a9e50e164af6 Mon Sep 17 00:00:00 2001 From: rickbrouwer Date: Tue, 20 Aug 2024 10:42:56 +0200 Subject: [PATCH 2/3] Update content/docs/2.16/scalers/ibm-mq.md Co-authored-by: Jorge Turrado Ferrero Signed-off-by: rickbrouwer --- content/docs/2.16/scalers/ibm-mq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/2.16/scalers/ibm-mq.md b/content/docs/2.16/scalers/ibm-mq.md index b2c44284b..a5885c4a8 100644 --- a/content/docs/2.16/scalers/ibm-mq.md +++ b/content/docs/2.16/scalers/ibm-mq.md @@ -17,7 +17,7 @@ triggers: metadata: host: # REQUIRED - IBM MQ Queue Manager Admin REST Endpoint queueName: # REQUIRED - Your queue name - tlsDisabled: # DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.17 + tlsDisabled: # DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.18 queueDepth: # OPTIONAL - Queue depth target for HPA. Default: 20 messages activationQueueDepth: # OPTIONAL - Activation queue depth target. Default: 0 messages usernameFromEnv: # OPTIONAL - Provide admin username from env instead of as a secret From 1b5436999a2f71950d30c1aecc06096c41e7aedf Mon Sep 17 00:00:00 2001 From: rickbrouwer Date: Tue, 20 Aug 2024 10:43:08 +0200 Subject: [PATCH 3/3] Update content/docs/2.16/scalers/ibm-mq.md Co-authored-by: Jorge Turrado Ferrero Signed-off-by: rickbrouwer --- content/docs/2.16/scalers/ibm-mq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/2.16/scalers/ibm-mq.md b/content/docs/2.16/scalers/ibm-mq.md index a5885c4a8..210b72ba7 100644 --- a/content/docs/2.16/scalers/ibm-mq.md +++ b/content/docs/2.16/scalers/ibm-mq.md @@ -29,7 +29,7 @@ triggers: - `host` - IBM MQ Queue Manager Admin REST Endpoint. Example URI endpoint structure on IBM cloud `https://example.mq.appdomain.cloud/ibmmq/rest/v2/admin/action/qmgr/QM/mqsc`. - `queueName` - Name of the Queue defined from which messages will be consumed. -- `tlsDisabled` - Can be set to 'true' to disable TLS. (DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.17, Values: `true`, `false` , Default: `false`, Optional) +- `tlsDisabled` - Can be set to 'true' to disable TLS. (DEPRECATED: This parameter is deprecated as of KEDA v2.16 in favor of unsafeSsl and will be removed in version v2.18, Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `20`, Optional) - `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)