Using oslo.config

updated: July 30, 2018

Using oslo.config¶

  • The cfg Module
    • Option Types
    • Registering Options
    • Loading Config Files
    • Option Groups
    • Dynamic Groups
    • Driver 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 Deprecation
  • Option Definitions
  • Option Types and Validation
  • The ConfigOpts Class
  • The cfgfilter Module
    • Cross-Module Option Dependencies
    • Private Configuration Options
    • Limited Configuration Options
  • Helper Functions
    • Showing detailed locations for configuration settings
  • 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
  • Option Setting Locations
    • Did a user set a configuration option?
  • Sphinx Integration
  • Sphinx Oslo Sample Config Generation
    • Output File Name
  • Backend Drivers
    • Abstract Classes
    • Known Backend Drivers
  • 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?
updated: July 30, 2018
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug questions?
  • Guides
  • Install Guides
  • User Guides
  • Configuration Guides
  • Operations and Administration Guides
  • API Guides
  • Contributor Guides
  • Languages
  • Deutsch (German)
  • Français (French)
  • Bahasa Indonesia (Indonesian)
  • Italiano (Italian)
  • 日本語 (Japanese)
  • 한국어 (Korean)
  • Português (Portuguese)
  • Türkçe (Türkiye)
  • 简体中文 (Simplified Chinese)

oslo.config

  • Using oslo.config
    • The cfg Module
    • Option Definitions
    • Option Types and Validation
    • The ConfigOpts Class
    • The cfgfilter Module
    • Helper Functions
    • Test Fixture
    • File Parsing
    • Exceptions
    • Choosing group names for configuration options
    • Style Guide for Help Strings
    • Enabling your project for mutable config
    • Option Setting Locations
    • Sphinx Integration
    • Sphinx Oslo Sample Config Generation
    • Backend Drivers
    • Frequently Asked Questions
  • oslo.config Command Line Tools
  • Configuration Guide
  • Contributing

OpenStack

  • Projects
  • OpenStack Security
  • Common Questions
  • Blog
  • News

Community

  • User Groups
  • Events
  • Jobs
  • Companies
  • Contribute

Documentation

  • OpenStack Manuals
  • Getting Started
  • API Documentation
  • Wiki

Branding & Legal

  • Logos & Guidelines
  • Trademark Policy
  • Privacy Policy
  • OpenStack CLA

Stay In Touch

The OpenStack project is provided under the Apache 2.0 license. Openstack.org is powered by Rackspace Cloud Computing.