tree: 7606b03d3c3300e4fccf8bc1ea89feee3ea2703f [path history] [tgz]
  1. Makefile
  2. README.md
  3. __init__.py
  4. api.py
  5. api_test.py
  6. apps.py
  7. common.py
  8. common_test.py
  9. endpoint.py
  10. endpoint_test.py
  11. fs.py
  12. fs_test.py
  13. handlers.py
  14. include.yaml
  15. proto/
  16. remote.py
  17. remote_test.py
  18. run_coverage.py
  19. test_config.proto
  20. test_config_pb2.py
  21. test_data/
  22. validation.py
  23. validation_context.py
  24. validation_context_test.py
  25. validation_test.py
appengine/components/components/config/README.md

config/

config is a library that provides centralized configuration management functionality for webapp2 and Cloud Endpoints apps. Acts as a client for config_service.

The library can work in two modes: remote and fs. In remote mode the library fetches configs from a configuration service. In fs mode it uses file system as a source of configs. The library defaults to fs mode if URL of the config service is uknown.

Remote mode

Remote mode allows updating configuration without re-deploying your application.

Setup:

  • Include endpoints library in app.yaml.
    libraries:
    - name: endpoints
      version: "1.0"
    
  • Export config.ConfigApi Cloud Endpoints service.
  • Create a directory <appid> in the config service's config root directory and put global configuration files there.
  • Link the app to the config service, see below.

Linking to the config service

To link a LUCI app to a config service:

  • Make sure you are in the administrators group of the app.

  • Open the exported Config Cloud Endpoints service in the app with API Explorer (replace <host> with the app hostname): https://apis-explorer.appspot.com/apis-explorer/?base=https://<host>/_ah/api#p/config/v1/config.settings

    In the request body:

    • service_hostname is the config service hostname (e.g. luci-config.appspot.com).
    • trusted_service_account is the service account of the config service (e.g. user:<appid>@appspot.gserviceaccount.com or service:<appid>).
  • Tell the configure service that your app may fetch your configs by adding your app to services.cfg of the config service.

Storing last good config

Most get* functions in api.py, such as get_async, have store_last_good parameter. Pass True to avoid doing a roundtrip to the config service. Instead they are fetched from the datastore and a cron job updates the config files in the background.

Setup:

  • Add to your app.yaml to enable the config component:

    includes:
    - components/config
    
    libraries:
    - name: jinja2
      version: "2.6"
    - name: webapp2
      version: "2.5.2"
    - name: webob
      version: "1.2.3"
    
  • Include ../third_party/ in sys.path

FS mode

In this mode configuration files are read from the file system. It is convenient for local development or when using a config service is an overkill.

The config files are read from <app root>/configs/<config_set>/CONFIGS/<config file path>, for example if your app is foo.appspot.com and your global config file is called settings.cfg, it will be read from <app root>/configs/services/foo/CONFIGS/settings.cfg.

When running locally, the app id is specified in your app.yaml.

When the app is uploaded to the real AppEngine, the configs from your local checkout are uploaded too. To update them, reupload your app.

Config validation

Configuration service supports config validation at the import time. For each file in a revision, the config service contacts the apps that claim they can validate the file and if any of the apps returns an error, the whole revision is rejected.

Use config.validation module to specify which config files your app can validate and how to validate them. See the module docstring for more info.