1 # Copyright (c) 2017 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 # Bug workaround in pylint for abstract classes.
15 # pylint: disable=W0223
17 """Library to manipulate Containers."""
19 from collections import OrderedDict, Counter
21 from resources.libraries.python.ssh import SSH
22 from resources.libraries.python.constants import Constants
23 from resources.libraries.python.CpuUtils import CpuUtils
24 from resources.libraries.python.VppConfigGenerator import VppConfigGenerator
27 __all__ = ["ContainerManager", "ContainerEngine", "LXC", "Docker", "Container"]
29 SUPERVISOR_CONF = '/etc/supervisord.conf'
32 class ContainerManager(object):
33 """Container lifecycle management class."""
35 def __init__(self, engine):
36 """Initialize Container Manager class.
38 :param engine: Container technology used (LXC/Docker/...).
40 :raises NotImplementedError: If container technology is not implemented.
43 self.engine = globals()[engine]()
45 raise NotImplementedError('{e} is not implemented.'
47 self.containers = OrderedDict()
49 def get_container_by_name(self, name):
50 """Get container instance.
52 :param name: Container name.
54 :returns: Container instance.
56 :raises RuntimeError: If failed to get container with name.
59 return self.containers[name]
61 raise RuntimeError('Failed to get container with name: {n}'
64 def construct_container(self, **kwargs):
65 """Construct container object on node with specified parameters.
67 :param kwargs: Key-value pairs used to construct container.
71 self.engine.initialize()
74 setattr(self.engine.container, key, kwargs[key])
76 # Set additional environmental variables
77 setattr(self.engine.container, 'env',
78 'MICROSERVICE_LABEL={n}'.format(n=kwargs['name']))
80 # Set cpuset.cpus cgroup
81 skip_cnt = kwargs['cpu_skip']
82 if not kwargs['cpu_shared']:
83 skip_cnt += kwargs['i'] * kwargs['cpu_count']
84 self.engine.container.cpuset_cpus = \
85 CpuUtils.cpu_slice_of_list_per_node(node=kwargs['node'],
86 cpu_node=kwargs['cpuset_mems'],
88 cpu_cnt=kwargs['cpu_count'],
89 smt_used=kwargs['smt_used'])
91 # Store container instance
92 self.containers[kwargs['name']] = self.engine.container
94 def construct_containers(self, **kwargs):
95 """Construct 1..N container(s) on node with specified name.
97 Ordinal number is automatically added to the name of container as
100 :param kwargs: Named parameters.
103 name = kwargs['name']
104 for i in range(kwargs['count']):
105 # Name will contain ordinal suffix
106 kwargs['name'] = ''.join([name, str(i+1)])
108 self.construct_container(i=i, **kwargs)
110 def acquire_all_containers(self):
111 """Acquire all containers."""
112 for container in self.containers:
113 self.engine.container = self.containers[container]
114 self.engine.acquire()
116 def build_all_containers(self):
117 """Build all containers."""
118 for container in self.containers:
119 self.engine.container = self.containers[container]
122 def create_all_containers(self):
123 """Create all containers."""
124 for container in self.containers:
125 self.engine.container = self.containers[container]
128 def execute_on_container(self, name, command):
129 """Execute command on container with name.
131 :param name: Container name.
132 :param command: Command to execute.
136 self.engine.container = self.get_container_by_name(name)
137 self.engine.execute(command)
139 def execute_on_all_containers(self, command):
140 """Execute command on all containers.
142 :param command: Command to execute.
145 for container in self.containers:
146 self.engine.container = self.containers[container]
147 self.engine.execute(command)
149 def install_vpp_in_all_containers(self):
150 """Install VPP into all containers."""
151 for container in self.containers:
152 self.engine.container = self.containers[container]
153 # We need to install supervisor client/server system to control VPP
155 self.engine.install_supervisor()
156 self.engine.install_vpp()
157 self.engine.restart_vpp()
159 def configure_vpp_in_all_containers(self, vat_template_file):
160 """Configure VPP in all containers.
162 :param vat_template_file: Template file name of a VAT script.
163 :type vat_template_file: str
165 # Count number of DUTs based on node's host information
166 dut_cnt = len(Counter([self.containers[container].node['host']
167 for container in self.containers]))
168 container_cnt = len(self.containers)
169 mod = container_cnt/dut_cnt
171 for i, container in enumerate(self.containers):
174 sid1 = i % mod * 2 + 1
175 sid2 = i % mod * 2 + 2
176 self.engine.container = self.containers[container]
177 self.engine.create_vpp_startup_config()
178 self.engine.create_vpp_exec_config(vat_template_file, mid1=mid1,
179 mid2=mid2, sid1=sid1, sid2=sid2,
180 socket1='memif-{c.name}-{sid}'
181 .format(c=self.engine.container,
183 socket2='memif-{c.name}-{sid}'
184 .format(c=self.engine.container,
187 def stop_all_containers(self):
188 """Stop all containers."""
189 for container in self.containers:
190 self.engine.container = self.containers[container]
193 def destroy_all_containers(self):
194 """Destroy all containers."""
195 for container in self.containers:
196 self.engine.container = self.containers[container]
197 self.engine.destroy()
200 class ContainerEngine(object):
201 """Abstract class for container engine."""
204 """Init ContainerEngine object."""
205 self.container = None
207 def initialize(self):
208 """Initialize container object."""
209 self.container = Container()
211 def acquire(self, force):
212 """Acquire/download container.
214 :param force: Destroy a container if exists and create.
217 raise NotImplementedError
220 """Build container (compile)."""
221 raise NotImplementedError
224 """Create/deploy container."""
225 raise NotImplementedError
227 def execute(self, command):
228 """Execute process inside container.
230 :param command: Command to run inside container.
233 raise NotImplementedError
236 """Stop container."""
237 raise NotImplementedError
240 """Destroy/remove container."""
241 raise NotImplementedError
244 """Info about container."""
245 raise NotImplementedError
247 def system_info(self):
249 raise NotImplementedError
251 def install_supervisor(self):
252 """Install supervisord inside a container."""
253 self.execute('sleep 3')
254 self.execute('apt-get update')
255 self.execute('apt-get install -y supervisor')
256 self.execute('echo "{0}" > {1}'
258 '[unix_http_server]\n'
259 'file = /tmp/supervisor.sock\n\n'
260 '[rpcinterface:supervisor]\n'
261 'supervisor.rpcinterface_factory = '
262 'supervisor.rpcinterface:make_main_rpcinterface\n\n'
264 'serverurl = unix:///tmp/supervisor.sock\n\n'
266 'pidfile = /tmp/supervisord.pid\n'
267 'identifier = supervisor\n'
269 'logfile=/tmp/supervisord.log\n'
271 'nodaemon=false\n\n',
273 self.execute('supervisord -c {0}'.format(SUPERVISOR_CONF))
275 def install_vpp(self, install_dkms=False):
276 """Install VPP inside a container.
278 :param install_dkms: If install dkms package. This will impact install
279 time. Dkms is required for installation of vpp-dpdk-dkms. Default is
281 :type install_dkms: bool
283 self.execute('ln -s /dev/null /etc/sysctl.d/80-vpp.conf')
284 self.execute('apt-get update')
286 self.execute('apt-get install -y dkms && '
287 'dpkg -i --force-all {0}/install_dir/*.deb'
288 .format(self.container.guest_dir))
290 self.execute('for i in $(ls -I \"*dkms*\" {0}/install_dir/); '
291 'do dpkg -i --force-all {0}/install_dir/$i; done'
292 .format(self.container.guest_dir))
293 self.execute('apt-get -f install -y')
294 self.execute('apt-get install -y ca-certificates')
295 self.execute('echo "{0}" >> {1}'
298 'command=/usr/bin/vpp -c /etc/vpp/startup.conf\n'
299 'autorestart=false\n'
300 'redirect_stderr=true\n'
303 self.execute('supervisorctl reload')
305 def restart_vpp(self):
306 """Restart VPP service inside a container."""
307 self.execute('supervisorctl restart vpp')
309 def create_vpp_startup_config(self,
310 config_filename='/etc/vpp/startup.conf'):
311 """Create base startup configuration of VPP on container.
313 :param config_filename: Startup configuration file name.
314 :type config_filename: str
316 cpuset_cpus = self.container.cpuset_cpus
318 # Create config instance
319 vpp_config = VppConfigGenerator()
320 vpp_config.set_node(self.container.node)
321 vpp_config.add_unix_cli_listen()
322 vpp_config.add_unix_nodaemon()
323 vpp_config.add_unix_exec('/tmp/running.exec')
324 # We will pop first core from list to be main core
325 vpp_config.add_cpu_main_core(str(cpuset_cpus.pop(0)))
326 # if this is not only core in list, the rest will be used as workers.
328 corelist_workers = ','.join(str(cpu) for cpu in cpuset_cpus)
329 vpp_config.add_cpu_corelist_workers(corelist_workers)
330 vpp_config.add_plugin_disable('dpdk_plugin.so')
332 self.execute('mkdir -p /etc/vpp/')
333 self.execute('echo "{c}" | tee {f}'
334 .format(c=vpp_config.get_config_str(),
337 def create_vpp_exec_config(self, vat_template_file, **kwargs):
338 """Create VPP exec configuration on container.
340 :param vat_template_file: File name of a VAT template script.
341 :param kwargs: Parameters for VAT script.
342 :type vat_template_file: str
345 vat_file_path = '{p}/{f}'.format(p=Constants.RESOURCES_TPL_VAT,
348 with open(vat_file_path, 'r') as template_file:
349 cmd_template = template_file.readlines()
350 for line_tmpl in cmd_template:
351 vat_cmd = line_tmpl.format(**kwargs)
352 self.execute('echo "{c}" >> /tmp/running.exec'
353 .format(c=vat_cmd.replace('\n', '')))
355 def is_container_running(self):
356 """Check if container is running."""
357 raise NotImplementedError
359 def is_container_present(self):
360 """Check if container is present."""
361 raise NotImplementedError
363 def _configure_cgroup(self, name):
364 """Configure the control group associated with a container.
366 By default the cpuset cgroup is using exclusive CPU/MEM. When Docker
367 container is initialized a new cgroup /docker or /lxc is created under
368 cpuset parent tree. This newly created cgroup is inheriting parent
369 setting for cpu/mem exclusive parameter and thus cannot be overriden
370 within /docker or /lxc cgroup. This patch is supposed to set cpu/mem
371 exclusive parameter for both parent and subgroup.
373 :param name: Name of cgroup.
375 :raises RuntimeError: If applying cgroup settings via cgset failed.
377 ret, _, _ = self.container.ssh.exec_command_sudo(
378 'cgset -r cpuset.cpu_exclusive=0 /')
380 raise RuntimeError('Failed to apply cgroup settings.')
382 ret, _, _ = self.container.ssh.exec_command_sudo(
383 'cgset -r cpuset.mem_exclusive=0 /')
385 raise RuntimeError('Failed to apply cgroup settings.')
387 ret, _, _ = self.container.ssh.exec_command_sudo(
388 'cgcreate -g cpuset:/{name}'.format(name=name))
390 raise RuntimeError('Failed to copy cgroup settings from root.')
392 ret, _, _ = self.container.ssh.exec_command_sudo(
393 'cgset -r cpuset.cpu_exclusive=0 /{name}'.format(name=name))
395 raise RuntimeError('Failed to apply cgroup settings.')
397 ret, _, _ = self.container.ssh.exec_command_sudo(
398 'cgset -r cpuset.mem_exclusive=0 /{name}'.format(name=name))
400 raise RuntimeError('Failed to apply cgroup settings.')
403 class LXC(ContainerEngine):
404 """LXC implementation."""
407 """Initialize LXC object."""
408 super(LXC, self).__init__()
410 def acquire(self, force=True):
411 """Acquire a privileged system object where configuration is stored.
413 :param force: If a container exists, destroy it and create a new
416 :raises RuntimeError: If creating the container or writing the container
419 if self.is_container_present():
425 image = self.container.image if self.container.image else\
426 "-d ubuntu -r xenial -a amd64"
428 cmd = 'lxc-create -t download --name {c.name} -- {image} '\
429 '--no-validate'.format(c=self.container, image=image)
431 ret, _, _ = self.container.ssh.exec_command_sudo(cmd, timeout=1800)
433 raise RuntimeError('Failed to create container.')
435 if self.container.host_dir and self.container.guest_dir:
436 entry = 'lxc.mount.entry = '\
437 '{c.host_dir} /var/lib/lxc/{c.name}/rootfs{c.guest_dir} ' \
438 'none bind,create=dir 0 0'.format(c=self.container)
439 ret, _, _ = self.container.ssh.exec_command_sudo(
440 "sh -c 'echo \"{e}\" >> /var/lib/lxc/{c.name}/config'"
441 .format(e=entry, c=self.container))
443 raise RuntimeError('Failed to write {c.name} config.'
444 .format(c=self.container))
445 self._configure_cgroup('lxc')
448 """Create/deploy an application inside a container on system.
450 :raises RuntimeError: If creating the container fails.
452 cpuset_cpus = '{0}'.format(
453 ','.join('%s' % cpu for cpu in self.container.cpuset_cpus))\
454 if self.container.cpuset_cpus else ''
456 cmd = 'lxc-start --name {c.name} --daemon'.format(c=self.container)
458 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
460 raise RuntimeError('Failed to start container {c.name}.'
461 .format(c=self.container))
462 self._lxc_wait('RUNNING')
464 # Workaround for LXC to be able to allocate all cpus including isolated.
465 cmd = 'cgset --copy-from / lxc/'
466 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
468 raise RuntimeError('Failed to copy cgroup to LXC')
470 cmd = 'lxc-cgroup --name {c.name} cpuset.cpus {cpus}'\
471 .format(c=self.container, cpus=cpuset_cpus)
472 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
474 raise RuntimeError('Failed to set cpuset.cpus to container '
475 '{c.name}.'.format(c=self.container))
477 def execute(self, command):
478 """Start a process inside a running container.
480 Runs the specified command inside the container specified by name. The
481 container has to be running already.
483 :param command: Command to run inside container.
485 :raises RuntimeError: If running the command failed.
487 env = '--keep-env {0}'.format(
488 ' '.join('--set-var %s' % env for env in self.container.env))\
489 if self.container.env else ''
491 cmd = "lxc-attach {env} --name {c.name} -- /bin/sh -c '{command}'"\
492 .format(env=env, c=self.container, command=command)
494 ret, _, _ = self.container.ssh.exec_command_sudo(cmd, timeout=180)
496 raise RuntimeError('Failed to run command inside container '
497 '{c.name}.'.format(c=self.container))
502 :raises RuntimeError: If stopping the container failed.
504 cmd = 'lxc-stop --name {c.name}'.format(c=self.container)
506 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
508 raise RuntimeError('Failed to stop container {c.name}.'
509 .format(c=self.container))
510 self._lxc_wait('STOPPED|FROZEN')
513 """Destroy a container.
515 :raises RuntimeError: If destroying container failed.
517 cmd = 'lxc-destroy --force --name {c.name}'.format(c=self.container)
519 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
521 raise RuntimeError('Failed to destroy container {c.name}.'
522 .format(c=self.container))
525 """Query and shows information about a container.
527 :raises RuntimeError: If getting info about a container failed.
529 cmd = 'lxc-info --name {c.name}'.format(c=self.container)
531 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
533 raise RuntimeError('Failed to get info about container {c.name}.'
534 .format(c=self.container))
536 def system_info(self):
537 """Check the current kernel for LXC support.
539 :raises RuntimeError: If checking LXC support failed.
541 cmd = 'lxc-checkconfig'
543 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
545 raise RuntimeError('Failed to check LXC support.')
547 def is_container_running(self):
548 """Check if container is running on node.
550 :returns: True if container is running.
552 :raises RuntimeError: If getting info about a container failed.
554 cmd = 'lxc-info --no-humanize --state --name {c.name}'\
555 .format(c=self.container)
557 ret, stdout, _ = self.container.ssh.exec_command_sudo(cmd)
559 raise RuntimeError('Failed to get info about container {c.name}.'
560 .format(c=self.container))
561 return True if 'RUNNING' in stdout else False
563 def is_container_present(self):
564 """Check if container is existing on node.
566 :returns: True if container is present.
568 :raises RuntimeError: If getting info about a container failed.
570 cmd = 'lxc-info --no-humanize --name {c.name}'.format(c=self.container)
572 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
573 return False if int(ret) else True
575 def _lxc_wait(self, state):
576 """Wait for a specific container state.
578 :param state: Specify the container state(s) to wait for.
580 :raises RuntimeError: If waiting for state of a container failed.
582 cmd = 'lxc-wait --name {c.name} --state "{s}"'\
583 .format(c=self.container, s=state)
585 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
587 raise RuntimeError('Failed to wait for state "{s}" of container '
588 '{c.name}.'.format(s=state, c=self.container))
591 class Docker(ContainerEngine):
592 """Docker implementation."""
595 """Initialize Docker object."""
596 super(Docker, self).__init__()
598 def acquire(self, force=True):
599 """Pull an image or a repository from a registry.
601 :param force: Destroy a container if exists.
603 :raises RuntimeError: If pulling a container failed.
605 if self.is_container_present():
611 cmd = 'docker pull {c.image}'.format(c=self.container)
613 ret, _, _ = self.container.ssh.exec_command_sudo(cmd, timeout=1800)
615 raise RuntimeError('Failed to create container {c.name}.'
616 .format(c=self.container))
617 self._configure_cgroup('docker')
620 """Create/deploy container.
622 :raises RuntimeError: If creating a container failed.
624 cpuset_cpus = '--cpuset-cpus={0}'.format(
625 ','.join('%s' % cpu for cpu in self.container.cpuset_cpus))\
626 if self.container.cpuset_cpus else ''
628 cpuset_mems = '--cpuset-mems={0}'.format(self.container.cpuset_mems)\
629 if self.container.cpuset_mems is not None else ''
632 ' '.join('--env %s' % env for env in self.container.env))\
633 if self.container.env else ''
635 command = '{0}'.format(self.container.command)\
636 if self.container.command else ''
638 publish = '{0}'.format(
639 ' '.join('--publish %s' % var for var in self.container.publish))\
640 if self.container.publish else ''
642 volume = '--volume {c.host_dir}:{c.guest_dir}'.format(c=self.container)\
643 if self.container.host_dir and self.container.guest_dir else ''
646 '--privileged --detach --interactive --tty --rm '\
647 '--cgroup-parent docker {cpuset_cpus} {cpuset_mems} {publish} '\
648 '{env} {volume} --name {container.name} {container.image} '\
649 '{command}'.format(cpuset_cpus=cpuset_cpus, cpuset_mems=cpuset_mems,
650 container=self.container, command=command,
651 env=env, publish=publish, volume=volume)
653 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
655 raise RuntimeError('Failed to create container {c.name}'
656 .format(c=self.container))
660 def execute(self, command):
661 """Start a process inside a running container.
663 Runs the specified command inside the container specified by name. The
664 container has to be running already.
666 :param command: Command to run inside container.
668 :raises RuntimeError: If runnig the command in a container failed.
670 cmd = "docker exec --interactive {c.name} /bin/sh -c '{command}'"\
671 .format(c=self.container, command=command)
673 ret, _, _ = self.container.ssh.exec_command_sudo(cmd, timeout=180)
675 raise RuntimeError('Failed to execute command in container '
676 '{c.name}.'.format(c=self.container))
679 """Stop running container.
681 :raises RuntimeError: If stopping a container failed.
683 cmd = 'docker stop {c.name}'.format(c=self.container)
685 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
687 raise RuntimeError('Failed to stop container {c.name}.'
688 .format(c=self.container))
691 """Remove a container.
693 :raises RuntimeError: If removing a container failed.
695 cmd = 'docker rm --force {c.name}'.format(c=self.container)
697 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
699 raise RuntimeError('Failed to destroy container {c.name}.'
700 .format(c=self.container))
703 """Return low-level information on Docker objects.
705 :raises RuntimeError: If getting info about a container failed.
707 cmd = 'docker inspect {c.name}'.format(c=self.container)
709 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
711 raise RuntimeError('Failed to get info about container {c.name}.'
712 .format(c=self.container))
714 def system_info(self):
715 """Display the docker system-wide information.
717 :raises RuntimeError: If displaying system information failed.
719 cmd = 'docker system info'
721 ret, _, _ = self.container.ssh.exec_command_sudo(cmd)
723 raise RuntimeError('Failed to get system info.')
725 def is_container_present(self):
726 """Check if container is present on node.
728 :returns: True if container is present.
730 :raises RuntimeError: If getting info about a container failed.
732 cmd = 'docker ps --all --quiet --filter name={c.name}'\
733 .format(c=self.container)
735 ret, stdout, _ = self.container.ssh.exec_command_sudo(cmd)
737 raise RuntimeError('Failed to get info about container {c.name}.'
738 .format(c=self.container))
739 return True if stdout else False
741 def is_container_running(self):
742 """Check if container is running on node.
744 :returns: True if container is running.
746 :raises RuntimeError: If getting info about a container failed.
748 cmd = 'docker ps --quiet --filter name={c.name}'\
749 .format(c=self.container)
751 ret, stdout, _ = self.container.ssh.exec_command_sudo(cmd)
753 raise RuntimeError('Failed to get info about container {c.name}.'
754 .format(c=self.container))
755 return True if stdout else False
758 class Container(object):
759 """Container class."""
762 """Initialize Container object."""
765 def __getattr__(self, attr):
766 """Get attribute custom implementation.
768 :param attr: Attribute to get.
770 :returns: Attribute value or None.
774 return self.__dict__[attr]
778 def __setattr__(self, attr, value):
779 """Set attribute custom implementation.
781 :param attr: Attribute to set.
782 :param value: Value to set.
787 # Check if attribute exists
790 # Creating new attribute
792 self.__dict__['ssh'] = SSH()
793 self.__dict__['ssh'].connect(value)
794 self.__dict__[attr] = value
796 # Updating attribute base of type
797 if isinstance(self.__dict__[attr], list):
798 self.__dict__[attr].append(value)
800 self.__dict__[attr] = value