oslo.config Reference Guide

updated: November 14, 2018

oslo.config Reference Guide¶

  • Defining Options
    • Option Types
    • Registering Options
    • Option Groups
    • Dynamic Groups
    • Driver Groups
    • Special Handling Instructions
    • Dictionary Options
    • Advanced Option
  • Choosing group names for configuration options
  • Accessing Option Values In Your Code
  • Loading Configuration Files
    • Option Value Interpolation
  • Command Line Options
    • Positional Command Line Arguments
    • Sub-Parsers
  • Option Deprecation
  • Global ConfigOpts
  • Opt and Subclasses
  • 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
  • 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: November 14, 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

  • oslo.config Reference Guide
    • Defining Options
    • Choosing group names for configuration options
    • Accessing Option Values In Your Code
    • Loading Configuration Files
    • Command Line Options
    • Option Deprecation
    • Global ConfigOpts
    • Opt and Subclasses
    • Option Types and Validation
    • The ConfigOpts Class
    • The cfgfilter Module
    • Helper Functions
    • Test Fixture
    • File Parsing
    • Exceptions
    • 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.