Skip to content

Commit 61ecf4f

Browse files
authored
Create env_variables.md (#743)
Signed-off-by: Jael Gu <[email protected]>
1 parent c7619b4 commit 61ecf4f

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

docs/user_guide/env_variables.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Milvus Backup: Environment Variables
2+
3+
Milvus Backup supports environment variables for configuration and customization.
4+
These variables allow you to override settings defined in your configuration file or inject secrets and runtime options.
5+
6+
## How to Use Environment Variables
7+
8+
You can set environment variables in your shell before running Milvus Backup. For example:
9+
10+
```bash
11+
$ export MILVUS_PORT=29530
12+
$ ./milvus-backup server
13+
```
14+
15+
---
16+
17+
## Supported Environment Variables
18+
19+
> All variables are optional. If not set, defaults are used (see [`backup.yaml`](https://github.com/zilliztech/milvus-backup/blob/main/configs/backup.yaml)).
20+
>
21+
> For the latest list of supported environment variables, refer to [`paramtable/base_table.go`](https://github.com/zilliztech/milvus-backup/blob/main/core/paramtable/base_table.go) in the source code.
22+
23+
- [Milvus Connection](#milvus-connection)
24+
- [MinIO (Object Storage)](#minio-object-storage)
25+
- [Logging](#logging)
26+
- [HTTP API](#http-api)
27+
- [Others](#others)
28+
29+
### Milvus Connection
30+
31+
| Config Key | Env Variable | Description |
32+
|----------------------|---------------------|---------------------------------------------|
33+
| milvus.address | MILVUS_HOST | Milvus proxy address |
34+
| milvus.port | MILVUS_PORT | Milvus proxy port |
35+
| milvus.user | MILVUS_USER | Milvus user name |
36+
| milvus.password | MILVUS_PASSWORD | Milvus password |
37+
| milvus.caCertPath | MILVUS_CA_CERT_PATH | TLS CA certificate path |
38+
| milvus.serverName | MILVUS_SERVER_NAME | Milvus server name (TLS) |
39+
| milvus.mtlsCertPath | MILVUS_MTLS_CERT_PATH| Mutual TLS certificate path |
40+
| milvus.mtlsKeyPath | MILVUS_MTLS_KEY_PATH| Mutual TLS key path |
41+
42+
### MinIO (Object Storage)
43+
44+
| Config Key | Env Variable | Description |
45+
|-----------------------------|-----------------------|----------------------------------------------|
46+
| minio.address | MINIO_ADDRESS | MinIO server address |
47+
| minio.port | MINIO_PORT | MinIO server port |
48+
| minio.accessKeyID | MINIO_ACCESS_KEY | MinIO access key ID |
49+
| minio.secretAccessKey | MINIO_SECRET_KEY | MinIO secret access key |
50+
| minio.useSSL | MINIO_USE_SSL | Use SSL for MinIO |
51+
| minio.bucketName | MINIO_BUCKET_NAME | MinIO bucket name |
52+
| minio.gcpCredentialJSON | GCP_KEY_JSON | Path to GCP credentials JSON for MinIO |
53+
54+
#### Backup-specific MinIO Variables
55+
56+
| Config Key | Env Variable | Description |
57+
|-----------------------------------|-------------------------------|----------------------------------------------|
58+
| minio.backupBucketName | MINIO_BACKUP_BUCKET_NAME | Backup bucket name |
59+
| minio.backupAddress | MINIO_BACKUP_ADDRESS | Backup MinIO server address |
60+
| minio.backupPort | MINIO_BACKUP_PORT | Backup MinIO server port |
61+
| minio.backupAccessKeyID | MINIO_BACKUP_ACCESS_KEY | Backup MinIO access key ID |
62+
| minio.backupSecretAccessKey | MINIO_BACKUP_SECRET_KEY | Backup MinIO secret access key |
63+
| minio.backupUseSSL | MINIO_BACKUP_USE_SSL | Use SSL for backup MinIO |
64+
65+
### Logging
66+
67+
| Config Key | Env Variable | Description |
68+
|--------------------|------------------|--------------------------------------|
69+
| log.level | LOG_LEVEL | Logging level (`info`, `debug`, etc) |
70+
| log.console | LOG_CONSOLE | Print logs to console |
71+
| log.file.rootPath | LOG_FILE_PATH | Path to log file |
72+
73+
### HTTP API
74+
75+
| Config Key | Env Variable | Description |
76+
|---------------------|-----------------------|-------------------------------|
77+
| http.simpleResponse | HTTP_SIMPLE_RESPONSE | Enable simple HTTP responses |
78+
79+
### Others
80+
81+
| Config Key | Env Variable | Description |
82+
|-----------------------------|-------------------------------|-----------------------------------------------|
83+
| backup.maxSegmentGroupSize | BACKUP_MAX_SEGMENT_GROUP_SIZE | Maximum segment group size |
84+
| backup.parallelism.backupCollection | BACKUP_PARALLELISM_BACKUP_COLLECTION | Backup collection parallelism |
85+
| backup.keepTempFiles | BACKUP_KEEP_TEMP_FILES | Keep temporary files after backup |

0 commit comments

Comments
 (0)