Skip to content

Commit 50379f6

Browse files
authored
feat: update IBM MQ scaler docs for TLS support (#1433)
Signed-off-by: rickbrouwer <[email protected]>
1 parent 32351ed commit 50379f6

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

content/docs/2.15/scalers/ibm-mq.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ triggers:
2323
activationQueueDepth: <activation-queue-depth> # OPTIONAL - Activation queue depth target. Default: 0 messages
2424
usernameFromEnv: <admin-user> # Optional: Provide admin username from env instead of as a secret
2525
passwordFromEnv: <admin-password> # Optional: Provide admin password from env instead of as a secret
26+
unsafeSsl: <SSL enabled/disabled> # OPTIONAL - Set 'true' for unsafe SSL. Default: false
2627
```
2728
2829
**Parameter list:**
@@ -35,6 +36,7 @@ triggers:
3536
- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional)
3637
- `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional)
3738
- `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional)
39+
- `unsafeSsl` - Whether to allow unsafe SSL (Values: `true`, `false`, Default: `false` )
3840

3941
### Authentication Parameters
4042

@@ -44,11 +46,17 @@ TriggerAuthentication CRD is used to connect and authenticate to IBM MQ:
4446

4547
- `ADMIN_USER` - REQUIRED - The admin REST endpoint username for your MQ Queue Manager`.
4648
- `ADMIN_PASSWORD` - REQUIRED - The admin REST endpoint API key for your MQ Queue Manager.
49+
- `ca` - Certificate authority file for TLS client authentication. (Optional)
50+
- `cert` - Certificate for client authentication. (Optional)
51+
- `key` - Key for client authentication. (Optional)
52+
- `keyPassword` - If set the keyPassword is used to decrypt the provided key. (Optional)
4753
- `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional)
4854
- `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional)
4955

5056
### Example
5157

58+
Example with Basic Auth
59+
5260
```yaml
5361
apiVersion: v1
5462
kind: Secret
@@ -98,3 +106,64 @@ spec:
98106
name: keda-ibmmq-secret
99107
key: ADMIN_PASSWORD
100108
```
109+
110+
### Example
111+
112+
Example with Basic Auth and TLS
113+
114+
```yaml
115+
apiVersion: v1
116+
kind: Secret
117+
metadata:
118+
name: keda-ibmmq-secret
119+
data:
120+
ADMIN_USER: <encoded-username> # REQUIRED - Admin Username
121+
ADMIN_PASSWORD: <encoded-password> # REQUIRED - Admin Password
122+
cert: <your tls.crt>
123+
key: <your tls.key>
124+
---
125+
apiVersion: keda.sh/v1alpha1
126+
kind: ScaledObject
127+
metadata:
128+
name: ibmmq-scaledobject
129+
namespace: default
130+
labels:
131+
deploymentName: ibmmq-deployment
132+
spec:
133+
scaleTargetRef:
134+
name: ibmmq-deployment
135+
pollingInterval: 5 # OPTIONAL - Default: 30 seconds
136+
cooldownPeriod: 30 # OPTIONAL - Default: 300 seconds
137+
maxReplicaCount: 18 # OPTIONAL - Default: 100
138+
triggers:
139+
- type: ibmmq
140+
metadata:
141+
host: <ibm-host> # REQUIRED - IBM MQ Queue Manager Admin REST Endpoint
142+
queueManager: <queue-manager> # REQUIRED - Your queue manager
143+
queueName: <queue-name> # REQUIRED - Your queue name
144+
tlsDisabled: <TLS enabled/disabled> # OPTIONAL - Set 'true' to disable TLS. Default: false
145+
queueDepth: <queue-depth> # OPTIONAL - Queue depth target for HPA. Default: 5 messages
146+
authenticationRef:
147+
name: keda-ibmmq-trigger-auth
148+
---
149+
apiVersion: keda.sh/v1alpha1
150+
kind: TriggerAuthentication
151+
metadata:
152+
name: keda-ibmmq-trigger-auth
153+
namespace: default
154+
spec:
155+
secretTargetRef:
156+
- parameter: username
157+
name: keda-ibmmq-secret
158+
key: ADMIN_USER
159+
- parameter: password
160+
name: keda-ibmmq-secret
161+
key: ADMIN_PASSWORD
162+
- parameter: cert
163+
name: keda-ibmmq-secret
164+
key: cert
165+
- parameter: key
166+
name: keda-ibmmq-secret
167+
key: key
168+
```
169+

0 commit comments

Comments
 (0)