Skip to content

Commit

Permalink
Solace scaler file name fix (kedacore#705)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored Mar 10, 2022
1 parent 66905f4 commit bbecc5d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 7 deletions.
3 changes: 0 additions & 3 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,3 @@ IgnoreDirectoryMissingTrailingSlash: true
CheckExternal: false
IgnoreAltMissing: true
IgnoreEmptyHref: true
IgnoreInternalURLs:
- /docs/2.6/scalers/solace-pub-sub/ # Due to https://github.com/kedacore/keda-docs/issues/693
- /docs/latest/scalers/solace-pub-sub/ # Due to https://github.com/kedacore/keda-docs/issues/693
2 changes: 1 addition & 1 deletion content/docs/2.4/scalers/solace-pub-sub.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ spec:
queueName: SCALED_CONSUMER_QUEUE1
messageCountTarget: '50'
messageSpoolUsageTarget: '100000'
authenticationRef:
authenticationRef:
name: solace-trigger-auth
---
apiVersion: keda.sh/v1alpha1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ maintainer = "Community"
description = "Scale applications based on Solace PubSub+ Event Broker Queues"
layout = "scaler"
go_file = "solace_scaler"
aliases = ["solace"]
+++

### Trigger Specification

This specification describes the `solace-event-queue` trigger that scales based on a Solace PubSub+ Event Broker queue.

```yaml
Expand All @@ -26,6 +28,7 @@ triggers:
```
**Parameter list:**
- `solaceSempBaseURL` - Solace SEMP Endpoint in format: `<protocol>://<host-or-service>:<port>`.
- `messageVpn` - Message VPN hosted on the Solace broker.
- `queueName` - Message Queue to be monitored.
Expand All @@ -37,18 +40,21 @@ triggers:
- `passwordFromEnv` - Environment variable set with password for the user account.

**Parameter Requirements:**

- Parameters resolving the target queue are all **required:** `solaceSempBaseURL`, `messageVpn`, `queueName`
- **At least** one of `messageCountTarget` or `messageSpoolUsageTarget` is **required.** If both values are present, the metric value resulting in the higher desired replicas will be used. (Standard KEDA/HPA behavior)
- The Solace PubSub+ Scaler polls the Solace SEMP REST API to monitor target queues. Currently, the scaler supports basic authentication. `username` and `password` are **required** for the `solace-event-queue` trigger to function. These values may be set directly in the trigger metadata or using a TriggerAuthentication record. See [Authentication Parameters](#authentication-parameters) below. Alternatively, credentials may be passed from environment variables identified by `usernameFromEnv` and `passwordFromEnv`.

### Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

**Username and Password based authentication:**
- `username` - Required. The username to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.
- `password` - Required. The password to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.

### Example

The objects in the example below are declared in `namespace=solace`. It is not required to do so. If you do define a namespace for the configuration objects, then they should all be delcared in the same namespace.

```yaml
Expand Down Expand Up @@ -86,7 +92,7 @@ spec:
queueName: SCALED_CONSUMER_QUEUE1
messageCountTarget: '50'
messageSpoolUsageTarget: '100000'
authenticationRef:
authenticationRef:
name: solace-trigger-auth
---
apiVersion: keda.sh/v1alpha1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ maintainer = "Community"
description = "Scale applications based on Solace PubSub+ Event Broker Queues"
layout = "scaler"
go_file = "solace_scaler"
aliases = ["solace"]
+++

### Trigger Specification

This specification describes the `solace-event-queue` trigger that scales based on a Solace PubSub+ Event Broker queue.

```yaml
Expand All @@ -26,6 +28,7 @@ triggers:
```
**Parameter list:**
- `solaceSempBaseURL` - Solace SEMP Endpoint in format: `<protocol>://<host-or-service>:<port>`.
- `messageVpn` - Message VPN hosted on the Solace broker.
- `queueName` - Message Queue to be monitored.
Expand All @@ -37,18 +40,21 @@ triggers:
- `passwordFromEnv` - Environment variable set with password for the user account.

**Parameter Requirements:**

- Parameters resolving the target queue are all **required:** `solaceSempBaseURL`, `messageVpn`, `queueName`
- **At least** one of `messageCountTarget` or `messageSpoolUsageTarget` is **required.** If both values are present, the metric value resulting in the higher desired replicas will be used. (Standard KEDA/HPA behavior)
- The Solace PubSub+ Scaler polls the Solace SEMP REST API to monitor target queues. Currently, the scaler supports basic authentication. `username` and `password` are **required** for the `solace-event-queue` trigger to function. These values may be set directly in the trigger metadata or using a TriggerAuthentication record. See [Authentication Parameters](#authentication-parameters) below. Alternatively, credentials may be passed from environment variables identified by `usernameFromEnv` and `passwordFromEnv`.

### Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

**Username and Password based authentication:**
- `username` - Required. The username to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.
- `password` - Required. The password to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.

### Example

The objects in the example below are declared in `namespace=solace`. It is not required to do so. If you do define a namespace for the configuration objects, then they should all be delcared in the same namespace.

```yaml
Expand Down Expand Up @@ -86,7 +92,7 @@ spec:
queueName: SCALED_CONSUMER_QUEUE1
messageCountTarget: '50'
messageSpoolUsageTarget: '100000'
authenticationRef:
authenticationRef:
name: solace-trigger-auth
---
apiVersion: keda.sh/v1alpha1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ go_file = "solace_scaler"
+++

### Trigger Specification

This specification describes the `solace-event-queue` trigger that scales based on a Solace PubSub+ Event Broker queue.

```yaml
Expand All @@ -26,6 +27,7 @@ triggers:
```
**Parameter list:**
- `solaceSempBaseURL` - Solace SEMP Endpoint in format: `<protocol>://<host-or-service>:<port>`.
- `messageVpn` - Message VPN hosted on the Solace broker.
- `queueName` - Message Queue to be monitored.
Expand All @@ -37,18 +39,21 @@ triggers:
- `passwordFromEnv` - Environment variable set with password for the user account.

**Parameter Requirements:**

- Parameters resolving the target queue are all **required:** `solaceSempBaseURL`, `messageVpn`, `queueName`
- **At least** one of `messageCountTarget` or `messageSpoolUsageTarget` is **required.** If both values are present, the metric value resulting in the higher desired replicas will be used. (Standard KEDA/HPA behavior)
- The Solace PubSub+ Scaler polls the Solace SEMP REST API to monitor target queues. Currently, the scaler supports basic authentication. `username` and `password` are **required** for the `solace-event-queue` trigger to function. These values may be set directly in the trigger metadata or using a TriggerAuthentication record. See [Authentication Parameters](#authentication-parameters) below. Alternatively, credentials may be passed from environment variables identified by `usernameFromEnv` and `passwordFromEnv`.

### Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

**Username and Password based authentication:**
- `username` - Required. The username to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.
- `password` - Required. The password to use to connect to the Solace PubSub+ Event Broker's SEMP endpoint.

### Example

The objects in the example below are declared in `namespace=solace`. It is not required to do so. If you do define a namespace for the configuration objects, then they should all be delcared in the same namespace.

```yaml
Expand Down Expand Up @@ -86,7 +91,7 @@ spec:
queueName: SCALED_CONSUMER_QUEUE1
messageCountTarget: '50'
messageSpoolUsageTarget: '100000'
authenticationRef:
authenticationRef:
name: solace-trigger-auth
---
apiVersion: keda.sh/v1alpha1
Expand Down

0 comments on commit bbecc5d

Please sign in to comment.