On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

Multiple objects have names, and it is desirable to reserve the 'name' arg to refer to the name of the sandbox instance, so rename 'name' to 'template'.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index ec96c7e..89eef1a 100644 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -327,37 +327,37 @@ def create_template(name, imagepath, format, destdir): parentImage = templateImage

def download(args): - info("Downloading %s from %s to %s\n" % (args.name, default_index_server, default_template_dir)) - download_template(args.name, default_index_server, default_template_dir) + info("Downloading %s from %s to %s\n" % (args.template, default_index_server, default_template_dir)) + download_template(args.template, default_index_server, default_template_dir)

def delete(args): - info("Deleting %s from %s\n" % (args.name, default_template_dir)) - delete_template(args.name, default_template_dir) + info("Deleting %s from %s\n" % (args.template, default_template_dir)) + delete_template(args.template, default_template_dir)

def create(args): - info("Creating %s from %s in format %s\n" % (args.imagepath, args.name, args.format)) - create_template(args.name, args.imagepath, args.format, default_template_dir) + info("Creating %s from %s in format %s\n" % (args.imagepath, args.template, args.format)) + create_template(args.template, args.imagepath, args.format, default_template_dir)

-def requires_name(parser): - parser.add_argument("name", +def requires_template(parser): + parser.add_argument("template", help=_("name of the template"))

def gen_download_args(subparser): parser = subparser.add_parser("download", help=_("Download template data")) - requires_name(parser) + requires_template(parser) parser.set_defaults(func=download)

def gen_delete_args(subparser): parser = subparser.add_parser("delete", help=_("Delete template data")) - requires_name(parser) + requires_template(parser) parser.set_defaults(func=delete)

def gen_create_args(subparser): parser = subparser.add_parser("create", help=_("Create image from template data")) - requires_name(parser) + requires_template(parser) parser.add_argument("imagepath", help=_("path for image")) parser.add_argument("format",

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Authentication fix for Docker REST API.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index 89eef1a..ea04820 100644 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -1,8 +1,10 @@ #!/usr/bin/python -Es # # Authors: Daniel P. Berrange <berrange@redhat.com> +# Eren Yagdiran <erenyagdiran@gmail.com> # # Copyright (C) 2013 Red Hat, Inc. +# Copyright (C) 2015 Universitat Politècnica de Catalunya. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -166,7 +168,7 @@ def download_template(name, server, destdir): # or more parents, in a linear stack. Here we are getting the list # of layers for the image with the tag we used. (data, res) = get_json(registryserver, "/v1/images/" + imagetagid + "/ancestry", - { "Cookie": cookie }) + { "Authorization": "Token " + token })

if data[0] != imagetagid: raise ValueError(["Expected first layer id '%s' to match image id '%s'", @@ -188,9 +190,9 @@ def download_template(name, server, destdir): if not os.path.exists(jsonfile) or not os.path.exists(datafile): # The '/json' URL gives us some metadata about the layer res = save_data(registryserver, "/v1/images/" + layerid + "/json", - { "Cookie": cookie }, jsonfile) + { "Authorization": "Token " + token }, jsonfile) createdFiles.append(jsonfile) - layersize = int(res.info().getheader("x-docker-size")) + layersize = int(res.info().getheader("Content-Length"))

datacsum = None if layerid in checksums: @@ -199,7 +201,7 @@ def download_template(name, server, destdir): # and the '/layer' URL is the actual payload, provided # as a tar.gz archive save_data(registryserver, "/v1/images/" + layerid + "/layer", - { "Cookie": cookie }, datafile, datacsum, layersize) + { "Authorization": "Token " + token }, datafile, datacsum, layersize) createdFiles.append(datafile)

# Strangely the 'json' data for a layer doesn't include

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Define a 'Source' class which is an abstract base to use for different template repository sources. Initially there will be a docker source which can talk to the Docker repository REST API, but others may follow.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- .gitignore | 1 + configure.ac | 1 + libvirt-sandbox/image/Makefile.am | 2 ++ libvirt-sandbox/image/cli.py | 15 ++++++++------ libvirt-sandbox/image/sources/Makefile.am | 8 ++++++++ libvirt-sandbox/image/sources/Source.py | 33 +++++++++++++++++++++++++++++++ libvirt-sandbox/image/sources/__init__.py | 0 7 files changed, 54 insertions(+), 6 deletions(-) mode change 100644 => 100755 libvirt-sandbox/image/cli.py create mode 100644 libvirt-sandbox/image/sources/Makefile.am create mode 100644 libvirt-sandbox/image/sources/Source.py create mode 100644 libvirt-sandbox/image/sources/__init__.py

diff --git a/.gitignore b/.gitignore index f77ea12..390d65c 100644 --- a/.gitignore +++ b/.gitignore @@ -42,6 +42,7 @@ libvirt-sandbox/LibvirtSandbox-1.0.typelib *.lo *.la *.o +*.pyc *~ libvirt-sandbox/libvirt-sandbox-init-lxc libvirt-sandbox/libvirt-sandbox-init-common diff --git a/configure.ac b/configure.ac index a8376ca..92d65f4 100644 --- a/configure.ac +++ b/configure.ac @@ -130,6 +130,7 @@ AC_OUTPUT(Makefile libvirt-sandbox/Makefile libvirt-sandbox/tests/Makefile libvirt-sandbox/image/Makefile + libvirt-sandbox/image/sources/Makefile bin/Makefile examples/Makefile docs/Makefile diff --git a/libvirt-sandbox/image/Makefile.am b/libvirt-sandbox/image/Makefile.am index 7c8da51..344a881 100644 --- a/libvirt-sandbox/image/Makefile.am +++ b/libvirt-sandbox/image/Makefile.am @@ -1,4 +1,6 @@

+SUBDIRS = sources + pythonsandboxdir = $(pythondir)/libvirt_sandbox pythonsandbox_DATA = __init__.py

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py old mode 100644 new mode 100755 index ea04820..3bf7d58 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -1,5 +1,5 @@ #!/usr/bin/python -Es -# +# -*- coding: utf-8 -*- # Authors: Daniel P. Berrange <berrange@redhat.com> # Eren Yagdiran <erenyagdiran@gmail.com> # @@ -32,11 +32,14 @@ import sys import urllib2 import subprocess

-default_index_server = "index.docker.io" -default_template_dir = "/var/lib/libvirt/templates" - -debug = True -verbose = True +import importlib +def dynamic_source_loader(name): + name = name[0].upper() + name[1:] + modname = "libvirt_sandbox.image.sources." + name + "Source" + mod = importlib.import_module(modname) + classname = name + "Source" + classimpl = getattr(mod, classname) + return classimpl()

gettext.bindtextdomain("libvirt-sandbox", "/usr/share/locale") gettext.textdomain("libvirt-sandbox") diff --git a/libvirt-sandbox/image/sources/Makefile.am b/libvirt-sandbox/image/sources/Makefile.am new file mode 100644 index 0000000..48d0f33 --- /dev/null +++ b/libvirt-sandbox/image/sources/Makefile.am @@ -0,0 +1,8 @@ + +pythonimagedir = $(pythondir)/libvirt_sandbox/image/sources +pythonimage_DATA = \ + __init__.py \ + Source.py \ + $(NULL) + +EXTRA_DIST = $(pythonimage_DATA) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py new file mode 100644 index 0000000..f12b0eb --- /dev/null +++ b/libvirt-sandbox/image/sources/Source.py @@ -0,0 +1,33 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 Universitat Politècnica de Catalunya. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# +# Author: Eren Yagdiran <erenyagdiran@gmail.com> + +from abc import ABCMeta, abstractmethod + +class Source(): + '''The Source class defines the base interface for + all image provider source implementations. An image + provide source is able to download templates from + a repository, convert them to a host specific image + format and report commands used to invoke them.''' + + __metaclass__ = ABCMeta + def __init__(self): + pass diff --git a/libvirt-sandbox/image/sources/__init__.py b/libvirt-sandbox/image/sources/__init__.py new file mode 100644 index 0000000..e69de29

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Define some constants to refer to the default image and template storage directories

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 10 ++++++++++ 1 file changed, 10 insertions(+)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index 3bf7d58..de34321 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -32,6 +32,16 @@ import sys import urllib2 import subprocess

+if os.geteuid() == 0: + default_template_dir = "/var/lib/libvirt/templates" + default_image_dir = "/var/lib/libvirt/images" +else: + default_template_dir = os.environ['HOME'] + "/.local/share/libvirt/templates" + default_image_dir = os.environ['HOME'] + "/.local/share/libvirt/images" + +debug = False +verbose = False + import importlib def dynamic_source_loader(name): name = name[0].upper() + name[1:]

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Refactor download function from virt-sandbox-image to use the newly introduced Source abstract class. The docker-specific download code is moved to a new DockerSource class.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 204 ++++--------------------- libvirt-sandbox/image/sources/DockerSource.py | 209 ++++++++++++++++++++++++++ libvirt-sandbox/image/sources/Makefile.am | 1 + libvirt-sandbox/image/sources/Source.py | 15 ++ 4 files changed, 257 insertions(+), 172 deletions(-) create mode 100644 libvirt-sandbox/image/sources/DockerSource.py

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index de34321..7af617e 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -69,176 +69,6 @@ def debug(msg): def info(msg): sys.stdout.write(msg)

-def get_url(server, path, headers): - url = "https://" + server + path - debug(" Fetching %s..." % url) - req = urllib2.Request(url=url) - - if json: - req.add_header("Accept", "application/json") - - for h in headers.keys(): - req.add_header(h, headers[h]) - - return urllib2.urlopen(req) - -def get_json(server, path, headers): - try: - res = get_url(server, path, headers) - data = json.loads(res.read()) - debug("OK\n") - return (data, res) - except Exception, e: - debug("FAIL %s\n" % str(e)) - raise - -def save_data(server, path, headers, dest, checksum=None, datalen=None): - try: - res = get_url(server, path, headers) - - csum = None - if checksum is not None: - csum = hashlib.sha256() - - pattern = [".", "o", "O", "o"] - patternIndex = 0 - donelen = 0 - - with open(dest, "w") as f: - while 1: - buf = res.read(1024*64) - if not buf: - break - if csum is not None: - csum.update(buf) - f.write(buf) - - if datalen is not None: - donelen = donelen + len(buf) - debug("\x1b[s%s (%5d Kb of %5d Kb)\x1b8" % ( - pattern[patternIndex], (donelen/1024), (datalen/1024) - )) - patternIndex = (patternIndex + 1) % 4 - - debug("\x1b[K") - if csum is not None: - csumstr = "sha256:" + csum.hexdigest() - if csumstr != checksum: - debug("FAIL checksum '%s' does not match '%s'" % (csumstr, checksum)) - os.remove(dest) - raise IOError("Checksum '%s' for data does not match '%s'" % (csumstr, checksum)) - debug("OK\n") - return res - except Exception, e: - debug("FAIL %s\n" % str(e)) - raise - - -def download_template(name, server, destdir): - tag = "latest" - - offset = name.find(':') - if offset != -1: - tag = name[offset + 1:] - name = name[0:offset] - - # First we must ask the index server about the image name. THe - # index server will return an auth token we can use when talking - # to the registry server. We need this token even when anonymous - try: - (data, res) = get_json(server, "/v1/repositories/" + name + "/images", - {"X-Docker-Token": "true"}) - except urllib2.HTTPError, e: - raise ValueError(["Image '%s' does not exist" % name]) - - registryserver = res.info().getheader('X-Docker-Endpoints') - token = res.info().getheader('X-Docker-Token') - checksums = {} - for layer in data: - pass - # XXX Checksums here don't appear to match the data in - # image download later. Find out what these are sums of - #checksums[layer["id"]] = layer["checksum"] - - # Now we ask the registry server for the list of tags associated - # with the image. Tags usually reflect some kind of version of - # the image, but they aren't officially "versions". There is - # always a "latest" tag which is the most recent upload - # - # We must pass in the auth token from the index server. This - # token can only be used once, and we're given a cookie back - # in return to use for later RPC calls. - (data, res) = get_json(registryserver, "/v1/repositories/" + name + "/tags", - { "Authorization": "Token " + token }) - - cookie = res.info().getheader('Set-Cookie') - - if not tag in data: - raise ValueError(["Tag '%s' does not exist for image '%s'" % (tag, name)]) - imagetagid = data[tag] - - # Only base images are self-contained, most images reference one - # or more parents, in a linear stack. Here we are getting the list - # of layers for the image with the tag we used. - (data, res) = get_json(registryserver, "/v1/images/" + imagetagid + "/ancestry", - { "Authorization": "Token " + token }) - - if data[0] != imagetagid: - raise ValueError(["Expected first layer id '%s' to match image id '%s'", - data[0], imagetagid]) - - try: - createdFiles = [] - createdDirs = [] - - for layerid in data: - templatedir = destdir + "/" + layerid - if not os.path.exists(templatedir): - os.mkdir(templatedir) - createdDirs.append(templatedir) - - jsonfile = templatedir + "/template.json" - datafile = templatedir + "/template.tar.gz" - - if not os.path.exists(jsonfile) or not os.path.exists(datafile): - # The '/json' URL gives us some metadata about the layer - res = save_data(registryserver, "/v1/images/" + layerid + "/json", - { "Authorization": "Token " + token }, jsonfile) - createdFiles.append(jsonfile) - layersize = int(res.info().getheader("Content-Length")) - - datacsum = None - if layerid in checksums: - datacsum = checksums[layerid] - - # and the '/layer' URL is the actual payload, provided - # as a tar.gz archive - save_data(registryserver, "/v1/images/" + layerid + "/layer", - { "Authorization": "Token " + token }, datafile, datacsum, layersize) - createdFiles.append(datafile) - - # Strangely the 'json' data for a layer doesn't include - # its actual name, so we save that in a json file of our own - index = { - "name": name, - } - - indexfile = destdir + "/" + imagetagid + "/index.json" - with open(indexfile, "w") as f: - f.write(json.dumps(index)) - except Exception, e: - for f in createdFiles: - try: - os.remove(f) - except: - pass - for d in createdDirs: - try: - os.rmdir(d) - except: - pass - - def delete_template(name, destdir): imageusage = {} imageparent = {} @@ -342,8 +172,16 @@ def create_template(name, imagepath, format, destdir): parentImage = templateImage

def download(args): - info("Downloading %s from %s to %s\n" % (args.template, default_index_server, default_template_dir)) - download_template(args.template, default_index_server, default_template_dir) + try: + dynamic_source_loader(args.source).download_template(templatename=args.template, + templatedir=args.template_dir, + registry=args.registry, + username=args.username, + password=args.password) + except IOError,e: + print "Source %s cannot be found in given path" %args.source + except Exception,e: + print "Download Error %s" % str(e)

def delete(args): info("Deleting %s from %s\n" % (args.template, default_template_dir)) @@ -357,10 +195,32 @@ def requires_template(parser): parser.add_argument("template", help=_("name of the template"))

+def requires_source(parser): + parser.add_argument("-s","--source", + default="docker", + help=_("name of the template")) + +def requires_auth_conn(parser): + parser.add_argument("-r","--registry", + help=_("Url of the custom registry"))

This wording really sounds docker-specific. The registry word only fits docker terminology, would surely not apply to virt-builder or appc case. Something like "images storage" would may be more generic. The problem is that "repository" has a special meaning in the docker terminology.

+ parser.add_argument("-u","--username", + help=_("Username for the custom registry")) + parser.add_argument("-p","--password", + help=_("Password for the custom registry")) + +def requires_template_dir(parser): + global default_template_dir + parser.add_argument("-t","--template-dir", + default=default_template_dir, + help=_("Template directory for saving templates")) + def gen_download_args(subparser): parser = subparser.add_parser("download", help=_("Download template data")) requires_template(parser) + requires_source(parser) + requires_auth_conn(parser) + requires_template_dir(parser) parser.set_defaults(func=download)

def gen_delete_args(subparser): diff --git a/libvirt-sandbox/image/sources/DockerSource.py b/libvirt-sandbox/image/sources/DockerSource.py new file mode 100644 index 0000000..37b40dc --- /dev/null +++ b/libvirt-sandbox/image/sources/DockerSource.py @@ -0,0 +1,209 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 Universitat Politècnica de Catalunya. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# +# Author: Eren Yagdiran <erenyagdiran@gmail.com> +# + +from Source import Source +import urllib2 +import sys +import json +import traceback +import os +import subprocess +import shutil + +class DockerSource(Source): + + www_auth_username = None + www_auth_password = None + + def __init__(self): + self.default_index_server = "index.docker.io" + + def _check_cert_validate(self): + major = sys.version_info.major + SSL_WARNING = "SSL certificates couldn't be validated by default. You need to have 2.7.9/3.4.3 or higher" + SSL_WARNING +="\nSee https://bugs.python.org/issue22417\n" + py2_7_9_hexversion = 34015728 + py3_4_3_hexversion = 50594800 + if (major == 2 and sys.hexversion < py2_7_9_hexversion) or (major == 3 and sys.hexversion < py3_4_3_hexversion): + sys.stderr.write(SSL_WARNING) + + def download_template(self, templatename, templatedir, + registry=None, username=None, password=None): + if registry is None: + registry = self.default_index_server + + if username is not None: + self.www_auth_username = username + self.www_auth_password = password + + self._check_cert_validate() + tag = "latest" + offset = templatename.find(':') + if offset != -1: + tag = templatename[offset + 1:] + templatename = templatename[0:offset] + try: + (data, res) = self._get_json(registry, "/v1/repositories/" + templatename + "/images", + {"X-Docker-Token": "true"}) + except urllib2.HTTPError, e: + raise ValueError(["Image '%s' does not exist" % templatename]) + + registryendpoint = res.info().getheader('X-Docker-Endpoints') + token = res.info().getheader('X-Docker-Token') + checksums = {} + for layer in data: + pass + (data, res) = self._get_json(registryendpoint, "/v1/repositories/" + templatename + "/tags", + { "Authorization": "Token " + token }) + + cookie = res.info().getheader('Set-Cookie') + + if not tag in data: + raise ValueError(["Tag '%s' does not exist for image '%s'" % (tag, templatename)]) + imagetagid = data[tag] + + (data, res) = self._get_json(registryendpoint, "/v1/images/" + imagetagid + "/ancestry", + { "Authorization": "Token "+token }) + + if data[0] != imagetagid: + raise ValueError(["Expected first layer id '%s' to match image id '%s'", + data[0], imagetagid]) + + try: + createdFiles = [] + createdDirs = [] + + for layerid in data: + layerdir = templatedir + "/" + layerid + if not os.path.exists(layerdir): + os.makedirs(layerdir) + createdDirs.append(layerdir) + + jsonfile = layerdir + "/template.json" + datafile = layerdir + "/template.tar.gz" + + if not os.path.exists(jsonfile) or not os.path.exists(datafile): + res = self._save_data(registryendpoint, "/v1/images/" + layerid + "/json", + { "Authorization": "Token " + token }, jsonfile) + createdFiles.append(jsonfile) + + layersize = int(res.info().getheader("Content-Length")) + + datacsum = None + if layerid in checksums: + datacsum = checksums[layerid] + + self._save_data(registryendpoint, "/v1/images/" + layerid + "/layer", + { "Authorization": "Token "+token }, datafile, datacsum, layersize) + createdFiles.append(datafile) + + index = { + "name": templatename, + } + + indexfile = templatedir + "/" + imagetagid + "/index.json" + print("Index file " + indexfile) + with open(indexfile, "w") as f: + f.write(json.dumps(index)) + except Exception as e: + traceback.print_exc() + for f in createdFiles: + try: + os.remove(f) + except: + pass + for d in createdDirs: + try: + shutil.rmtree(d) + except: + pass + def _save_data(self,server, path, headers, dest, checksum=None, datalen=None): + try: + res = self._get_url(server, path, headers) + + csum = None + if checksum is not None: + csum = hashlib.sha256() + + pattern = [".", "o", "O", "o"] + patternIndex = 0 + donelen = 0 + + with open(dest, "w") as f: + while 1: + buf = res.read(1024*64) + if not buf: + break + if csum is not None: + csum.update(buf) + f.write(buf) + + if datalen is not None: + donelen = donelen + len(buf) + debug("\x1b[s%s (%5d Kb of %5d Kb)\x1b8" % ( + pattern[patternIndex], (donelen/1024), (datalen/1024) + )) + patternIndex = (patternIndex + 1) % 4 + + debug("\x1b[K") + if csum is not None: + csumstr = "sha256:" + csum.hexdigest() + if csumstr != checksum: + debug("FAIL checksum '%s' does not match '%s'" % (csumstr, checksum)) + os.remove(dest) + raise IOError("Checksum '%s' for data does not match '%s'" % (csumstr, checksum)) + debug("OK\n") + return res + except Exception, e: + debug("FAIL %s\n" % str(e)) + raise + + def _get_url(self,server, path, headers): + url = "https://" + server + path + debug("Fetching %s..." % url) + + req = urllib2.Request(url=url) + if json: + req.add_header("Accept", "application/json") + for h in headers.keys(): + req.add_header(h, headers[h]) + + #www Auth header starts + if self.www_auth_username is not None: + base64string = base64.encodestring('%s:%s' % (self.www_auth_username, self.www_auth_password)).replace('\n', '') + req.add_header("Authorization", "Basic %s" % base64string) + #www Auth header finish + + return urllib2.urlopen(req) + + def _get_json(self,server, path, headers): + try: + res = self._get_url(server, path, headers) + data = json.loads(res.read()) + debug("OK\n") + return (data, res) + except Exception, e: + debug("FAIL %s\n" % str(e)) + raise + +def debug(msg): + sys.stderr.write(msg) diff --git a/libvirt-sandbox/image/sources/Makefile.am b/libvirt-sandbox/image/sources/Makefile.am index 48d0f33..069557d 100644 --- a/libvirt-sandbox/image/sources/Makefile.am +++ b/libvirt-sandbox/image/sources/Makefile.am @@ -3,6 +3,7 @@ pythonimagedir = $(pythondir)/libvirt_sandbox/image/sources pythonimage_DATA = \ __init__.py \ Source.py \ + DockerSource.py \ $(NULL)

EXTRA_DIST = $(pythonimage_DATA) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py index f12b0eb..81f5176 100644 --- a/libvirt-sandbox/image/sources/Source.py +++ b/libvirt-sandbox/image/sources/Source.py @@ -31,3 +31,18 @@ class Source(): __metaclass__ = ABCMeta def __init__(self): pass + + @abstractmethod + def download_template(self, templatename, templatedir, + registry=None, username=None, password=None): + """ + :param templatename: name of the template image to download + :param templatedir: local directory path in which to store the template + :param registry: optional hostname of image registry server + :param username: optional username to authenticate against registry server + :param password: optional password to authenticate against registry server + + Download a template from the registry, storing it in the local + filesystem + """ + pass

ACK, but may need some thinking on the "Registry" word. -- Cedric

On Wed, 2015-09-09 at 12:55 +0100, Daniel P. Berrange wrote:

On Wed, Sep 09, 2015 at 01:50:11PM +0200, Cedric Bosdonnat wrote:

...

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

...

From: Eren Yagdiran <erenyagdiran@gmail.com>

Refactor download function from virt-sandbox-image to use the newly introduced Source abstract class. The docker-specific download code is moved to a new DockerSource class.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 204 ++++--------------------- libvirt-sandbox/image/sources/DockerSource.py | 209 ++++++++++++++++++++++++++ libvirt-sandbox/image/sources/Makefile.am | 1 + libvirt-sandbox/image/sources/Source.py | 15 ++ 4 files changed, 257 insertions(+), 172 deletions(-) create mode 100644 libvirt-sandbox/image/sources/DockerSource.py

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index de34321..7af617e 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -69,176 +69,6 @@ def debug(msg): def info(msg): sys.stdout.write(msg)

-def get_url(server, path, headers): - url = "https://" + server + path - debug(" Fetching %s..." % url) - req = urllib2.Request(url=url) - - if json: - req.add_header("Accept", "application/json") - - for h in headers.keys(): - req.add_header(h, headers[h]) - - return urllib2.urlopen(req) - -def get_json(server, path, headers): - try: - res = get_url(server, path, headers) - data = json.loads(res.read()) - debug("OK\n") - return (data, res) - except Exception, e: - debug("FAIL %s\n" % str(e)) - raise - -def save_data(server, path, headers, dest, checksum=None, datalen=None): - try: - res = get_url(server, path, headers) - - csum = None - if checksum is not None: - csum = hashlib.sha256() - - pattern = [".", "o", "O", "o"] - patternIndex = 0 - donelen = 0 - - with open(dest, "w") as f: - while 1: - buf = res.read(1024*64) - if not buf: - break - if csum is not None: - csum.update(buf) - f.write(buf) - - if datalen is not None: - donelen = donelen + len(buf) - debug("\x1b[s%s (%5d Kb of %5d Kb)\x1b8" % ( - pattern[patternIndex], (donelen/1024), (datalen/1024) - )) - patternIndex = (patternIndex + 1) % 4 - - debug("\x1b[K") - if csum is not None: - csumstr = "sha256:" + csum.hexdigest() - if csumstr != checksum: - debug("FAIL checksum '%s' does not match '%s'" % (csumstr, checksum)) - os.remove(dest) - raise IOError("Checksum '%s' for data does not match '%s'" % (csumstr, checksum)) - debug("OK\n") - return res - except Exception, e: - debug("FAIL %s\n" % str(e)) - raise - - -def download_template(name, server, destdir): - tag = "latest" - - offset = name.find(':') - if offset != -1: - tag = name[offset + 1:] - name = name[0:offset] - - # First we must ask the index server about the image name. THe - # index server will return an auth token we can use when talking - # to the registry server. We need this token even when anonymous - try: - (data, res) = get_json(server, "/v1/repositories/" + name + "/images", - {"X-Docker-Token": "true"}) - except urllib2.HTTPError, e: - raise ValueError(["Image '%s' does not exist" % name]) - - registryserver = res.info().getheader('X-Docker-Endpoints') - token = res.info().getheader('X-Docker-Token') - checksums = {} - for layer in data: - pass - # XXX Checksums here don't appear to match the data in - # image download later. Find out what these are sums of - #checksums[layer["id"]] = layer["checksum"] - - # Now we ask the registry server for the list of tags associated - # with the image. Tags usually reflect some kind of version of - # the image, but they aren't officially "versions". There is - # always a "latest" tag which is the most recent upload - # - # We must pass in the auth token from the index server. This - # token can only be used once, and we're given a cookie back - # in return to use for later RPC calls. - (data, res) = get_json(registryserver, "/v1/repositories/" + name + "/tags", - { "Authorization": "Token " + token }) - - cookie = res.info().getheader('Set-Cookie') - - if not tag in data: - raise ValueError(["Tag '%s' does not exist for image '%s'" % (tag, name)]) - imagetagid = data[tag] - - # Only base images are self-contained, most images reference one - # or more parents, in a linear stack. Here we are getting the list - # of layers for the image with the tag we used. - (data, res) = get_json(registryserver, "/v1/images/" + imagetagid + "/ancestry", - { "Authorization": "Token " + token }) - - if data[0] != imagetagid: - raise ValueError(["Expected first layer id '%s' to match image id '%s'", - data[0], imagetagid]) - - try: - createdFiles = [] - createdDirs = [] - - for layerid in data: - templatedir = destdir + "/" + layerid - if not os.path.exists(templatedir): - os.mkdir(templatedir) - createdDirs.append(templatedir) - - jsonfile = templatedir + "/template.json" - datafile = templatedir + "/template.tar.gz" - - if not os.path.exists(jsonfile) or not os.path.exists(datafile): - # The '/json' URL gives us some metadata about the layer - res = save_data(registryserver, "/v1/images/" + layerid + "/json", - { "Authorization": "Token " + token }, jsonfile) - createdFiles.append(jsonfile) - layersize = int(res.info().getheader("Content-Length")) - - datacsum = None - if layerid in checksums: - datacsum = checksums[layerid] - - # and the '/layer' URL is the actual payload, provided - # as a tar.gz archive - save_data(registryserver, "/v1/images/" + layerid + "/layer", - { "Authorization": "Token " + token }, datafile, datacsum, layersize) - createdFiles.append(datafile) - - # Strangely the 'json' data for a layer doesn't include - # its actual name, so we save that in a json file of our own - index = { - "name": name, - } - - indexfile = destdir + "/" + imagetagid + "/index.json" - with open(indexfile, "w") as f: - f.write(json.dumps(index)) - except Exception, e: - for f in createdFiles: - try: - os.remove(f) - except: - pass - for d in createdDirs: - try: - os.rmdir(d) - except: - pass - - def delete_template(name, destdir): imageusage = {} imageparent = {} @@ -342,8 +172,16 @@ def create_template(name, imagepath, format, destdir): parentImage = templateImage

def download(args): - info("Downloading %s from %s to %s\n" % (args.template, default_index_server, default_template_dir)) - download_template(args.template, default_index_server, default_template_dir) + try: + dynamic_source_loader(args.source).download_template(templatename=args.template, + templatedir=args.template_dir, + registry=args.registry, + username=args.username, + password=args.password) + except IOError,e: + print "Source %s cannot be found in given path" %args.source + except Exception,e: + print "Download Error %s" % str(e)

def delete(args): info("Deleting %s from %s\n" % (args.template, default_template_dir)) @@ -357,10 +195,32 @@ def requires_template(parser): parser.add_argument("template", help=_("name of the template"))

+def requires_source(parser): + parser.add_argument("-s","--source", + default="docker", + help=_("name of the template")) + +def requires_auth_conn(parser): + parser.add_argument("-r","--registry", + help=_("Url of the custom registry"))

This wording really sounds docker-specific. The registry word only fits docker terminology, would surely not apply to virt-builder or appc case. Something like "images storage" would may be more generic. The problem is that "repository" has a special meaning in the docker terminology.

Yeah, I was thinking we might need some way to let source subclasses add custom arguments. eg so we'd have --docker-registry.

The appc spec doesn't have a concept of a central registry in the same way as docker. Instead the image name encodes the domain name, eg example.com/someapp, and there's a protocol to use this to identify the server, and then resolve the download URL

...

ACK, but may need some thinking on the "Registry" word.

I'm inclined to merge this, and then fix it afterwards to be more generic

Sure... but then we surely don't want to get a release out with the temporary parameter. -- Cedric

Regards, Daniel

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Refactoring delete function from virt-sandbox-image to DockerSource. Delete function can delete templates by name.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 58 ++++----------------------- libvirt-sandbox/image/sources/DockerSource.py | 50 +++++++++++++++++++++++ libvirt-sandbox/image/sources/Source.py | 10 +++++ 3 files changed, 67 insertions(+), 51 deletions(-)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index f3c0ab7..5490c4b 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -69,55 +69,6 @@ def debug(msg): def info(msg): sys.stdout.write(msg)

-def delete_template(name, destdir): - imageusage = {} - imageparent = {} - imagenames = {} - imagedirs = os.listdir(destdir) - for imagetagid in imagedirs: - indexfile = destdir + "/" + imagetagid + "/index.json" - if os.path.exists(indexfile): - with open(indexfile, "r") as f: - index = json.load(f) - imagenames[index["name"]] = imagetagid - jsonfile = destdir + "/" + imagetagid + "/template.json" - if os.path.exists(jsonfile): - with open(jsonfile, "r") as f: - template = json.load(f) - - parent = template.get("parent", None) - if parent: - if parent not in imageusage: - imageusage[parent] = [] - imageusage[parent].append(imagetagid) - imageparent[imagetagid] = parent - - if not name in imagenames: - raise ValueError(["Image %s does not exist locally" % name]) - - imagetagid = imagenames[name] - while imagetagid != None: - debug("Remove %s\n" % imagetagid) - parent = imageparent.get(imagetagid, None) - - indexfile = destdir + "/" + imagetagid + "/index.json" - if os.path.exists(indexfile): - os.remove(indexfile) - jsonfile = destdir + "/" + imagetagid + "/template.json" - if os.path.exists(jsonfile): - os.remove(jsonfile) - datafile = destdir + "/" + imagetagid + "/template.tar.gz" - if os.path.exists(datafile): - os.remove(datafile) - imagedir = destdir + "/" + imagetagid - os.rmdir(imagedir) - - if parent: - if len(imageusage[parent]) != 1: - debug("Parent %s is shared\n" % parent) - parent = None - imagetagid = parent - def download(args): try: dynamic_source_loader(args.source).download_template(templatename=args.template, @@ -131,8 +82,11 @@ def download(args): print "Download Error %s" % str(e)

def delete(args): - info("Deleting %s from %s\n" % (args.template, default_template_dir)) - delete_template(args.template, default_template_dir) + try: + dynamic_source_loader(args.source).delete_template(templatename=args.template, + templatedir=args.template_dir) + except Exception,e: + print "Delete Error %s", str(e)

def create(args): try: @@ -183,6 +137,8 @@ def gen_delete_args(subparser): parser = subparser.add_parser("delete", help=_("Delete template data")) requires_template(parser) + requires_source(parser) + requires_template_dir(parser) parser.set_defaults(func=delete)

def gen_create_args(subparser): diff --git a/libvirt-sandbox/image/sources/DockerSource.py b/libvirt-sandbox/image/sources/DockerSource.py index c1c8a7d..ab18b52 100644 --- a/libvirt-sandbox/image/sources/DockerSource.py +++ b/libvirt-sandbox/image/sources/DockerSource.py @@ -295,5 +295,55 @@ class DockerSource(Source): cmd = cmd + params subprocess.call(cmd)

+ def delete_template(self, templatename, templatedir): + imageusage = {} + imageparent = {} + imagenames = {} + imagedirs = os.listdir(templatedir) + for imagetagid in imagedirs: + indexfile = templatedir + "/" + imagetagid + "/index.json" + if os.path.exists(indexfile): + with open(indexfile,"r") as f: + index = json.load(f) + imagenames[index["name"]] = imagetagid + jsonfile = templatedir + "/" + imagetagid + "/template.json" + if os.path.exists(jsonfile): + with open(jsonfile,"r") as f: + template = json.load(f) + + parent = template.get("parent",None) + if parent: + if parent not in imageusage: + imageusage[parent] = [] + imageusage[parent].append(imagetagid) + imageparent[imagetagid] = parent + + + if not templatename in imagenames: + raise ValueError(["Image %s does not exist locally" %templatename]) + + imagetagid = imagenames[templatename] + while imagetagid != None: + debug("Remove %s\n" % imagetagid) + parent = imageparent.get(imagetagid,None) + + indexfile = templatedir + "/" + imagetagid + "/index.json" + if os.path.exists(indexfile): + os.remove(indexfile) + jsonfile = templatedir + "/" + imagetagid + "/template.json" + if os.path.exists(jsonfile): + os.remove(jsonfile) + datafile = templatedir + "/" + imagetagid + "/template.tar.gz" + if os.path.exists(datafile): + os.remove(datafile) + imagedir = templatedir + "/" + imagetagid + shutil.rmtree(imagedir) + + if parent: + if len(imageusage[parent]) != 1: + debug("Parent %s is shared\n" % parent) + parent = None + imagetagid = parent + def debug(msg): sys.stderr.write(msg) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py index 436eef6..4aea5c9 100644 --- a/libvirt-sandbox/image/sources/Source.py +++ b/libvirt-sandbox/image/sources/Source.py @@ -61,3 +61,13 @@ class Source(): inside a sandbox using the requested libvirt connection URI. """ pass + + @abstractmethod + def delete_template(self, templatename, templatedir): + """ + :param templatename: name of the template image to delete + :param templatedir: local directory path from which to delete template + + Delete all local files associated with the template + """ + pass

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Provide a way to know how a template can be started depending on the used source DockerSource will need to parse the topmost config file in order to find the igniter command

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/sources/DockerSource.py | 31 +++++++++++++++++++++++++++ libvirt-sandbox/image/sources/Source.py | 12 +++++++++++ 2 files changed, 43 insertions(+)

diff --git a/libvirt-sandbox/image/sources/DockerSource.py b/libvirt-sandbox/image/sources/DockerSource.py index ab18b52..2607011 100644 --- a/libvirt-sandbox/image/sources/DockerSource.py +++ b/libvirt-sandbox/image/sources/DockerSource.py @@ -29,6 +29,16 @@ import os import subprocess import shutil

+class DockerConfParser(): + + def __init__(self,jsonfile): + with open(jsonfile) as json_file: + self.json_data = json.load(json_file) + def getCommand(self): + return self.json_data['config']['Cmd'] + def getEntrypoint(self): + return self.json_data['config']['Entrypoint'] + class DockerSource(Source):

www_auth_username = None @@ -345,5 +355,26 @@ class DockerSource(Source): parent = None imagetagid = parent

+ def _get_template_data(self, templatename, templatedir): + imageList = self._get_image_list(templatename, templatedir) + toplayer = imageList[0] + diskfile = templatedir + "/" + toplayer + "/template.qcow2" + configfile = templatedir + "/" + toplayer + "/template.json" + return configfile, diskfile + + def get_command(self, templatename, templatedir, userargs): + configfile, diskfile = self._get_template_data(templatename, templatedir) + configParser = DockerConfParser(configfile) + cmd = configParser.getCommand() + entrypoint = configParser.getEntrypoint() + if entrypoint is None: + entrypoint = [] + if cmd is None: + cmd = [] + if userargs is not None and len(userargs) > 0: + return entrypoint + userargs + else: + return entrypoint + cmd + def debug(msg): sys.stderr.write(msg) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py index 4aea5c9..4305d0b 100644 --- a/libvirt-sandbox/image/sources/Source.py +++ b/libvirt-sandbox/image/sources/Source.py @@ -71,3 +71,15 @@ class Source(): Delete all local files associated with the template """ pass + + @abstractmethod + def get_command(self, templatename, templatedir, userargs): + """ + :param templatename: name of the template image to query + :param templatedir: local directory path in which templates are stored + :param userargs: user specified arguments to run + + Get the command line to invoke in the container. If userargs + is specified, then this should override the default args in + the image""" + pass

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Commandline parameters for running a template

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index 5490c4b..6f9a5e7 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -101,6 +101,10 @@ def requires_template(parser): parser.add_argument("template", help=_("name of the template"))

+def requires_name(parser): + parser.add_argument("-n","--name", + help=_("Name of the running sandbox")) + def requires_source(parser): parser.add_argument("-s","--source", default="docker", @@ -124,6 +128,12 @@ def requires_template_dir(parser): default=default_template_dir, help=_("Template directory for saving templates"))

+def requires_image_dir(parser): + global default_image_dir + parser.add_argument("-I","--image-dir", + default=default_image_dir, + help=_("Image directory for saving images")) + def gen_download_args(subparser): parser = subparser.add_parser("download", help=_("Download template data")) @@ -153,6 +163,20 @@ def gen_create_args(subparser): help=_("format format for image")) parser.set_defaults(func=create)

+def gen_run_args(subparser): + parser = subparser.add_parser("run", + help=_("Run a already built image"))

I'm not a native english speaker, but it sounds like it should be: "Run an already built image"

+ requires_name(parser) + requires_template(parser) + requires_source(parser) + requires_connect(parser) + requires_template_dir(parser) + requires_image_dir(parser) + parser.add_argument("args", + nargs=argparse.REMAINDER, + help=_("command arguments to run")) + parser.set_defaults(func=run) + def main(): parser = argparse.ArgumentParser(description='Sandbox Container Image Tool')

@@ -160,6 +184,7 @@ def main(): gen_download_args(subparser) gen_delete_args(subparser) gen_create_args(subparser) + gen_run_args(subparser)

try: args = parser.parse_args()

ACK with the typo fixed. -- Cedric

On Wed, Sep 09, 2015 at 02:12:28PM +0200, Cedric Bosdonnat wrote:

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

...

From: Eren Yagdiran <erenyagdiran@gmail.com>

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- bin/Makefile.am | 5 ++ bin/virt-sandbox-image.pod | 169 +++++++++++++++++++++++++++++++++++++++++++++ libvirt-sandbox.spec.in | 1 + 3 files changed, 175 insertions(+) create mode 100644 bin/virt-sandbox-image.pod

diff --git a/bin/Makefile.am b/bin/Makefile.am index deedcf6..398e90c 100644 --- a/bin/Makefile.am +++ b/bin/Makefile.am @@ -20,6 +20,7 @@ POD_FILES = \ virt-sandbox-service-delete.pod \ virt-sandbox-service-reload.pod \ virt-sandbox-service-upgrade.pod \ + virt-sandbox-image.pod \ $(NULL) EXTRA_DIST = $(bin_SCRIPTS) $(POD_FILES) virt-sandbox-service-bash-completion.sh virt-sandbox-service.logrotate EXTRA_DIST += virt-sandbox-service-bash-completion.sh @@ -34,6 +35,7 @@ man1_MANS = \ virt-sandbox-service-delete.1 \ virt-sandbox-service-reload.1 \ virt-sandbox-service-upgrade.1 \ + virt-sandbox-image.1 \ $(NULL)

POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" @@ -65,6 +67,9 @@ virt-sandbox-service-reload.1: virt-sandbox-service-reload.pod Makefile virt-sandbox-service-upgrade.1: virt-sandbox-service-upgrade.pod Makefile $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@

+virt-sandbox-image.1: virt-sandbox-image.pod Makefile + $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + CLEANFILES = $(man1_MANS)

virt_sandbox_SOURCES = virt-sandbox.c diff --git a/bin/virt-sandbox-image.pod b/bin/virt-sandbox-image.pod new file mode 100644 index 0000000..85954b0 --- /dev/null +++ b/bin/virt-sandbox-image.pod @@ -0,0 +1,169 @@ +=head1 NAME + +virt-sandbox-image - Sandbox Container Image Tool + +=head1 SYNOPSIS + + {download,create,run,delete} + + commands: + + download Download template data + + create Create image from template data + + run Run an already built image + + delete Delete template data + +=head1 DESCRIPTION + +virt-sandbox-image.py is a sandbox container image tool developed in python. +This tool can download,create,run and delete templates which are provided by +different sources. This tool comes with Docker source by default. Other sources +can be implemented by extending source class

The mention on the default source and possibility to add more may not fit a man page... or we'll need to reword / remove it someday.

...

+=head1 OPTIONS + +=over 4 + +=item B<download -s source -r registry -u username -p password -t template_directory template> +

Again here, do we really want to use the word "registry" sounding too dockerish?

...

+Download a template by given name with a specified source. + +=over 6 + +=item B<template> + +Template name to download + +=item B<-s or --source> + +Source parameter will try load source module under sources/ directory. Each source has to implement Source.py base class and register itself with a proper name +Default source is Docker. +

Do we really want to include development hints in the man?

...

+=item B<-r or --registry> + +Custom registry url for downloading data. This might need privileged credentials which can be specified by --username and --password parameters. + +=item B<-u or --username> + +Username for custom registry authentication + +=item B<-p or --password> + +Password for custom registry authentication + +=item B<-t or --template-dir> + +Custom directory for downloading template data + +=back + +=item B<create -s source -c uri -f format template> + +Create already downloaded template into image with given format. + +=over 5 + +=item B<template> + +Template name to download. + +=item B<format> + +Image format e.g qcow2 + +=item B<-s or --source> + +Source parameter will try load source module under sources/ directory. Each source has to implement Source.py base class and register itself with a proper name +Default source is Docker. + +=item B<-c or --connect> + +Driver parameter can be specified with only supported driver by libvirt-sandbox. These are lxc:///, qemu:///session, qemu:///system. + +=back + +=item B<run -n name -N network -v volume -s source -c uri template command...> + +Run already built image. If B<command> is not specified, the default defined +command for the image will be run. + +=over 6 + +=item B<template> + +Template name to download. + +=item B<imagepath> + +Image path where template image will be stored. + +=item B<-n or --name> + +The sandbox guest name + +=item B<-N or --network> + +Network params will be passed directly to the virt-sandbox. More information about network params, See C<virt-sandbox(8)> + +=item B<-v or --volume> + +Volume params are for binding host-paths to the guest. E.g -v /home:/home will map /home directory from host to the guest. + +=item B<-c or --connect> + +Driver parameter can be specified with only supported driver by libvirt-sandbox. These are lxc:///, qemu:///session, qemu:///system. + +=back + +=item B<delete name imagepath -s source > + +Delete downloaded template data and its built image. + +=over 3 + +=item B<name> + +Template name to delete. + +=item B<imagepath> + +Image path where template data or image stays. + +=item B<-s or --source> + +Source parameter will try load source module under sources/ directory. Each source has to implement Source.py base class and register itself with a proper name +Default source is Docker. + +=back + +=back + +=head1 SEE ALSO + +C<virt-sandbox(8)> + +=head1 FILES + +Container content will be stored in subdirectories of +/var/lib/libvirt/templates, by default. + +=head1 AUTHORS + +Daniel P. Berrange <dan@berrange.com> + +Eren Yagdiran <erenyagdiran@gmail.com> + +=head1 COPYRIGHT + +Copyright (C) 2013 Red Hat, Inc. +Copyright (C) 2015 Universitat Politecnica de Catalunya. + +=head1 LICENSE + +virt-sandbox-image is distributed under the terms of the GNU LGPL v2+. +This is free software; see the source for copying conditions. +There is NO warranty; not even for MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE diff --git a/libvirt-sandbox.spec.in b/libvirt-sandbox.spec.in index 54fde55..b488cec 100644 --- a/libvirt-sandbox.spec.in +++ b/libvirt-sandbox.spec.in @@ -102,6 +102,7 @@ rm -rf $RPM_BUILD_ROOT %{_libexecdir}/virt-sandbox-service-util %{python_sitelib}/libvirt_sandbox %{_mandir}/man1/virt-sandbox.1* +%{_mandir}/man1/virt-sandbox-image.1* %{_mandir}/man1/virt-sandbox-service.1* %{_mandir}/man1/virt-sandbox-service-*.1*

ACK, but would be good to think about the raised questions before pushing.

Yeah, I think we could temporarily postpone this, as the man page could do with a little more work Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Add the config gobject to store custom environment variables. This will allow creating custom environment variables on a sandbox with a parameter formatted like --env key1=val1

Add testcase for custom environment variables

"make check" now includes testcase for environment variables

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/libvirt-sandbox-config.c | 171 ++++++++++++++++++++++++++++++- libvirt-sandbox/libvirt-sandbox-config.h | 13 +++ libvirt-sandbox/libvirt-sandbox.sym | 9 ++ libvirt-sandbox/tests/test-config.c | 10 ++ 4 files changed, 202 insertions(+), 1 deletion(-)

diff --git a/libvirt-sandbox/libvirt-sandbox-config.c b/libvirt-sandbox/libvirt-sandbox-config.c index 2506072..780d174 100644 --- a/libvirt-sandbox/libvirt-sandbox-config.c +++ b/libvirt-sandbox/libvirt-sandbox-config.c @@ -64,6 +64,7 @@ struct _GVirSandboxConfigPrivate GList *networks; GList *mounts; GList *disks; + GHashTable* envs;

gchar *secLabel; gboolean secDynamic; @@ -276,6 +277,8 @@ static void gvir_sandbox_config_finalize(GObject *object) g_list_foreach(priv->networks, (GFunc)g_object_unref, NULL); g_list_free(priv->networks);

+ g_hash_table_destroy(priv->envs); + g_list_foreach(priv->disks, (GFunc)g_object_unref, NULL); g_list_free(priv->disks);

@@ -483,6 +486,7 @@ static void gvir_sandbox_config_init(GVirSandboxConfig *config) priv->arch = g_strdup(uts.machine); priv->secDynamic = TRUE;

+ priv->envs = g_hash_table_new(g_str_hash, g_str_equal); priv->uid = geteuid(); priv->gid = getegid(); priv->username = g_strdup(g_get_user_name()); @@ -1144,6 +1148,102 @@ gboolean gvir_sandbox_config_has_networks(GVirSandboxConfig *config) return priv->networks ? TRUE : FALSE; }

+/** + * gvir_sandbox_config_add_env: + * @config: (transfer none): the sandbox config + * @key: (transfer none): the key for environment variable + * @value: (transfer none): the value for environment variable + * + * Adds a new environment variable to the sandbox + * + */ +void gvir_sandbox_config_add_env(GVirSandboxConfig *config, + gchar *k, + gchar *v) +{ + gchar * key = g_strdup(k); + gchar * value = g_strdup(v); + GVirSandboxConfigPrivate *priv = config->priv; + g_hash_table_insert(priv->envs,key,value); +} + +/** + * gvir_sandbox_config_get_envs: + * @config: (transfer none): the sandbox config + * + * Retrieves the hashtable of custom environment variables in the sandbox + * + * Returns: (transfer full) (element-type gchar gchar): the hashtable of environment variables + */ +GHashTable *gvir_sandbox_config_get_envs(GVirSandboxConfig *config) +{ + GVirSandboxConfigPrivate *priv = config->priv; + return priv->envs; +} + +/** + * gvir_sandbox_config_add_env_strv: + * @config: (transfer none): the sandbox config + * @envs: (transfer none)(array zero-terminated=1): the list of environment variables + * + * Parses @envs whose elements are in the format KEY=VALUE + * + * --env KEY=VALUE + */ +gboolean gvir_sandbox_config_add_env_strv(GVirSandboxConfig *config, + gchar **envs, + GError **error) +{ + gsize i = 0; + while (envs && envs[i]) { + if (!gvir_sandbox_config_add_env_opts(config, + envs[i], + error)) + return FALSE; + i++; + } + return TRUE; +} + +/** + * gvir_sandbox_config_add_env_opts: + * @config: (transfer none): the sandbox config + * @env: (transfer none): the env config + * + * Parses @env in the format KEY=VALUE + * creating #GVirSandboxConfigEnv instances for each element. For + * example + * + * --env KEY=VALUE + */ + +gboolean gvir_sandbox_config_add_env_opts(GVirSandboxConfig *config, + const char *opt, + GError **error) +{ + gchar *tmp = NULL; + gchar *key = NULL; + gchar *value = NULL; + + if (!(tmp = g_strdup(opt))) + return FALSE; + + key = strchr(tmp, '='); + + if (!key) { + g_set_error(error, GVIR_SANDBOX_CONFIG_ERROR, 0, + _("Wrong environment format on %s"), opt); + return FALSE; + } + + *key = '\0'; + value = key + 1; + + gvir_sandbox_config_add_env(config, tmp, value); + + g_free(tmp); + return TRUE; +}

/** * gvir_sandbox_config_add_disk: @@ -1163,7 +1263,6 @@ void gvir_sandbox_config_add_disk(GVirSandboxConfig *config, priv->disks = g_list_append(priv->disks, dsk); }

- /** * gvir_sandbox_config_get_disks: * @config: (transfer none): the sandbox config @@ -1172,6 +1271,7 @@ void gvir_sandbox_config_add_disk(GVirSandboxConfig *config, * * Returns: (transfer full) (element-type GVirSandboxConfigMount): the list of disks */ + GList *gvir_sandbox_config_get_disks(GVirSandboxConfig *config) { GVirSandboxConfigPrivate *priv = config->priv; @@ -1949,6 +2049,39 @@ static GVirSandboxConfigMount *gvir_sandbox_config_load_config_mount(GKeyFile *f goto cleanup; }

+static gboolean gvir_sandbox_config_load_config_env(GKeyFile *file, + guint i, + GError **error, + gchar **key, + gchar **value) +{ + gboolean ret = TRUE; + gchar *index = NULL; + GError *e = NULL; + index = g_strdup_printf("env.%u", i); + if ((*key = g_key_file_get_string(file, index, "key", &e)) == NULL) { + if (e->code == G_KEY_FILE_ERROR_GROUP_NOT_FOUND) { + g_error_free(e); + ret = FALSE; + goto cleanup; + } + g_error_free(e); + g_set_error(error, GVIR_SANDBOX_CONFIG_ERROR, 0, + "%s", _("Missing environment key in config file")); + ret = FALSE; + goto cleanup; + } + if ((*value = g_key_file_get_string(file, index, "value", NULL)) == NULL) { + g_set_error(error, GVIR_SANDBOX_CONFIG_ERROR, 0, + "%s", _("Missing environment value in config file")); + ret = FALSE; + goto cleanup; + } + + cleanup: + g_free(index); + return ret; +}

static GVirSandboxConfigDisk *gvir_sandbox_config_load_config_disk(GKeyFile *file, guint i, @@ -2244,6 +2377,19 @@ static gboolean gvir_sandbox_config_load_config(GVirSandboxConfig *config, priv->mounts = g_list_append(priv->mounts, mount); }

+ for (i = 0 ; i < 1024; i++) { + gchar *key = NULL; + gchar *value = NULL; + if (!(gvir_sandbox_config_load_config_env(file, i, error,&key,&value)) && *error){ + g_free(key); + g_free(value); + ret = FALSE; + goto cleanup; + } + if (key){ + g_hash_table_insert(priv->envs,key,value); + } + }

for (i = 0 ; i < 1024 ; i++) { GVirSandboxConfigDisk *disk; @@ -2274,6 +2420,19 @@ static gboolean gvir_sandbox_config_load_config(GVirSandboxConfig *config, return ret; }

+static void gvir_sandbox_config_save_config_env(gchar *key, + gchar *value, + GKeyFile *file, + guint i) +{ + gchar *index = NULL; + index = g_strdup_printf("env.%u", i); + g_key_file_set_string(file, index, "key",key); + g_key_file_set_string(file, index, "value",value); + g_free(index); + g_free(key); + g_free(value); +}

static void gvir_sandbox_config_save_config_disk(GVirSandboxConfigDisk *config, GKeyFile *file, @@ -2484,6 +2643,16 @@ static void gvir_sandbox_config_save_config(GVirSandboxConfig *config, i++; }

+ + GHashTableIter iter; + gpointer key, value; + i = 0; + g_hash_table_iter_init (&iter, priv->envs); + while (g_hash_table_iter_next (&iter, &key, &value)){ + gvir_sandbox_config_save_config_env(key,value,file,i); + i++; + } + i = 0; tmp = priv->disks; while (tmp) { diff --git a/libvirt-sandbox/libvirt-sandbox-config.h b/libvirt-sandbox/libvirt-sandbox-config.h index 2c5f0a6..e5e53f7 100644 --- a/libvirt-sandbox/libvirt-sandbox-config.h +++ b/libvirt-sandbox/libvirt-sandbox-config.h @@ -122,6 +122,19 @@ gboolean gvir_sandbox_config_add_network_strv(GVirSandboxConfig *config, GError **error); gboolean gvir_sandbox_config_has_networks(GVirSandboxConfig *config);

+void gvir_sandbox_config_add_env(GVirSandboxConfig *config, + gchar *key, + gchar *value); +GHashTable *gvir_sandbox_config_get_envs(GVirSandboxConfig *config); +gboolean gvir_sandbox_config_add_env_strv(GVirSandboxConfig *config, + gchar **envs, + GError **error); +gboolean gvir_sandbox_config_add_env_opts(GVirSandboxConfig *config, + const char *env, + GError **error); +gboolean gvir_sandbox_config_has_envs(GVirSandboxConfig *config); + + void gvir_sandbox_config_add_disk(GVirSandboxConfig *config, GVirSandboxConfigDisk *dsk); GList *gvir_sandbox_config_get_disks(GVirSandboxConfig *config); diff --git a/libvirt-sandbox/libvirt-sandbox.sym b/libvirt-sandbox/libvirt-sandbox.sym index 6f8097a..b7c5921 100644 --- a/libvirt-sandbox/libvirt-sandbox.sym +++ b/libvirt-sandbox/libvirt-sandbox.sym @@ -217,3 +217,12 @@ LIBVIRT_SANDBOX_0.6.0 { local: *; }; + +LIBVIRT_SANDBOX_0.6.1 { + global: + gvir_sandbox_config_add_env; + gvir_sandbox_config_add_env_strv; + gvir_sandbox_config_add_env_opts; + gvir_sandbox_config_env_get_type; + gvir_sandbox_config_has_envs; +} LIBVIRT_SANDBOX_0.6.0; diff --git a/libvirt-sandbox/tests/test-config.c b/libvirt-sandbox/tests/test-config.c index da05187..ac10bab 100644 --- a/libvirt-sandbox/tests/test-config.c +++ b/libvirt-sandbox/tests/test-config.c @@ -58,6 +58,13 @@ int main(int argc, char **argv) "host-bind:/tmp=", NULL }; + + const gchar *envs[] = { + "key1=val1", + "key2=val2", + NULL + }; + const gchar *disks[] = { "file:dbdata=/tmp/img.blah,format=qcow2", "file:cache=/tmp/img.qcow2", @@ -103,6 +110,9 @@ int main(int argc, char **argv) if (!gvir_sandbox_config_add_mount_strv(cfg1, (gchar**)mounts, &err)) goto cleanup;

+ if (!gvir_sandbox_config_add_env_strv(cfg1, (gchar**)envs, &err)) + goto cleanup; + if (!gvir_sandbox_config_add_disk_strv(cfg1, (gchar**)disks, &err)) goto cleanup;

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Allow users to add custom environment variables to their sandbox.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- bin/virt-sandbox.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+)

diff --git a/bin/virt-sandbox.c b/bin/virt-sandbox.c index 332e53e..4c400d5 100644 --- a/bin/virt-sandbox.c +++ b/bin/virt-sandbox.c @@ -80,6 +80,7 @@ int main(int argc, char **argv) { GError *error = NULL; gchar *name = NULL; gchar **disks = NULL; + gchar **envs = NULL; gchar **mounts = NULL; gchar **includes = NULL; gchar *includefile = NULL; @@ -111,6 +112,8 @@ int main(int argc, char **argv) { N_("root directory of the sandbox"), "DIR" }, { "disk", ' ', 0, G_OPTION_ARG_STRING_ARRAY, &disks, N_("add a disk in the guest"), "TYPE:TAGNAME=SOURCE,format=FORMAT" }, + { "env", 'e', 0, G_OPTION_ARG_STRING_ARRAY, &envs, + N_("add a environment variable for the sandbox"), "KEY=VALUE" }, { "mount", 'm', 0, G_OPTION_ARG_STRING_ARRAY, &mounts, N_("mount a filesystem in the guest"), "TYPE:TARGET=SOURCE" }, { "include", 'i', 0, G_OPTION_ARG_STRING_ARRAY, &includes, @@ -201,6 +204,13 @@ int main(int argc, char **argv) { gvir_sandbox_config_set_username(cfg, "root"); }

+ if (envs && + !gvir_sandbox_config_add_env_strv(cfg, envs, &error)) { + g_printerr(_("Unable to parse custom environment variables: %s\n"), + error && error->message ? error->message : _("Unknown failure")); + goto cleanup; + } + if (disks && !gvir_sandbox_config_add_disk_strv(cfg, disks, &error)) { g_printerr(_("Unable to parse disks: %s\n"), @@ -350,6 +360,10 @@ inheriting the host's root filesystem. NB. C<DIR> must contain a matching install of the libvirt-sandbox package. This restriction may be lifted in a future version.

+=item B<--env key=value> + +Sets up a custom environment variable on a running sandbox. + =item B<--disk TYPE:TAGNAME=SOURCE,format=FORMAT>

Sets up a disk inside the sandbox by using B<SOURCE> with a symlink named as B<TAGNAME>

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Common-init reads config file and exports custom environment variables from config file and applies them to the running sandbox.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/libvirt-sandbox-init-common.c | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)

diff --git a/libvirt-sandbox/libvirt-sandbox-init-common.c b/libvirt-sandbox/libvirt-sandbox-init-common.c index e3e14a3..42beadc 100644 --- a/libvirt-sandbox/libvirt-sandbox-init-common.c +++ b/libvirt-sandbox/libvirt-sandbox-init-common.c @@ -348,6 +348,21 @@ static gboolean setup_network(GVirSandboxConfig *config, GError **error) }

+static gboolean setup_custom_env(GVirSandboxConfig *config, GError **error) +{ + gboolean ret = FALSE; + GHashTableIter iter; + gpointer key, value; + g_hash_table_iter_init (&iter, gvir_sandbox_config_get_envs(config)); + while (g_hash_table_iter_next (&iter, &key, &value)){ + if(setenv(key,value,1)!=0) + goto cleanup; + } + ret = TRUE; + cleanup: + return ret; +} + static int change_user(const gchar *user, uid_t uid, gid_t gid, @@ -1436,6 +1451,9 @@ int main(int argc, char **argv) { if (!setup_disk_tags()) exit(EXIT_FAILURE);

+ if (!setup_custom_env(config, &error)) + goto error; + if (!setup_network(config, &error)) goto error;

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Any custom key=value pair can be used as a custom environment variable in virt-sandbox-image. e.g virt-sandbox-image run ubuntu /var/lib/libvirt/templates -c lxc:/// -i /bin/bash -e key1=val1

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 16 ++++++++++++++++ libvirt-sandbox/image/sources/DockerSource.py | 11 +++++++++++ libvirt-sandbox/image/sources/Source.py | 10 ++++++++++ 3 files changed, 37 insertions(+)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index 30e2558..c17b577 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -129,6 +129,19 @@ def run(args): params.append('-N') params.append(networkArgs)

+ allEnvs = source.get_env(args.template, args.template_dir) + envArgs = args.env + if envArgs is not None: + allEnvs = allEnvs + envArgs + for env in allEnvs: + envsplit = env.split("=") + envlen = len(envsplit) + if envlen == 2: + params.append("--env") + params.append(env) + else: + pass + cmd = cmd + params + ['--'] + commandToRun subprocess.call(cmd) os.unlink(diskfile) @@ -222,6 +235,9 @@ def gen_run_args(subparser): help=_("command arguments to run")) parser.add_argument("-N","--network", help=_("Network params for running template")) + parser.add_argument("-e","--env",action="append", + help=_("Environment params for running template")) + parser.set_defaults(func=run)

def main(): diff --git a/libvirt-sandbox/image/sources/DockerSource.py b/libvirt-sandbox/image/sources/DockerSource.py index 31c1d80..4455198 100644 --- a/libvirt-sandbox/image/sources/DockerSource.py +++ b/libvirt-sandbox/image/sources/DockerSource.py @@ -38,6 +38,12 @@ class DockerConfParser(): return self.json_data['config']['Cmd'] def getEntrypoint(self): return self.json_data['config']['Entrypoint'] + def getEnvs(self): + lst = self.json_data['config']['Env'] + if lst is not None and isinstance(lst,list): + return lst + else: + return []

class DockerSource(Source):

@@ -388,5 +394,10 @@ class DockerSource(Source): else: return entrypoint + cmd

+ def get_env(self, templatename, templatedir): + configfile, diskfile = self._get_template_data(templatename, templatedir) + configParser = DockerConfParser(configfile) + return configParser.getEnvs() + def debug(msg): sys.stderr.write(msg) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py index a5d3844..8a21f90 100644 --- a/libvirt-sandbox/image/sources/Source.py +++ b/libvirt-sandbox/image/sources/Source.py @@ -95,3 +95,13 @@ class Source(): of a template. """ pass + + @abstractmethod + def get_env(self,templatename, templatedir): + """ + :param templatename: name of the template image to download + :param templatedir: local directory path in which to find template + + Get the dict of environment variables to set + """ + pass

ACK -- Cedric

On Tue, 2015-09-08 at 17:29 +0100, Daniel P. Berrange wrote:

From: Eren Yagdiran <erenyagdiran@gmail.com>

Volumes let user to map host-paths into sandbox. Docker containers need volumes for data persistence.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- libvirt-sandbox/image/cli.py | 24 +++++++++++++++++++++++- libvirt-sandbox/image/sources/DockerSource.py | 13 +++++++++++++ libvirt-sandbox/image/sources/Source.py | 10 ++++++++++ 3 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/libvirt-sandbox/image/cli.py b/libvirt-sandbox/image/cli.py index c17b577..3f1ab0d 100755 --- a/libvirt-sandbox/image/cli.py +++ b/libvirt-sandbox/image/cli.py @@ -101,6 +101,7 @@ def create(args):

def run(args): try: + global image_dir if args.connect is not None: check_connect(args.connect) source = dynamic_source_loader(args.source) @@ -142,6 +143,26 @@ def run(args): else: pass

+ allVolumes = source.get_volumes(args.template, args.template_dir) + volumeArgs = args.volume + if volumeArgs is not None: + allVolumes = allVolumes + volumeArgs + for volume in allVolumes: + volumeSplit = volume.split(":") + volumelen = len(volumeSplit) + if volumelen == 2: + hostPath = volumeSplit[0] + guestPath = volumeSplit[1] + elif volumelen == 1: + guestPath = volumeSplit[0] + hostPath = image_dir + guestPath + if not os.path.exists(hostPath): + os.makedirs(hostPath) + else: + pass + params.append("--mount") + params.append("host-bind:%s=%s" %(guestPath,hostPath)) + cmd = cmd + params + ['--'] + commandToRun subprocess.call(cmd) os.unlink(diskfile)

On top of the questions mentioned in the other thread regarding volumes, we also need to decide what to do for the data volumes cleanup. We may want to keep them, but we surely also want to have a way to prune them. -- Cedric

@@ -237,7 +258,8 @@ def gen_run_args(subparser): help=_("Network params for running template")) parser.add_argument("-e","--env",action="append", help=_("Environment params for running template")) - + parser.add_argument("--volume",action="append", + help=_("Volume params for running template")) parser.set_defaults(func=run)

def main(): diff --git a/libvirt-sandbox/image/sources/DockerSource.py b/libvirt-sandbox/image/sources/DockerSource.py index 4455198..2c358fe 100644 --- a/libvirt-sandbox/image/sources/DockerSource.py +++ b/libvirt-sandbox/image/sources/DockerSource.py @@ -28,6 +28,7 @@ import traceback import os import subprocess import shutil +import collections

class DockerConfParser():

@@ -44,6 +45,13 @@ class DockerConfParser(): return lst else: return [] + def getVolumes(self): + volumes = self.json_data['config']['Volumes'] + volumelist = [] + if isinstance(volumes,collections.Iterable): + for key,value in volumes.iteritems(): + volumelist.append(key) + return volumelist

class DockerSource(Source):

@@ -399,5 +407,10 @@ class DockerSource(Source): configParser = DockerConfParser(configfile) return configParser.getEnvs()

+ def get_volumes(self, templatename, templatedir): + configfile, diskfile = self._get_template_data(templatename, templatedir) + configParser = DockerConfParser(configfile) + return configParser.getVolumes() + def debug(msg): sys.stderr.write(msg) diff --git a/libvirt-sandbox/image/sources/Source.py b/libvirt-sandbox/image/sources/Source.py index 8a21f90..f1dd3e7 100644 --- a/libvirt-sandbox/image/sources/Source.py +++ b/libvirt-sandbox/image/sources/Source.py @@ -105,3 +105,13 @@ class Source(): Get the dict of environment variables to set """ pass + + @abstractmethod + def get_volumes(self,templatename, templatedir): + """ + :param templatename: name of the template image to download + :param templatedir: local directory path in which to find template + + Get the list of volumes associated with the template + """ + pass