Files
freezer-api/doc/source/configuration/index.rst
Dmitriy Rabotyagov cc2efd8506 [doc] Add service configuration reference
At the moment service documentation is missing a sample configuration
files along with policy reference which might be essential for user
to understand their options.

This patch generates sample config files and publishes them to docs.

Change-Id: Ic9dd5b6a3856ae3f9335857299143df5e6725963
2025-01-10 15:28:49 +00:00

1.1 KiB

Configuration Guide

config.rst policy.rst sample_api_paste.rst sample_config.rst sample_policy.rst

The configuration for freezer-api lies in below described files.

Configuration

Freezer API has a main config file freezer.conf. You can find a reference to it below:

  • Config Reference <config>: A complete reference of all config points in freezer-api and what they impact.
  • Sample Config File <sample_config>: A sample config file with inline documentation.

Policy

Freezer API, like most OpenStack projects, uses a policy language to restrict permissions on REST API actions.

  • Policy Reference <policy>: A complete reference of all policy points in freezer-api and what they impact.
  • Sample policy File <sample_policy>: A sample policy file with inline documentation.

API configuration settings

  • API configuration <sample_api_paste>: A complete reference of API configuration settings.