-
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: 高强 <wb-gq555900@alibaba-inc.com>
- Loading branch information
高强
committed
Jan 23, 2021
1 parent
2ef1826
commit 86fef5f
Showing
1 changed file
with
115 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,115 @@ | ||
+++ | ||
title = "MongoDB" | ||
layout = "scaler" | ||
maintainer = "Community" | ||
description = "Scale applications based on MongoDB." | ||
availability = "v2.1+" | ||
go_file = "mongodb_scaler" | ||
+++ | ||
|
||
### Trigger Specification | ||
|
||
This specification describes the `mongodb` trigger that scales based on result of MongoDB query. | ||
|
||
```yaml | ||
triggers: | ||
- type: mongodb | ||
metadata: | ||
# Required: database name | ||
dbName: "test" | ||
# Required: collection name | ||
collection: "test_collection" | ||
# Required: query expr, used by filter data | ||
query: '{"region":"eu-1","state":"running","plan":"planA"}' | ||
# Required: according to the number of query result, to scale job | ||
queryValue: "1" | ||
# Optional: This value will be assign to the metric | ||
metricName: "global_metric" | ||
``` | ||
**Parameter list:** | ||
- `dbName` - Name of the database | ||
- `collection` - Name of the collection | ||
- `query` - A MongoDB query that should return single numeric value | ||
- `queryValue` - A threshold that will define when scaling should occur | ||
- `metricName` - An optional name to assign to the metric. | ||
|
||
To provide information about how to connect to MongoDB you can provide | ||
|
||
- `connectionStringFromEnv` - A MongoDB connection string that should point to environment variable with valid value | ||
|
||
Or provide more detailed information: | ||
|
||
- `host` - The host of the MongoDB server | ||
- `port` - The port of the MongoDB server | ||
- `username` - Username to authenticate with to MongoDB database | ||
- `passwordFromEnv` - Password for the given user | ||
|
||
### Authentication Parameters | ||
|
||
You can authenticate by using connection string or password authentication. | ||
|
||
**Connection String Authentication:** | ||
|
||
- `connectionString` - Connection string for MongoDB database | ||
|
||
**Password Authentication:** | ||
|
||
- `password` - Password for the configured user to login to MongoDB database variables. | ||
|
||
### Example | ||
|
||
Here is an example of how to deploy a scaled Job with the `MongoDB` scale trigger which uses `TriggerAuthentication`. | ||
|
||
```yaml | ||
apiVersion: keda.sh/v1alpha1 | ||
kind: ScaledJob | ||
metadata: | ||
name: mongodb-job | ||
spec: | ||
jobTargetRef: | ||
template: | ||
spec: | ||
containers: | ||
- name: mongodb-update | ||
image: 1314520999/mongodb-update:latest | ||
args: | ||
- --connectStr=mongodb://test_user:test_password@mongoDB-svc.mongoDB.svc.cluster.local:27017/test | ||
- --dataBase=test | ||
- --collection=test_collection | ||
imagePullPolicy: IfNotPresent | ||
restartPolicy: Never | ||
backoffLimit: 1 | ||
pollingInterval: 30 # Optional. Default: 30 seconds | ||
maxReplicaCount: 30 # Optional. Default: 100 | ||
successfulJobsHistoryLimit: 0 # Optional. Default: 100. How many completed jobs should be kept. | ||
failedJobsHistoryLimit: 10 # Optional. Default: 100. How many failed jobs should be kept. | ||
triggers: | ||
- type: mongodb | ||
metadata: | ||
dbName: "test" | ||
collection: "test_collection" | ||
query: '{"region":"eu-1","state":"running","plan":"planA"}' | ||
queryValue: "1" | ||
authenticationRef: | ||
name: mongoDB-trigger | ||
--- | ||
apiVersion: keda.sh/v1alpha1 | ||
kind: TriggerAuthentication | ||
metadata: | ||
name: mongoDB-trigger | ||
spec: | ||
secretTargetRef: | ||
- parameter: connectionString | ||
name: mongoDB-secret | ||
key: connect | ||
--- | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: mongoDB-secret | ||
type: Opaque | ||
data: | ||
connect: bW9uZ29kYjovL3Rlc3RfdXNlcjp0ZXN0X3Bhc3N3b3JkQG1vbmdvZGItc3ZjLm1vbmdvREIuc3ZjLmNsdXN0ZXIubG9jYWw6MjcwMTcvdGVzdA== | ||
``` |