Deploying Baserock images currently is a manual task. We need to make that more convenient. Deployment in this case means taking the system build results (a root file system image/tarball and a kernel image so far) and putting it somewhere - e.g. onto a bootable SD card, bootable uboot/TFTP/NFS, or simply another machine. The morph deployment plugin aims at providing various deployment methods. This commit introduces it together with a first method: morph rsync DESTINATION [limit N] REPO REF SYSTEM This method works for all types of systems and copies both the root file system and the kernel image to DESTINATION (typically something like somehost:/some/path). At the moment only hard-coded, BSP-unspecific deployment methods are supported. In the future, the plugin can be extended for this purpose, however. --- morphlib/plugins/deployment_plugin.py | 138 ++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 morphlib/plugins/deployment_plugin.py diff --git a/morphlib/plugins/deployment_plugin.py b/morphlib/plugins/deployment_plugin.py new file mode 100644 index 0000000..9418d0c --- /dev/null +++ b/morphlib/plugins/deployment_plugin.py @@ -0,0 +1,138 @@ +# Copyright (C) 2012 Codethink Limited +# +# 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 +# the Free Software Foundation; version 2 of the License. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + +import cliapp +import os +import subprocess + +import morphlib + + +class UsageError(cliapp.AppException): + + def __init__(self, usage): + cliapp.AppException.__init__( + self, 'Usage: morph deploy %s REPO REF SYSTEM' % usage) + + +class DeploymentPlugin(cliapp.Plugin): + + def enable(self): + self.app.add_subcommand( + 'deploy', self.deploy, + arg_synopsis='METHOD [ARG ...] REPO REF SYSTEM') + + def disable(self): + pass + + def deploy(self, args): + '''Deploys a system using one of the supported deployment methods. + + Morph distinguishes between generic and BSP-specific deployment + methods. The generic methods currently include "rsync" nad "netcat". + BSP-specific methods need to be defined in the BSP stratum of the + system you are building. + + NOTE: At the moment, only generic methods are supported. + + ''' + + if len(args) < 4: + raise cliapp.AppException( + 'Expecting at least a deployment METHOD and ' + 'a REPO REF SYSTEM triplet to deploy') + + # Extract deployment method from the arguments. + method = args[0] + method_args = args[1:len(args)-3] + method_implementation = 'deploy_%s' % method.replace('-', '_') + + # Abort if the method is not supported. + if not hasattr(self, method_implementation): + raise cliapp.AppException( + 'Deployment method \"%s\" is unsupported' % method) + + # Create a few helper objects. + self.lac, self.rac = morphlib.util.new_artifact_caches( + self.app.settings) + + # Extract system name from the arguments and resolve its artifacts. + repo, ref, system = args[len(args)-3:] + artifacts = self.system_artifacts(repo, ref, system) + + # Fetch artifacts from the remote artifact server if necessary. + def copy(remote, local): + shutil.copyfileobj(remote, local) + remote.close() + local.close() + for artifact in artifacts: + if not self.lac.has(artifact): + self.app.status(msg='Fetching to local cache: ' + 'artifact %(name)s', + name=artifact.name) + copy(self.rac.get(artifact), self.lac.put(artifact)) + + # Delegate the rest of the deployment to the method implementation. + func = getattr(self, method_implementation) + func(method_args, system, artifacts) + + def system_artifacts(self, repo, ref, system): + # Resolve all artifacts involved in building this system. + build_command = morphlib.buildcommand.BuildCommand(self.app) + order = build_command.compute_build_order( + repo, ref, '%s.morph' % system) + + # Extract the root file system artifact from the order. + rootfs = order.groups[-1][-1] + + # Create an artifact for the corresponding kernel image. + kernel = morphlib.artifact.Artifact( + rootfs.source, rootfs.name.replace('-rootfs', '-kernel')) + kernel.cache_id = rootfs.cache_id + kernel.cache_key = rootfs.cache_key + + return [rootfs, kernel] + + def deploy_rsync(self, args, system, artifacts): + usage = 'rsync DESTINATION [limit N]' + + if len(args) < 1: + raise UsageError(usage) + + filenames = [self.lac.artifact_filename(x) for x in artifacts] + + rsync_args = [] + for i in xrange(0, len(args)): + if args[i] == 'limit': + if i < len(args)-1: + rsync_args += ['--bwlimit=%s' % args[i+1]] + else: + raise UsageError(usage) + rsync_args += filenames + rsync_args.append(args[0]) # the destination + + self.run_cmd(['rsync', '-vP'] + rsync_args) + + def run_cmd(self, args): + process = subprocess.Popen(args, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT) + stdout = process.stdout + while True: + line = stdout.readline() + if not line: + break + self.app.output.write(line) -- 1.7.11.4

On 12/21/2012 11:28 PM, Jannis Pohlmann wrote: OK, ignore my comment from the previous patch :) What happens if ssh prompts for a password here? Doing x.name.endswith('rootfs') would be more robust. You only need to catch cliapp.AppException there, surely? Does VBoxManage block until the VM has powered off fully? If so, a comment to that effect would be good. If not ... :( Does this replace the old disk? Again, a comment explaining how VBoxManage behaves would be good. Do you think it's worth adding a warning to the 'deploy' command's help that this doesn't migrate any of your configuration? Speaking as a person who easily confused, I think it would be helpful to prevent anyone having false expectations of this (already quite cool) feature. Sam