Skip to content

Commit

Permalink
Merge pull request #137 from zzztimbo/doc-fix-typo
Browse files Browse the repository at this point in the history
docs(config): fix typo in docs and format
  • Loading branch information
PierreBeucher authored Nov 12, 2024
2 parents 28f7cc7 + f4f8b16 commit e278c99
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/src/config/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Novops will load configuration in that order:
- Inputs are **resolved** into **Environment Variables** and **Files** (and other Outputs constructs internally with files and variables)
- Inputs can also use other Inputs, such as an Hashicorp Vault `hvault_kv2` Inputs used by a `variable` Input to resolve a secret into an environment variable (see below for example)

Example: environments `dev` and `prod` with inputs `files`, `variables` and `hvault_kv2`.
Example: environments `dev` and `prod` with inputs `files`, `variables` and `hvault_kv2`.

```yaml
environments:

# Environment name
dev:
dev:

# "variables" is a list of "variable" inputs for environment
# "variables" is a list of "variable" inputs for environment
# Loading these inputs will result in envionment variables outputs
variables:

Expand All @@ -47,10 +47,10 @@ environments:
hvault_kv2:
path: crafteo/app/dev
key: password

# "files" is a list of "file" inputs
files:

# - content: input resolving to a string. Can be a plain string or another input resolving to a string
# - variable: a variable name which will point to generated file
# - dest: Optionally, the final destination where file will be generate. By default Novops create a file in a secure directory.
Expand All @@ -62,19 +62,19 @@ environments:
- variable: MY_APP_CONFIG
content: |
bind_addr: localhost
# Like variables input, file Input content can use another Input
# to load value from external source
- variable: MY_APP_TOKEN
content:
content:
hvault_kv2:
path: crafteo/app/dev
key: token
```
## Root `config` keyword

Root `config` is used to specifhy global configurations for Novops and its modules:
Root `config` is used to specify global configurations for Novops and its modules:

```yaml
config:
Expand All @@ -99,4 +99,4 @@ config:
# See module docs or full Novops schema for details
<someModule>:
# ...
```
```

0 comments on commit e278c99

Please sign in to comment.