Search
  • Software
    • Overview
    • OpenStack Components
    • SDKs
    • Deployment Tools
    • OpenStack Map
    • Sample Configs
  • Use Cases
    • Users in Production

    • Ironic Bare Metal
    • Edge Computing
    • Telecom & NFV
    • Science and HPC
    • Containers
    • Enterprise
    • User Survey
  • Events
    • OpenInfra Summit
    • Project Teams Gathering
    • OpenDev
    • Community Events
    • OpenStack & OpenInfra Days
    • Summit Videos
  • Community
    • Welcome! Start Here
    • OpenStack Technical Committee
    • Speakers Bureau
    • OpenStack Wiki
    • Get Certified (COA)
    • Jobs
    • Marketing Resources
    • Community News
    • Superuser Magazine

    • OpenInfra Foundation Supporting Organizations
    • OpenInfra Foundation
  • Marketplace
    • Training
    • Distros & Appliances
    • Public Clouds
    • Hosted Private Clouds
    • Remotely Managed Private Clouds
    • Consulting & Integrators
    • Drivers
  • Blog
  • Docs
  • Join
    • Sign up for Foundation Membership
    • Sponsor the Foundation
    • More about the Foundation
  • Log In

oslo.config Reference Guide

oslo.config Reference Guide¶

  • API
    • oslo_config package
  • 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
  • Helper Functions
    • Showing detailed locations for configuration settings
  • 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
    • .. show-options::
    • :option:
    • :group:
  • Sphinx Oslo Sample Config Generation
    • Output File Name
  • Backend Drivers
    • 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?
this page last updated: 2019-06-18 16:31:48
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
  • 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 9.8.0.dev4

  • Configuration Guide
  • oslo.config Reference Guide
    • API
    • Defining Options
    • Choosing group names for configuration options
    • Accessing Option Values In Your Code
    • Loading Configuration Files
    • Command Line Options
    • Option Deprecation
    • Global ConfigOpts
    • Helper Functions
    • 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
  • Contributing

OpenStack

  • Projects
  • OpenStack Security
  • Blog
  • News

Community

  • User Groups
  • Events
  • Jobs
  • Companies
  • Contribute

Documentation

  • OpenStack Manuals
  • Getting Started
  • API Documentation
  • Wiki

Branding & Legal

  • Legal Docs
  • Logos & Guidelines
  • Trademark Policy
  • Privacy Policy
  • OpenInfra CLA

Stay In Touch

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