
ckanext-ssm-config - Amazon SSM Config CKAN Extension
About
This plugin enables CKAN config options to be retrieved at runtime from AWS Parameter Store.
This is particularly useful for automatically managed environments, so that dynamic or secret values such as the Beaker session key, XLoader job tokens, or Google reCAPTCHA private keys, can be stored securely outside the configuration management system.
Unfortunately the current CKAN architecture does not allow for database passwords to be handled by this plugin, as the password is read from the config before this plugin has the chance to inject it.
Queensland Government has developed this plugin to be used with data.qld.gov.au and publications.qld.gov.au.
Features
- Config values with SSM Parameter Store placeholders,
${ssm:/path/to/value} or {{ssm:/path/to/value}}, will be replaced at runtime.
- Values that cannot be retrieved from the Parameter Store will result in blanks, or a fallback value can be supplied, eg
{{ssm:/path/to/value:default_value}}
- All SSM parameters under a prefix can be automatically converted into config entries.
Requirements
- boto3
- Compatibility with core CKAN versions:
| CKAN version |
Compatibility |
| 2.7 |
no longer supported |
| 2.8 |
no longer supported |
| 2.9 |
yes |
| 2.10 |
yes |
| 2.11 |
yes |
| master |
yes* |
*Testing occurs against ‘master’ in non-failing mode, do verify test summary.
At of April 2025 it was passing, so we are confident it is 2.12 compatible.
Configuration
“`
ckan.plugin