oslo.config

An OpenStack library for parsing configuration options from the command line and configuration files.

Contents

• The cfg Module
  • Option Types
  • Registering Options
  • Loading Config Files
  • Option Groups
  • Accessing Option Values In Your Code
  • Option Value Interpolation
  • Special Handling Instructions
  • Dictionary Options
  • Global ConfigOpts
  • Positional Command Line Arguments
  • Sub-Parsers
  • Advanced Option
• Option Definitions
• Option Types and Validation
• The ConfigOpts Class
• The cfgfilter Module
  • Cross-Module Option Dependencies
  • Private Configuration Options
  • Limited Configuration Options
• Helper Functions
• Test Fixture
• File Parsing
• Exceptions
• Choosing group names for configuration options
• Style Guide for Help Strings
  • Style Guide
  • Format
• Enabling your project for mutable config
  • Calling mutate_config_files
  • Making options mutable-safe
• oslo-config-generator
  • Defining Option Discovery Entry Points
  • Modifying Defaults from Other Namespaces
  • Generating Multiple Sample Configs
  • Sample Default Values
  • API
• Built-in Options
  • DEFAULT
• Sphinx Integration
• Sphinx Oslo Sample Config Generation
  • Output File Name
• Frequently Asked Questions
  • Why does oslo.config have a CONF object? Global objects SUCK!
  • Why are configuration options not part of a library’s API?
• Contributing

Release Notes

• CHANGES

Indices and tables

• Index
• Module Index
• Search Page