/amm

Database as a service project

Primary LanguagePythonMIT LicenseMIT

AMM

Requirements

Create a .env file on the project's root with the following variables :

  1. ACCRED_PASSWORD: The password to access to accred webservices
  2. CACHE_REDIS_LOCATION: The django-cache connection string for the redis driver (depends on client selected)
  3. CACHE_REDIS_CLIENT_CLASS: The django-cache client class to use for the redis driver (for standalone redis use: "django_redis.client.DefaultClient" )
  4. SECRET_KEY: django secret key
  5. LDAP_USER_SEARCH_ATTR: the LDAP user search attribute
  6. LDAP_BASE_DN: The BaseDN for ldap user search
  7. LDAP_SERVER: The LDAP server to bind to
  8. LDAP_SERVER_FOR_SEARCH: The LDAP server for search
  9. LDAP_USE_SSL: Whether to use 'ldaps' or 'ldap' (no support for starttls), use 'ldaps' only if set to 'true' any other value is false
  10. AMM_ENVIRONMENT: the amm environment
  11. AMM_AUTHENTICATOR_CLASS: The authentication class to use, currently only 'ldap' is supported
  12. DJANGO_HOST: the value to accept as Host header in HTTP requests
  13. DJANGO_WORKER_COUNT: the number of worker processes
  14. DJANGO_SETTINGS_MODULE: the django configuration module to use, currently only 'config.settings.local' for local testing and 'config.settings.base' for production are supported
  15. RANCHER_API_URL: the base URL to access the Rancher API
  16. RANCHER_VERIFY_CERTIFICATE: if true the Rancher SSL certificate will be verified
  17. RANCHER_ACCESS_KEY: the Rancher API access key
  18. RANCHER_SECRET_KEY: the Rancher API secret key

For the tests to pass, some more variables need to be assigned:

  1. TEST_USERNAME: A user that exists in the LDAP
  2. TEST_CORRECT_PWD: The correct password for that user for authentication
  3. TEST_WRONG_PWD: A password that will fail authentication

Version Number:

The version number is set using the following environment variables:

# MAJOR_RELEASE: The major version of the application # MINOR_RELEASE: The bugfix version of the application # BUILD_NUMBER: The build number, which should be incremented at each image build

These variables are setup when the image is built using variables of the exact same name set with --build-arg. The build system is responsible for setting these variables correctly in the docker build command.

  1. All rights reserved. ECOLE POLYTECHNIQUE FEDERALE DE LAUSANNE, Switzerland, VPSI, 2017