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

docs: add oldest unacked message age metric documentation update for GCP Pub/Sub Scaler #579

Merged
merged 2 commits into from
Nov 23, 2021
Merged

docs: add oldest unacked message age metric documentation update for GCP Pub/Sub Scaler #579

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd5df1c
update gcp scaler documentation
Nov 12, 2021
5018545
add info about deprecation of subscriptionSize field
Nov 18, 2021
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
12 changes: 7 additions & 5 deletions content/docs/2.5/scalers/gcp-pub-sub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,17 @@ This specification describes the `gcp-pubsub` trigger for Google Cloud Platform
triggers:
- type: gcp-pubsub
metadata:
subscriptionSize: "5" # Optional - Default is 5
mode: "SubscriptionSize" # Optional - Default is SubscriptionSize - SubscriptionSize or OldestUnackedMessageAge
value: "5" # Optional - Default is 5 for SubscriptionSize | Default is 10 for OldestUnackedMessageAge
fira42073 marked this conversation as resolved.
Show resolved Hide resolved
subscriptionName: "mysubscription" # Required
credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required
```

The Google Cloud Platform‎ (GCP) Pub/Sub trigger allows you to scale based on the number of messages in your Pub/Sub subscription.
The Google Cloud Platform‎ (GCP) Pub/Sub trigger allows you to scale based on the number of messages or oldest unacked message age in your Pub/Sub subscription.

The `credentialsFromEnv` property maps to the name of an environment variable in the scale target (`scaleTargetRef`) that contains the service account credentials (JSON). KEDA will use those to connect to Google Cloud Platform and collect the required stack driver metrics in order to read the number of messages in the Pub/Sub subscription.

`subscriptionName` defines the subscription that should be monitored. The `subscriptionSize` determines the target average which the deployment will be scaled on. The default `subscriptionSize` is 5.
`subscriptionName` defines the subscription that should be monitored. The mode chooses whether to scale using number of messages `SubscriptionSize` or using oldest unacked message age `OldestUnackedMessageAge`. The `value` determines the target average which the deployment will be scaled on. The default value is 5 for `SubscriptionSize` and 10 for `OldestUnackedMessageAge`.

Here's an [example](https://github.com/kedacore/sample-go-gcppubsub).

Expand All @@ -50,7 +51,8 @@ spec:
triggers:
- type: gcp-pubsub
metadata:
subscriptionSize: "5"
mode: "SubscriptionSize"
value: "5"
subscriptionName: "mysubscription" # Required
credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required
```
Expand Down Expand Up @@ -111,4 +113,4 @@ spec:
name: keda-trigger-auth-gcp-credentials
metadata:
subscriptionName: "input" # Required
```
```