freezer/HACKING.rst
Trinh Nguyen 1467df83a6 Clean up docs and specs directories
This patch proposes to clean up unused or redundant docs
as well as moving config-generator to the etc dir

Change-Id: I37d4c4ad1d46ee273575021ca90d5b31121ce9e8
2018-09-05 15:18:30 +09:00

2.0 KiB

Freezer Style Commandments

Freezer Specific Commandments

Logging

Use the common logging module, and ensure you getLogger:

from oslo_log import log

LOG = log.getLogger(__name__)

LOG.debug('Foobar')

oslo.config

  • All configuration options for freezer-scheduler should be in the following file :

    freezer/scheduler/arguments.py
  • After adding new options to freezer-scheduler please use the following command to update the sample configuration file:

    oslo-config-generator --config-file etc/config-generator.conf

- If you added support for a new oslo library, you have to edit the following file adding a new namespace for the new oslo library: for example adding oslo.db:

# edit etc/config-generator.conf
[DEFAULT]
output_file = etc/scheduler.conf.sample
wrap_width = 79
namespace = scheduler
namespace = oslo.log
namespace = oslo.db

This will add oslo.db options to your configuration file.

Agent Options

  • All configuration options for freezer-agent should be in the following file :

    freezer/common/config.py
  • To list options available in freezer-agent use the following command:

    oslo-config-generator --namespace freezer --namespace oslo.log

Release Notes

- When a new feature is committed we should have a new release notes page that

highlights the changes made. These release notes will be used for deployers, users, and developers. There are a few steps that need to be taken in order.

  • Building release notes:

    tox -e releasenotes