Coverage for nova/conf/guestfs.py: 88%

1# Copyright 2015 OpenStack Foundation 

2# All Rights Reserved. 

3# 

4# Licensed under the Apache License, Version 2.0 (the "License"); you may 

5# not use this file except in compliance with the License. You may obtain 

6# a copy of the License at 

7# 

8# http://www.apache.org/licenses/LICENSE-2.0 

9# 

10# Unless required by applicable law or agreed to in writing, software 

11# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 

12# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 

13# License for the specific language governing permissions and limitations 

14# under the License. 

15 

16from oslo_config import cfg 

17 

18guestfs_group = cfg.OptGroup('guestfs', 

19 title='Guestfs Options', 

20 help=""" 

21libguestfs is a set of tools for accessing and modifying virtual 

22machine (VM) disk images. You can use this for viewing and editing 

23files inside guests, scripting changes to VMs, monitoring disk 

24used/free statistics, creating guests, P2V, V2V, performing backups, 

25cloning VMs, building VMs, formatting disks and resizing disks. 

26""") 

27 

28enable_guestfs_debug_opts = [ 

29 cfg.BoolOpt('debug', 

30 default=False, 

31 help=""" 

32Enable/disables guestfs logging. 

33 

34This configures guestfs to debug messages and push them to OpenStack 

35logging system. When set to True, it traces libguestfs API calls and 

36enable verbose debug messages. In order to use the above feature, 

37"libguestfs" package must be installed. 

38 

39Related options: 

40 

41Since libguestfs access and modifies VM's managed by libvirt, below options 

42should be set to give access to those VM's. 

43 

44* ``libvirt.inject_key`` 

45* ``libvirt.inject_partition`` 

46* ``libvirt.inject_password`` 

47""") 

48] 

49 

50 

51def register_opts(conf): 

52 conf.register_group(guestfs_group) 

53 conf.register_opts(enable_guestfs_debug_opts, 

54 group=guestfs_group) 

55 

56 

57def list_opts(): 

58 return {guestfs_group: enable_guestfs_debug_opts}