OpenStack 配置解析库 oslo.config 的使用方法

文章目录

首先需要安装该模块

pip install oslo.config

1 基础概念

OpenStack 的 oslo 项目旨在独立出系统中可重用的基础功能，oslo.config 就是其中一个被广泛使用的库，该项工作的主要目的就是解析 OpenStack 中命令行（CLI）或配置文件（.conf）中的配置信息。

配置文件：
用来配置OpenStack各个服务的ini风格的配置文件，通常以.conf结尾；
配置项(options)：　　　
配置文件或命令行中给出的配置信息的左值，如：enabled_apis = ec2, osapi_keystone, osapi_compute中的“enabled_apis”；
配置项的值：
配置文件或命令行中给出的配置信息的右值，如：enabled_apis = ec2, osapi_keystone, osapi_compute中的“ec2, osapi_keystone, osapi_compute”；
配置组(option groups)：　　　
一组配置项，在配置文件中通过 […] 来表示，如 my.conf 文件中的 [rabbit] 字段表示接下来开始一个名为 rabbit 的配置组；配置组的概念就是配置文件中的 sections

下面的配置文件中，[rabbit] 就是一个 sections，也就是一个配置组

#-*-coding:utf-8-*-
# my.conf
 
[DEFAULT]
#[DEFAULT]不可省略
enabled_apis = ec2, osapi_keystone, osapi_compute
bind_host = 196.168.1.111
bind_port = 9999
 
[rabbit]
host = 127.0.0.1
port = 12345
use_ssl=true
user_id = guest
password = guest

配置项的模式(option schemas)：
简单点说就是声明一下自己需要什么配置项。在解析配置文件、获取配置项的值之前，声明自己需要的配置项。配置文件中的配置项是针对整个服务的，一个模块可能只用到一部分配置项，也就是说需要告诉系统自己需要哪些配置项，这个过程就是设置配置项的模式。声明的内容包括配置项的名称、默认值（没有配置文件或者配置文件中没有该配置项就使用默认值）、帮助信息；

2 一个完整的案例

我们先通过一个简单的例子来感受一下 oslo.config 是怎么用的，不用担心看不懂，代码中会给出详细的注释

my.conf

#coding=utf8
# my.conf

[DEFAULT]
#[DEFAULT]不可省略
enabled_apis = ec2, osapi_keystone, osapi_compute
bind_host = 196.168.1.111
bind_port = 9999

#[rabbit]是一个section，也就是一个配置组
[rabbit]
host = 127.0.0.1
port = 12345
use_ssl=true
user_id = guest
password = guest

config.py

# coding=utf8
# config.py

from oslo_config import cfg

# 声明配置项模式
# 单个配置项模式
# 配置项类型为list，配置项为enabled_apis，default为默认值，配置文件不存在或者拿不到配置项的值时，使用默认值，help为帮助信息
enabled_apis_opt = cfg.ListOpt('enabled_apis',
                               default=['ec2', 'osapi_compute'],
                               help='List of APIs to enable by default.')
# 多个配置项组成一个模式
common_opts = [
    cfg.StrOpt('bind_host',
               default='0.0.0.0',
               help='IP address to listen on.'),

    cfg.IntOpt('bind_port',
               default=9292,
               help='Port number to listen on.')
]
# 配置组
rabbit_group = cfg.OptGroup(
    name='rabbit',
    title='RabbitMQ options'
)
# 配置组中的模式，通常以配置组的名称为前缀（非必须）
rabbit_ssl_opt = cfg.BoolOpt('use_ssl',
                             default=False,
                             help='use ssl for connection')
# 配置组中的多配置项模式
rabbit_Opts = [
    cfg.StrOpt('host',
               default='localhost',
               help='IP/hostname to listen on.'),
    cfg.IntOpt('port',
               default=5672,
               help='Port number to listen on.')
]

# 创建对象CONF，用来充当容器
CONF = cfg.CONF
# 注册单个配置项模式
CONF.register_opt(enabled_apis_opt)

# 注册含有多个配置项的模式
CONF.register_opts(common_opts)

# 配置组必须在其组件被注册前注册！
CONF.register_group(rabbit_group)

# 注册配置组中含有多个配置项的模式，必须指明配置组
CONF.register_opts(rabbit_Opts, rabbit_group)

# 注册配置组中的单配置项模式，指明配置组
CONF.register_opt(rabbit_ssl_opt, rabbit_group)

# 接下来打印使用配置项的值
if __name__ == "__main__":
    CONF(default_config_files=['my.conf'])

for i in CONF.enabled_apis:
    print("DEFAULT.enabled_apis: " + i)

# bind_port,rabbit.use_ssl,rabbit.port不是字符串类型，所以转换为字符串再和字符串相加
print("DEFAULT.bind_host: " + CONF.bind_host)
print("DEFAULT.bind_port: " + str(CONF.bind_port))
print("rabbit.use_ssl: " + str(CONF.rabbit.use_ssl))
print("rabbit.host: " + CONF.rabbit.host)
print("rabbit.port: " + str(CONF.rabbit.port))

执行结果如下：

$ python config.py 
DEFAULT.enabled_apis: ec2
DEFAULT.enabled_apis: osapi_keystone
DEFAULT.enabled_apis: osapi_compute
DEFAULT.bind_host: 196.168.1.111
DEFAULT.bind_port: 9999
rabbit.use_ssl: True
rabbit.host: 127.0.0.1
rabbit.port: 12345

可以看到打印的配置项的值都是配置文件 my.conf 中的值，将文件config.py 中第 59，60 行注释，再执行，结果如下：

扫描二维码关注公众号，回复： 12586806 查看本文章

$ python config.py 
DEFAULT.enabled_apis: ec2
DEFAULT.enabled_apis: osapi_compute
DEFAULT.bind_host: 0.0.0.0
DEFAULT.bind_port: 9292
rabbit.use_ssl: False
rabbit.host: localhost
rabbit.port: 5672

可以看到，不指定解析文件时，配置项找不到配置文件中配置项的值，打印的值都是上面声明配置项时提供的默认值。

3 使用总结

看完了上面配置项使用的案例，我们再回头说说如何使用 oslo.config 这个库，OpenStack 中配置文件的解析主要有以下几个步骤：

step1. 正确配置各个服务主配置文件（*.conf文件），本步骤在各个服务（如：keystone）中完成。对应上面例子中，就是写配置文件 my.conf
step2. 在要使用到配置信息的模块中声明将用到的那些配置项的模式，包括配置项的名称、数据类型、默认值和说明等；对应例子中声明配置项 enabled_apis_opt，common_opts 等
step3. 创建一个对象，创建该对象的类充当配置管理器，这个对象作为容器以后将存储配置项的值。对应例子中的第42行，CONF = cfg.CONF
step4. 调用 step3 创建的对象中相应的注册方法（如：register_opt()，register_opts(), register_group），注册 step2 中声明的配置项模式。这个过程不会解析配置文件，只是为 step3 中创建的对象开辟相应的字段。对应例子中的第 44，47，50，53，56 行
step5. 直接调用 step3 中创建的对象，传入配置文件路径等信息。此时将会解析配置文件，如果未指定配置文件则全部使用 step2 模式中的默认值。对应例子中的 60 行，这里解析配置文件，取配置文件中配置项，之后这些配置项就可以当 step3 创建的对象的属性使用了，如 CONF.bind_host，配置项用起来就像 CONF 的属性一样

参考：
https://www.cnblogs.com/Security-Darren/p/3854797.html