随着OpenStack项目的不断发展与完善,OpenStack社区将所有组件中的具有共性的组件剥离出来,并统一放在oslo组件下。oslo中的组件不仅可以在OpenStack项目中使用,也可以单独作为第三方工具包供其他项目使用。oslo.config项目是oslo组件中用于OpenStack配置文件的一个项目。本文首先以Nova项目为例,介绍了oslo.config的用法;然后,根据源码详细分析了其实现原理。
1. oslo.config用法
1.1 定义配置项
本小节以nova组件为例介绍oslo.config组件的用法。首先,要使用oslo.config需要导入该模块,一般地,直接导入oslo.config中的cfg即可。
from oslo_config import cfg
导入cfg后,需要新建一个表示配置组的OptGroup类,如在Nova中添加api相关配置时可以添加一个api_group类。
api_group = cfg.OptGroup('api',
title='API options',
help="""
Options under this group are used to define Nova API.
""")
api_group表示了一组关于api的配置项,其中,api表示该配置组的名称;title描述了该配置组的标题;help则详细描述了该配置组的作用。
创建了配置组类之后,则需要创建所有的配置项,如在Nova中添加关于api权限相关的配置参数。
auth_opts = [
cfg.StrOpt("auth_strategy",
default="keystone",
choices=("keystone", "noauth2"),
deprecated_group="DEFAULT",
help="""
This determines the strategy to use for authentication: keystone or noauth2.
'noauth2' is designed for testing only, as it does no actual credential
checking. 'noauth2' provides administrative credentials only if 'admin' is
specified as the username.
"""),
cfg.BoolOpt("use_forwarded_for",
default=False,
deprecated_group="DEFAULT",
help="""
When True, the 'X-Forwarded-For' header is treated as the canonical remote
address.