oslo.config
来源:互联网 发布:python logger format 编辑:程序博客网 时间:2024/06/05 11:08
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的配置组;
其他模块:
运行时需要根据配置项的值实现具体操作的模块;
配置项的模式(option schemas):
在解析配置文件、获取配置项的值之前,其他模块声明自己需要的配置项。配置文件通常是针对一个完整的服务的,因此其他模块中可能用不到配置文件中的所有配置项,这样就必须告诉系统自己依赖于哪些配置项,这个过程就是设置配置项的模式。包括声明配置项在配置文件的名称、设置配置项的默认值(一旦配置文件中没有该配置项而其他模块又依赖于该配置项,就使用这里声明的默认值)等等;
引用(reference):
其他模块解析配置文件,获取配置项的值后,就可以在下面的实现中使用这些具体的配置值了;
注册(register):
其他模块在引用配置项的值之前,必须注册自己将要引用的那些配置项的模式。也就是说,配置文件中的配置项其他模块不一定都为其声明模式,声明了模式的配置项也不一定为其进行注册,当然如果不注册,即使声明了模式,也无法引用。
oslo.config支持的配置选项类型:
oslo.config.cfg.StrOpt 字符串选项类型
oslo.config.cfg.BoolOpt 布尔型
oslo.config.cfg.IntOpt 整数类型
oslo.config.cfg.FloatOpt 浮点数类型
oslo.config.cfg.ListOpt 字符串列表类型
oslo.config.cfg.DictOpt 字符串字典类型
oslo.config.cfg.MulitiStrOpt 可分多次配置的字符串列表
oslo.config.cfg.IPOpt IP地址类型
OpenStack中配置文件的解析主要有以下几个步骤:
step1. 正确配置各个服务主配置文件(*.conf文件),本步骤在各个服务(如:keystone)中完成。
step2. 在要使用到配置信息的模块中声明将用到的那些配置项的模式,包括配置项的名称、数据类型、默认值和说明等;
step3. 创建一个对象,创建该对象的类充当配置管理器,这个对象作为容器以后将存储配置项的值。
step4. 调用step3创建的对象中相应的注册方法(如:register_opt()),注册step2中声明的配置项模式。这个过程不会解析配置文件,只是为step3中创建的对象开辟相应的字段。
step5. 直接调用step3中创建的对象,传入配置文件路径等信息。此时将会解析配置文件,如果未指定配置文件则全部使用step2模式中的默认值。解析过程会提取step4中注册了的配置项的值,然后这些配置项就作为step3创建的对象的属性可以被直接引用。
一个完整的实例如下:
先设置my.conf文件,在oslo.config语境下,[DEFAULT]字段不可省略。
#-*-coding:utf-8-*-# my.conf[DEFAULT]#[DEFAULT]不可省略enabled_apis = ec2, osapi_keystone, osapi_computebind_host = 196.168.1.111bind_port = 9999[rabbit]host = 127.0.0.1port = 12345use_ssl=trueuser_id = guestpassWord = guest
接着写一个脚本文件config.py,该脚本的功能非常简单,直接执行时打印该脚本使用到的配置项的值。
#-*-coding:utf-8-*-# config.py# Author: D. Wangfrom oslo.config import cfg# 声明配置项模式# 单个配置项模式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) 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))
执行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
下面的config_test.py不指定配置文件:
# config_test.py# 声明配置项模式# 单个配置项模式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)from config import CONFif __name__ =="__main__": CONF() for i in CONF.enabled_apis: print ("DEFAULT.enabled_apis: " + i) 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))
执行config_test.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
可以发现,执行config.py时,成功读取了配置项的值,而执行config_test.py时,由于没有指定要解析的配置文件,所以使用的都是设置模式时指定的默认值。
参考文章:
http://blog.csdn.net/yugongpeng_blog/article/details/45846367
http://blog.csdn.net/yugongpeng_blog/article/details/45846387
- oslo config
- oslo.config
- oslo.config组件初探
- (二)、Openstack 之 oslo.config
- Openstack Oslo.config 学习(一)
- Openstack Oslo.config 学习(二)
- OpenStack开发基础-oslo.config
- oslo.config模块的使用
- OpenStack公共组件oslo之一——oslo.config
- openstack oslo.config配置解析模块
- oslo.config 自动生成示例文件
- openstack oslo.config组件服务浅析
- openstack通用库Oslo之config
- (三) OPENSTACK 学习之 Oslo Config (oslo.config) 自己动手写项目
- OpenStack源码探秘(二)——Oslo.config
- 如何把oslo.config使用到自己的项目中
- OpenStack配置解析库——oslo.config
- OpenStack配置解析库oslo.config的使用方法
- Android多线程断点续传下载
- oracle 11gr2 11.2.0.4升级11.2.0.4.2
- spring aop 5 环绕通知around
- PullToRefreshListView适配器加载不同的layout
- 黑马程序员——方法总结之网编
- oslo.config
- CF Comparing Two Long Integers 616A
- 常用的正则表达式概述
- spring aop 6 环绕通知记录应用的日志
- 算法分析—最长公共子序列(LCS)
- strip,eu-strip 及其符号表,gdb调试strip过的程序
- 测试让NSLog失效
- Oracle 11g客户端中文乱码问题
- 关于环境变量