Skip to content

Commit

Permalink
Feat: MongoDB scaler add scheme field description (#1326)
Browse files Browse the repository at this point in the history
Signed-off-by: tico88612 <17496418+tico88612@users.noreply.github.com>
  • Loading branch information
tico88612 authored Mar 12, 2024
1 parent 143a577 commit 5d5ecc9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion content/docs/2.14/scalers/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Alternatively, you can configure connection parameters explicitly instead of pro
triggers:
- type: mongodb
metadata:
# scheme of the MongoDB server. if using MongoDB Altas, you can set it to "mongodb+srv"
scheme: "mongodb"
# host name of the MongoDB server. Example of mongodb service: "mongodb-svc.<namespace>.svc.cluster.local"
host: mongodb-svc.default.svc.cluster.local
# port number of the MongoDB server.
Expand Down Expand Up @@ -70,6 +72,7 @@ To connect to the MongoDB server, you can provide either:

Or provide more detailed connection parameters explicitly (a connection string will be generated for you at runtime):

- `scheme` - The scheme of the MongoDB server, if using MongoDB Atlas, you can set it to `mongodb+srv`. (Default: `mongodb`, Optional)
- `host` - The host name of the MongoDB server.
- `port` - The port number of the MongoDB server.
- `username` - Username to authenticate with to MongoDB database.
Expand All @@ -78,7 +81,7 @@ Or provide more detailed connection parameters explicitly (a connection string w
When configuring with a connection string, you can use this URL format:

```
mongodb://<username>:<password>@mongodb-svc.<namespace>.svc.cluster.local:27017/<database_name>
mongodb[+srv]://<username>:<password>@mongodb-svc.<namespace>.svc.cluster.local:27017/<database_name>
```


Expand All @@ -92,6 +95,7 @@ As an alternative to environment variables, You can authenticate with the MongoD

**Password Authentication:**

- `scheme` - The scheme of the MongoDB server, if using MongoDB Atlas, you can set it to `mongodb+srv`. (Default: `mongodb`, Optional)
- `host` - The host name of the MongoDB server.
- `port` - The port number of the MongoDB server.
- `username` - Username to authenticate with to MongoDB database.
Expand Down

0 comments on commit 5d5ecc9

Please sign in to comment.