-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Ahmed ElSayed <ahmels@microsoft.com>
- Loading branch information
1 parent
735b339
commit 388630b
Showing
1 changed file
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
+++ | ||
title = "External Push" | ||
layout = "scaler" | ||
availability = "v2.0+" | ||
maintainer = "Microsoft" | ||
description = "Scale applications based on an external push scaler." | ||
go_file = "external_scaler" | ||
+++ | ||
|
||
### Trigger Specification | ||
|
||
This specification describes the `external-push` trigger for an external push scaler. | ||
|
||
```yaml | ||
triggers: | ||
- type: external-push | ||
metadata: | ||
scalerAddress: external-scaler-service:8080 | ||
tlsCertFile: /path/to/tls/cert.pem # optional | ||
``` | ||
**Parameter list:** | ||
- `scalerAddress`: "hostname:port" of the external push scaler implementing `ExternalScaler.StreamIsActive` in externalscaler.proto. | ||
- `tlsCertFile`: optional path for a certificate to use for the GRPC connection | ||
|
||
The entire metadata object is passed to the external scaler in `ScaledObjectRef.scalerMetadata` | ||
|
||
### Authentication Parameters | ||
|
||
Not supported. | ||
|
||
### Example | ||
|
||
```yaml | ||
apiVersion: keda.k8s.io/v1alpha1 | ||
kind: ScaledObject | ||
metadata: | ||
name: name | ||
namespace: namespace | ||
spec: | ||
scaleTargetRef: | ||
deploymentName: keda-node | ||
triggers: | ||
- type: external-push | ||
metadata: | ||
scalerAddress: external-scaler-service:8080 | ||
tlsCertFile: /path/to/tls/cert.pem # optional | ||
``` |