Skip to content

Commit

Permalink
chore(docs): Update CHANGELOG.md and add AKV config example.
Browse files Browse the repository at this point in the history
  • Loading branch information
spbsoluble committed Nov 20, 2024
1 parent 0e4db4f commit d86b5cc
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 3 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# v1.1.0

## Features
- Support for sourcing client config files from Azure Key Vault

# v1.0.0

## Features
Expand Down
45 changes: 42 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,14 +156,53 @@ servers:
## Configuration File Providers
Below are a list of configuration file providers that can be used to load configuration from a file if loading from disk
is not desired.
is not desired.
### Azure Key Vault
To use Azure Key Vault as a configuration file provider, the code must either be running in an Azure environment or the
environment configured with `az login`. The following environment variables will be used when they are not directly set.
environment configured with `az login`. The following environment variables can be used and will take precedence over
any configuration file. *NOTE* that the secret must be formatted as specified in the example configuration files above.

| Name | Description | Default |
|---------------------|---------------------------------------|---------|
| AZURE_KEYVAULT_NAME | The name of the Azure KeyVault | |
| AZURE_SECRET_NAME | The name of the Azure KeyVault secret | |
| AZURE_SECRET_NAME | The name of the Azure KeyVault secret | |

#### JSON

Below is an example of a configuration file that uses Azure Key Vault as a configuration file provider. *NOTE* that the
secret must be formatted as specified in the example configuration files above.

```json
{
"servers": {
"default": {
"auth_provider": {
"type": "azid",
"profile": "default",
"parameters": {
"secret_name": "<akv_secret_name>",
"vault_name": "<akv_vault_name>"
}
}
}
}
}
```

#### YAML

Below is an example of a configuration file that uses Azure Key Vault as a configuration file provider. *NOTE* that the
secret must be formatted as specified in the example configuration files above.

```yaml
servers:
default:
auth_provider:
type: azid
profile: default
parameters:
secret_name: <akv_secret_name>
vault_name: <akv_vault_name>
```

0 comments on commit d86b5cc

Please sign in to comment.