Version 1 (modified by Ted Faber, 12 years ago) (diff)


Reference Guide

This document describes the details of the commands and data structures that make up the containers system. The User Guide /Tutotial? provides useful context about the workflows and goals of the system that inform these technical details.

The command creates a DETER experiment made up of containers. The program is available from /share/containers/ on A sample invocation is:

$ /share/containers/ MyProject MyExperiment ~/mytopology.tcl

It will create a new experiment in MyProject called MyExperiment containing the experiment topology in mytopology.tcl. All the topology creation commands supported by DETER are supported by the conatainerization system, but emulab/DETER program agents are not. Emulab/DETER start commands are supported.

Containers will create an experiment in a group if the project parameter is of the form project/group. To start an experiment in the testing group of the DETER project, the first parameter is specified as DETER/testing.

Either an ns2 file or a topdl description is supported. Ns2 descriptions must end with .tcl or .ns. Other files are assumed to be topdl descriptions.

By default, program will partition the topology into openvz containers, packed 10 containers per physical computer. If the topology is already partitioned - at least one element has a conatiners::partition atttribute - will not partition it. The --force-partition flag causes to partition the experiment regardless of the presence of containers:partition attributes.

If container types have been assigned to nodes using the containers:node_type attribute, will respect them. Valid container types for the containers:node_type attribute or the --default-container parameter are:

Parameter Container
embedded_pnode Physical Node
qemu Qemu VM
openvz Openvz Container
process ViewOS process

The command takes several parameters that can change its behavior:

Containerize nodes without a container type into kind. If no nodes have been assigned containers, this puts all them into kind containers.
Partition the experiment whether or not it has been paritioned already
Attempt to put int containers into each physical node. The default --packing is 10.
Read configuration variables from filename the configuration values are discussed below.
Override the site configuration and request nodes of type1 (or type2 etc.) as host nodes.
Attempt to do end node traffic shaping even in containers connected by VDE switches. This works with qemu nodes, but not process nodes. Topologies that include both openvz nodes and qemu nodes that shape traffic should use this.
Do traffic shaping in VDE switches. Probably the default, but that is controlled in the site configuration.
Construct a visualization of the virtual topology and leave it in the experiment directories (default)
Do not construct a visualization of the virtual topology and leave it in the experiment directories
Print additional diagnostics and leave failed DETER experiments on the testbed
Do not remove temporary files - for debugging only

This invocation:

$ ./ --packing 25 --default-container=qemu --force-partition DeterTest faber-packem ~/experiment.xml

takes the topology in ~/experiment.xml (which must be topdl), packs it into 25 qemu containers per physical node, and creates an experiment called DeterTest/faber-packem that can be swapped in. If experiment.xml were already partitioned, it will be re-partitioned. If some nodes in that topology were assigned to openvz nodes already, those nodes will be still be in openvz containers.

The result of a successful run is a DETER experiment that can be swapped in.

More detailed examples are available in the tutorial?

Site Configuration File

The site configuration file is an attribute value pair file parsed by a python ConfigParser that sets overall container parameters. Many of these have legacy internal names.

The default site configuration is in /share/containers/site.conf on

Acceptable values (and their DETER defaults) are:

The IRC server used as a backend coordination service for grandstand. Will be replaced by MAGI. Default:
Port that third party applications can contact grandstand on. Will be replaced by MAGI. Default: 4919
Default image used by qemu containers. Default: http://scratch/benito/pangolinbz.img.bz2
Base URL of the DETER web interface on which users can see experiments. Default:
Hardware used by containers. Default: pc2133,bpc2133,MicroCloud
Host and port from which to request experiment creation. Default:
OSID to request for qemu container nodess. Default: Ubuntu1204-64-STD
Root of the directory tree holding containers software and libraries. Developers often change this. Default: /share/containers
OSID to request for openvz nodes. Default CentOS6-64-openvz
Location to load the openvz template from. Default: %(exec_root)s/images/ubuntu-10.04-x86.tar.gz
True if switched containers (see below) should do traffic shaping in the VDE switch that connects them. Default: true
A list of the containers that are networked with VDE switches. Default: qemu,process

Attachments (3)

Download all attachments as: .zip