eliott/Olares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add application environment variables (#2577)

Browse Source 
* docs: updated installation env vars and runtime values references

* docs: fix content

* docs: update content

* Update table of contents, and refactored docs.

* Fixed capitalization.

* batch update to fix readability

* refactored declarative env var

* Updated translation.

* Updated based on suggestions.

* Updated based on suggestions.

---------

Co-authored-by: yajing wang <413741312@qq.com>
This commit is contained in:
Meow33
2026-03-05 17:52:22 +08:00
committed by GitHub
parent 480cecfe84
commit 776848d2e2
28 changed files with 1294 additions and 350 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/developer/develop/mw-integrate-with-mongodb.md
View File

@@ -35,9 +35,9 @@ middleware:
# Please make sure each line is a complete query.
```
## Inject environment variables
## Map to environment variables
In your deployment YAML, map the injected `.Values.mongodb.*` fields to the environment variables your app uses.
In your deployment YAML, map the injected `.Values.mongodb.*` fields to the container environment variables your app requires.
**Example**
```yaml
@@ -63,14 +63,14 @@ containers:
value: "{{ .Values.mongodb.databases.app_db }}"
```
## MongoDB Values reference
## MongoDB values reference
MongoDB Values are predefined environment variables injected into `values.yaml` during deployment. They are system-managed and not user-editable.
MongoDB values are predefined runtime values injected into `values.yaml` during deployment. They are system-managed and not user-editable.
| Key | Type | Description |
|--|--|--|
| `.Values.mongodb.host` | String | MongoDB database host |
| `.Values.mongodb.port` | Number | MongoDB database port |
| `.Values.mongodb.username` | String | MongoDB database username |
| `.Values.mongodb.password` | String | MongoDB database password |
| `.Values.mongodb.databases` | Map<String,String> | The requested database name is used as the key. <br/>For example, if you request `app_db`, the value is available at `.Values.mongodb.databases.app_db`. |
| Value | Type | Description |
| --- | --- | --- |
| `.Values.mongodb.host` | String | MongoDB host. |
| `.Values.mongodb.port` | Number | MongoDB port. |
| `.Values.mongodb.username` | String | MongoDB username. |
| `.Values.mongodb.password` | String | MongoDB password. |
| `.Values.mongodb.databases` | Map\<String,String> | Requested databases, keyed by database name. For example, a request for `app_db` is available at `.Values.mongodb.databases.app_db`. |