Describing virtual devops environments in YAML templates for #fuel-devops gives much more flexible configuration options for creating environments and allows to implement some additional functionality that weren’t possible before.
fuel-devops project has a certain amount of limitations and hardcode:
Settings for #fuel-devops are separated into host-related settings (django, qemu, vnc password, and other static settings) and environment-related settings.
There is a main section ‘template’ that can contain several sub-sections for different proposes. One of these sub-sections is ‘devops_template’ where located all necessary settings for #fuel-devops. In the other sub-sections can be settings for a test case for the environment. Thus, one template can contain settings for a virtual devops environment and for test case that might be performed on this environment.
The tag ‘!os_env’ is used to get various settings from template directly from environment variables if it is necessary: !os_env SOME_VAR[, <devaful_value>] For example:
!os_env ISO_PATH # ISO_PATH is the required variable
# default is 3072
The tag ‘!include’ is used for inserting YAML objects from an another YAML file.
Base structure of the YAML template:
template: devops_template: env_name: <some_name> # string address_pools: # dict of dicts <address_pool_name>: # dict # object name, string net: x.x.x.x/yy # string, IPv4 network. # Can be x.x.x.x/yy:zz for dynamic # network allocation params: # dict; *SERIALIZABLE DATA* ... groups: # list of dicts. list is to keep the # creation order of environment devices - name: <group_name> # string driver: # dict name: <driver_name> # string params: # dict; *SERIALIZABLE DATA* network_pools: # dict, associates OpenStack network # names with certain address pools <openstack_network_name>: <address_pool_name> ... l2_network_devices: # dict <l2_network_device_name>: # dict; *SERIALIZABLE DATA* ... nodes: # list of dicts <node_name>: # dict role: <role_name> # <role_name> - string params: # dict; *SERIALIZABLE DATA* ... ...
SERIALIZABLE DATA means a dict with non-fixed fields structure that will be stored in the database as a serialized text field.
template: The main section where different subsections are located such as ‘devops_template’ and ‘cluster-template’ (see  for additional details).
devops_template: This section contains all data that describes configuration of nodes and networks for an existing hardware or virtual environment, or for the virtual/hybrid environment which is created by this configuration.
address_pools: Allocate address pools and VLAN tags for different networks
baremetal pool: if ‘net’ is specified as x.x.x.x/YY , then the network is stored ‘as is’, ‘gateway’ and at least one element in ‘ip_ranges’ is required.
virtual pool: if ‘net’ is specified as x.x.x.x/YY:ZZ , where YY > ZZ, then the network x.x.x.x/ZZ will be dynamically allocated from the network range x.x.x.x/YY. In this case ‘gateway’ and ‘ip_ranges’ will be set automatically.
net: required field, can be a virtual pool
gateway: if dynamic range is used, then gateway will be set to net+1
ip_ranges: if dynamic range is used, then an ip_range will be created from net[gateway+1 : -2] . If ip_ranges is present and contains several empty elements in the list, then the range net[gateway+1 : -2] will be divided in the same parts as the empty elemets in the list, for example, four ranges:
tag: VLAN tag, default = 0
groups: Each group can use a different driver for accessing network and node devices, use different network devices for each group.
driver: Describes a driver that should be used to manage networks and nodes. Can be ‘libvirt’ driver for virtual environments, ‘ipmi’ driver for baremetal nodes, or any additional custom driver (possible, vbox or docker drivers).
network_pools: Assign OpenStack networks with reserved address pools. In different groups can be used a different address pool for the same L3 network if necessary. This object is required only for external frameworks such as fuel-qa to proper cluster and nodes configuration.
l2_network_devices: List of network devices used in the current group. It is used for connecting node interfaces to the specified network devices. In case of ‘libvirt’ driver, there is a list of libvirt networks with additional properties such as forwarding mode, dhcp, network_pool used for the network, etc. In case of another driver there can be another list of parameters used by the driver, or the section can be omitted if not used.
nodes: List of nodes, where is described configuration of virtual or baremetal nodes: memory size, number of CPU cores, disks, network interfaces and some additional parameters, if it is necessary.
#============= # Main section #============= template: #===================================== # Sub-section for fuel-devops settings #===================================== devops_template: # Required option: env_name env_name: !os_env ENV_NAME #============================================================ # Address pools used in the environment # Fields: # net: required field, can be dynamic range # gateway: if dynamic range is used = net+1 # ip_ranges: if dynamic range is used = net[gateway+1 : -2] # tag: default = 0 # #============================================================ address_pools: admin_pool: net: !os_env POOL_DEFAULT, 10.109.0.0/16:24 params: tag: 0 public_pool_01: net: !os_env POOL_DEFAULT, 10.109.0.0/16:24 params: tag: 100 ip_ranges: - # If several empty elements are specified, then - # several equal sized ranges will be generated. public_pool_02: net: 188.8.131.52/26 # An external network pool example params: gateway: 184.108.40.206 # ip_ranges should be inside the net. for fuel-qa tests, # first range can be used for 'public range', and the rest # ranges - for 'floating ranges'. ip_ranges: - [220.127.116.11, 18.104.22.168] - [22.214.171.124, 126.96.36.199] tag: 200 storage_pool: net: !os_env POOL_DEFAULT, 10.109.0.0/16:24 params: tag: 101 management_pool: net: !os_env POOL_DEFAULT, 10.109.0.0/16:24 params: tag: 102 private_pool: net: !os_env POOL_DEFAULT, 10.109.0.0/16:24 params: tag: 103 #===================================================================== # Groups are used for describing multi-rack or multi-host environments # Each group has it's own hypervisor or baremetal driver #===================================================================== groups: # type: list of dicts - name: rack-01 #====================================================== # Settings for libvirt driver used in the current group #====================================================== driver: # type: dict # Various driver-specific options here name: devops.driver.libvirt.libvirt_driver params: # For different groups, different libvirt hosts can be used. connection_string: !os_env CONNECTION_STRING, qemu:///system storage_pool_name: !os_env STORAGE_POOL_NAME, default stp: True hpet: False use_host_cpu: !os_env DRIVER_USE_HOST_CPU, true #============================================================ # Pools allocated for OpenStack networks in the current group #============================================================ network_pools: # type: dict of lists # Actual names of OpenStack networks could be useful here as the # keys, so the external components like #fuel-qa could get # the necessary pool by the common name of the network. fuelweb_admin: admin_pool public: public_pool_01 storage: storage_pool management: management_pool private: private_pool #=============================================================== # List of network devices (libvirt bridges / baremetal switches) #=============================================================== l2_network_devices: admin01: # Name of the address pool that will be used for creating the # virtual network address_pool: admin_pool # Other parameters for the libvirt network dhcp: false forward: mode: nat public01: address_pool: public_pool_01 dhcp: false forward: mode: nat bond01: dhcp: false forward: mode: hostonly dumb: dhcp: false #================================================ # List of settings for nodes in the current group #================================================ nodes: # type: list of dicts - name: admin # Custom name of VM role: fuel_master # This role is used for Fuel master node params: # Here can be located settings for IPMI credentials of # baremetal driver or SSH credentials (if it is necessary # here) to access some already deployed nodes. # Following settings are used for creating a virtual node # instead of baremetal node: # Amount of virtual CPUs # ---------------------- vcpu: !os_env ADMIN_NODE_CPU, 2 # Amount of node memory in MB # --------------------------- memory: !os_env ADMIN_NODE_MEMORY, 3072 # Boot order # ---------- boot: - hd - cdrom # for boot from usb - without 'cdrom' # Volumes that should be created and attached to the node. # -------------------------------------------------------- volumes: # type: list of dicts # Empty volume with the specified size in GB - name: system capacity: !os_env ADMIN_NODE_VOLUME_SIZE, 75 format: qcow2 # Volume that will be filled from the specified source # image - name: iso # If 'source_image' set, then the capacity of the volume # is calculated from the image size. source_image: !os_env ISO_PATH format: raw device: cdrom # for boot from usb - 'disk' bus: ide # for boot from usb - 'usb' # Interfaces are described how many network interfaces has the # node and how they are connected to l2_network_devices # ------------------------------------------------------------ interfaces: - label: enp2s0 # First interface is connected l2_network_device: dumb # to the dumb l2 network device - label: enp2s1 # Second interface is connected l2_network_device: dumb # to the dumb l2 network device - label: enp3s0 # Third interface is connected l2_network_device: admin01 # to the l2 network device # admin01 # Here is described which OpenStack networks are assigned to # which network interfaces on the node. # This information is useful for external frameworks such as # fuel-qa, to get networks assigned correctly for nodes with # different configurations. # ---------------------------------------------------------- network_config: enp3s0: networks: - fuelweb_admin # Typical slave node with bonded interfaces # ----------------------------------------- - name: slave-01 role: fuel_slave params: vcpu: !os_env SLAVE_NODE_CPU, 2 memory: !os_env SLAVE_NODE_MEMORY, 3072 boot: - network - hd volumes: - name: system capacity: !os_env NODE_VOLUME_SIZE, 50 format: qcow2 - name: cinder capacity: !os_env NODE_VOLUME_SIZE, 50 format: qcow2 - name: swift capacity: !os_env NODE_VOLUME_SIZE, 50 format: qcow2 interfaces: - label: enp1s0 l2_network_device: admin01 - label: enp1s1 l2_network_device: public01 - label: enp2s0 l2_network_device: bond01 - label: enp2s1 l2_network_device: bond01 - label: enp2s2 l2_network_device: bond01 - label: enp2s3 l2_network_device: bond01 network_config: enp1s0: networks: - fuelweb_admin enp1s1: networks: - public bond0: # In case of 'aggregation', interface bond0 should # be used by an external framework such as fuel-qa # for customize node settings before deploy. networks: - management - storage - private aggregation: active-backup parents: - enp2s0 - enp2s1 - enp2s2 - enp2s3
To reduce amount of duplicated data in YAML, there can be used YAML aliases for volumes, interfaces and network_config objects, for example.
There should be provided some explicit options to set postgresql as the DB backend for CI servers.
Some shell commands for dos.py will be changed (those that create and scale the devops environment).
fuel-devops will keep back-compatibility to fuel-qa tests and shell commands ‘dos.py start/stop/destroy/erase’
Documentation for using updated #fuel-devops should be created, it is in work items.
Work items are tightly correspond to  and include: