Skip to main content

CKAN configuration settings available from env vars

Project description

image

ckanext-envvars

This CKAN extension checks for environmental variables conforming to an expected format and updates the corresponding CKAN config settings with its value.

For the extension to correctly identify which env var keys map to the format used for the config object, env var keys should be formatted in the following way:

  1. All uppercase
  2. Replace periods ('.') with two underscores ('__')
  3. Keys must begin with 'CKAN' or 'CKANEXT'

Some examples:

ckan.site_id --> CKAN__SITE_ID
ckanext.s3filestore.aws_bucket_name --> CKANEXT__S3FILESTORE__AWS_BUCKET_NAME

For keys that don't normally begin with 'CKAN', add 'CKAN___' (3 underscores) to the beginning to help the extension identify these keys, e.g.:

sqlalchemy.url --> CKAN___SQLALCHEMY__URL
beaker.session.secret --> CKAN___BEAKER__SESSION__SECRET

Starting from CKAN 2.10 (and ckanext-envvars 0.0.4), if a configuration option is defined using CKAN's configuration declaration the key is not further processed. This allows to keep eg upper case setttings like SECRET_KEY, WTF_CSRF_ENABLED, e.g:

SECRET_KEY --> CKAN___SECRET_KEY
WTF_CSRF_ENABLED --> CKAN___WTF_CSRF_ENABLED

Requirements

Tested in CKAN 2.7, CKAN 2.8, CKAN 2.9 and CKAN 2.10, but may work in other versions.

To ensure all config settings are overridden by env var values, envvars must be the last plugin entry in the ckan.plugins list (see 'Installation' below).

Installation

To install ckanext-envvars:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Install the ckanext-envvars Python package into your virtual environment:

    pip install ckanext-envvars
    
  3. Add envvars to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload
    

Development Installation

To install ckanext-envvars for development, activate your CKAN virtualenv and do:

git clone https://github.com/okfn/ckanext-envvars.git
cd ckanext-envvars
python setup.py develop
pip install -r dev-requirements.txt

Running the Tests

They follow the guidelines for testing CKAN extensions.

To run the tests, do:

pytest --ckan-ini=test.ini ckanext/envvars/tests.py

ckanext-envvars on PyPI

ckanext-envvars is availabe on PyPI as ckanext-envvars.

Releasing a New Version of ckanext-envvars

To release a new version of this CKAN extension you should:

  • Update the setup.py file with a new version number (N.N.N)
  • Tag this repo with the new version
git tag vN.N.N
git push --tags
  • Create a source distribution of the new version:
python setup.py sdist
  • Set up twine. The $HOME/.pypirc file must containg the following:
[pypi]
username = __token__
password = <the token value, including the `pypi-` prefix>
  • Upload the new version to PyPI:
pip install twine
twine check dist/*
twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext_envvars-0.0.6.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

ckanext_envvars-0.0.6-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file ckanext_envvars-0.0.6.tar.gz.

File metadata

  • Download URL: ckanext_envvars-0.0.6.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for ckanext_envvars-0.0.6.tar.gz
Algorithm Hash digest
SHA256 77a9b487cdff96f43b5a7053e6f30304e02c4e3b8bcc0e5fb9e656900d3f0a67
MD5 b6b65090eaaf6c855cb2f631b9fb33f8
BLAKE2b-256 e98da192dc523ac207cf78cf81d62b7a96c324b27847218f8dcb698b1b3f8269

See more details on using hashes here.

File details

Details for the file ckanext_envvars-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for ckanext_envvars-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f8d05806be05f655f7e548c87672a61c6933343898d62bb4e4d99088dc4e07
MD5 684327533949bccdd4618a0fb4a14f91
BLAKE2b-256 5650e4375319f747f485e3061451a27f4d7582db3df8c5d91a0e9ef4755be82b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page