config-secret 0.1.0

A source for the config crate that follows the Docker/Kubernetes secret configuration convention
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

# config-secret

![Rust](https://img.shields.io/badge/rust-stable-brightgreen.svg)
[![CI](https://github.com/touchifyapp/config-secret-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/touchifyapp/config-secret-rs/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/touchifyapp/config-secret-rs/branch/main/graph/badge.svg?token=02XS1EPT8O)](https://codecov.io/gh/touchifyapp/config-secret-rs)
[![Crates.io](https://img.shields.io/crates/d/config-secret.svg)](https://crates.io/crates/config-secret)
[![Docs.rs](https://docs.rs/config-secret/badge.svg)](https://docs.rs/config-secret)

`config-secret` is an additional source for the [config](https://github.com/mehcode/config-rs) crate that follows the Docker/Kubernetes convention.

It allows to inject some parts of your configuration by using a file specified as environment variable. [See examples](#examples).

## Installation

```toml
[dependencies]
config = "0.13"
config-secret = "0.1.0"
```

## Usage

```rust
use config::Config;
use config_secret::EnvironmentSecretFile;

let source = EnvironmentSecretFile::with_prefix("APP").separator("_");
let config = Config::builder().add_source(source).build().unwrap();
let settings = config.try_deserialize::<Settings>().unwrap();

// settings...
```

## Examples

### Definition

Let's introduce our types and our `config` initializer:

```rust
use config::{Config, ConfigError};
use config_secret::EnvironmentSecretFile;
use serde::Deserialize;

#[derive(Deserialize, Clone, Debug)]
pub struct Settings {
    pub server: ServerSettings,
    pub redis: RedisSettings,
}

#[derive(Deserialize, Clone, Debug)]
pub struct ServerSettings {
    pub host: String,
    pub port: u16,
}

#[derive(Deserialize, Clone, Debug)]
pub struct RedisSettings {
    pub nodes: Vec<String>,
    pub username: Option<String>,
    pub password: Option<String>,
}

pub fn get_settings() -> Result<Settings, ConfigError> {
    let config = Config::builder()
        .add_source(
            config::Environment::with_prefix("APP")
                .separator("_")
                .list_separator(",")
                .with_list_parse_key("redis.nodes")
                .try_parsing(true),
        )
        .add_source(
            EnvironmentSecretFile::with_prefix("APP")
                .separator("_")
        )
        .build()?;

    config.try_deserialize::<Settings>()
}
```

### Full configuration

We can add an environment variable to set a secret that configure the whole configuration:

```env
APP_FILE=/run/secrets/my_secret.json
```
```json
{
    "server": {
        "host": "0.0.0.0",
        "port": 5000
    },
    "redis": {
        "nodes": [
            "redis://10.0.0.1:6379",
            "redis://10.0.0.2:6379",
            "redis://10.0.0.3:6379"
        ]
    }
}
```
```rust
let settings = get_settings().unwrap();
assert!(settings.server.host == "0.0.0.0");
```

### Partial configuration

We can add environments variables that set only a sub section of your configuration:

```env
APP_SERVER_HOST=127.0.0.1
APP_SERVER_PORT=5000

APP_REDIS_FILE=/run/secrets/redis.yaml
```
```yaml
nodes:
    - redis://10.0.0.1:6379
    - redis://10.0.0.2:6379
    - redis://10.0.0.3:6379
username: redis
password: superpassword
```
```rust
let settings = get_settings().unwrap();
assert!(settings.server.host == "127.0.0.1");
assert!(settings.redis.username == "redis");
```

### License

[MIT](LICENSE)