Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: update IBM MQ scaler docs for TLS support #1433

Merged
merged 1 commit into from
Jul 25, 2024
Merged

feat: update IBM MQ scaler docs for TLS support #1433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions content/docs/2.15/scalers/ibm-mq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ triggers:
activationQueueDepth: <activation-queue-depth> # OPTIONAL - Activation queue depth target. Default: 0 messages
usernameFromEnv: <admin-user> # Optional: Provide admin username from env instead of as a secret
passwordFromEnv: <admin-password> # Optional: Provide admin password from env instead of as a secret
unsafeSsl: <SSL enabled/disabled> # OPTIONAL - Set 'true' for unsafe SSL. Default: false
```

**Parameter list:**
Expand All @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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: <encoded-username> # REQUIRED - Admin Username
ADMIN_PASSWORD: <encoded-password> # REQUIRED - Admin Password
cert: <your tls.crt>
key: <your tls.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: <ibm-host> # REQUIRED - IBM MQ Queue Manager Admin REST Endpoint
queueManager: <queue-manager> # REQUIRED - Your queue manager
queueName: <queue-name> # REQUIRED - Your queue name
tlsDisabled: <TLS enabled/disabled> # OPTIONAL - Set 'true' to disable TLS. Default: false
queueDepth: <queue-depth> # 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
```

Loading