/* * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /* * Copyright 2017 Joyent, Inc. * * `triton instance create ...` */ var assert = require('assert-plus'); var format = require('util').format; var tabula = require('tabula'); var vasync = require('vasync'); var common = require('../common'); var distractions = require('../distractions'); var errors = require('../errors'); var mat = require('../metadataandtags'); function parseVolMount(volume) { var components; var volMode; var volMountpoint; var volName; var VALID_MODES = ['ro', 'rw']; var VALID_VOLUME_NAME_REGEXP = /^[a-zA-Z0-9][a-zA-Z0-9_\.\-]+$/; assert.string(volume, 'volume'); components = volume.split(':'); if (components.length !== 2 && components.length !== 3) { return new errors.UsageError('invalid volume specified, must be in ' + 'the form ":[:]", got: "' + volume + '"'); } volName = components[0]; volMountpoint = components[1]; volMode = components[2]; // first component should be a volume name. We only check here that it // syntactically looks like a volume name, we'll leave the upstream to // determine if it's not actually a volume. if (!VALID_VOLUME_NAME_REGEXP.test(volName)) { return new errors.UsageError('invalid volume name, got: "' + volume + '"'); } // second component should be an absolute path // NOTE: if we ever move past node 0.10, we could use path.isAbsolute(path) if (volMountpoint.length === 0 || volMountpoint[0] !== '/') { return new errors.UsageError('invalid volume mountpoint, must be ' + 'absolute path, got: "' + volume + '"'); } if (volMountpoint.indexOf('\0') !== -1) { return new errors.UsageError('invalid volume mountpoint, contains ' + 'invalid characters, got: "' + volume + '"'); } if (volMountpoint.search(/[^\/]/) === -1) { return new errors.UsageError('invalid volume mountpoint, must contain' + ' at least one non-/ character, got: "' + volume + '"'); } // third component is optional mode: 'ro' or 'rw' if (components.length === 3 && VALID_MODES.indexOf(volMode) === -1) { return new errors.UsageError('invalid volume mode, got: "' + volume + '"'); } return { mode: volMode || 'rw', mountpoint: volMountpoint, name: volName }; } function do_create(subcmd, opts, args, cb) { if (opts.help) { this.do_help('help', {}, [subcmd], cb); return; } else if (args.length !== 2) { return cb(new errors.UsageError('incorrect number of args')); } var log = this.top.log; var tritonapi = this.top.tritonapi; vasync.pipeline({arg: {cli: this.top}, funcs: [ common.cliSetupTritonApi, /* BEGIN JSSTYLED */ /* * Parse --affinity options for validity to `ctx.affinities`. * Later (in `resolveLocality`) we'll translate this to locality hints * that CloudAPI speaks. * * Some examples. Inspired by * * * instance==vm1 * container==vm1 # alternative to 'instance' * inst==vm1 # alternative to 'instance' * inst=vm1 # '=' is shortcut for '==' * inst!=vm1 # '!=' * inst==~vm1 # '~' for soft/non-strict * inst!=~vm1 * * inst==vm* # globbing (not yet supported) * inst!=/vm\d/ # regex (not yet supported) * * some-tag!=db # tags (not yet supported) * * Limitations: * - no support for tags yet * - no globbing or regex yet * - we resolve name -> instance id *client-side* for now (until * CloudAPI supports that) * - Triton doesn't support mixed strict and non-strict, so we error * out on that. We *could* just drop the non-strict, but that is * slightly different. */ /* END JSSTYLED */ function parseAffinity(ctx, next) { if (!opts.affinity) { next(); return; } var affinities = []; // TODO: stricter rules on the value part // JSSTYLED var affinityRe = /((instance|inst|container)(==~|!=~|==|!=|=~|=))?(.*?)$/; for (var i = 0; i < opts.affinity.length; i++) { var raw = opts.affinity[i]; var match = affinityRe.exec(raw); if (!match) { next(new errors.UsageError(format('invalid affinity: "%s"', raw))); return; } var key = match[2]; if ([undefined, 'inst', 'container'].indexOf(key) !== -1) { key = 'instance'; } assert.equal(key, 'instance'); var op = match[3]; if ([undefined, '='].indexOf(op) !== -1) { op = '=='; } var strict = true; if (op[op.length - 1] === '~') { strict = false; op = op.slice(0, op.length - 1); } var val = match[4]; // Guard against mixed strictness (Triton can't handle those). if (affinities.length > 0) { var lastAff = affinities[affinities.length - 1]; if (strict !== lastAff.strict) { next(new errors.TritonError(format('mixed strict and ' + 'non-strict affinities are not supported: ' + '%j (%s) and %j (%s)', lastAff.raw, (lastAff.strict ? 'strict' : 'non-strict'), raw, (strict ? 'strict' : 'non-strict')))); return; } } affinities.push({ raw: raw, key: key, op: op, strict: strict, val: val }); } if (affinities.length) { log.trace({affinities: affinities}, 'affinities'); ctx.affinities = affinities; } next(); }, /* * Make sure if volumes were passed, they're in the correct form. */ function parseVolMounts(ctx, next) { var idx; var validationErrs = []; var parsedObj; var volMounts = []; if (!opts.volume) { next(); return; } for (idx = 0; idx < opts.volume.length; idx++) { parsedObj = parseVolMount(opts.volume[idx]); if (parsedObj instanceof Error) { validationErrs.push(parsedObj); } else { // if it's not an error, it's a volume volMounts.push(parsedObj); } } if (validationErrs.length > 0) { next(new errors.MultiError(validationErrs)); return; } if (volMounts.length > 0) { ctx.volMounts = volMounts; } next(); }, /* * Determine `ctx.locality` according to what CloudAPI supports * based on `ctx.affinities` parsed earlier. */ function resolveLocality(ctx, next) { if (!ctx.affinities) { next(); return; } var strict; var near = []; var far = []; vasync.forEachPipeline({ inputs: ctx.affinities, func: function resolveAffinity(aff, nextAff) { assert.ok(['==', '!='].indexOf(aff.op) !== -1, 'unexpected op: ' + aff.op); var nearFar = (aff.op == '==' ? near : far); strict = aff.strict; if (common.isUUID(aff.val)) { nearFar.push(aff.val); nextAff(); } else { tritonapi.getInstance({ id: aff.val, fields: ['id'] }, function (err, inst) { if (err) { nextAff(err); } else { log.trace({val: aff.val, inst: inst.id}, 'resolveAffinity'); nearFar.push(inst.id); nextAff(); } }); } } }, function (err) { if (err) { next(err); return; } ctx.locality = { strict: strict }; if (near.length > 0) ctx.locality.near = near; if (far.length > 0) ctx.locality.far = far; log.trace({locality: ctx.locality}, 'resolveLocality'); next(); }); }, function loadMetadata(ctx, next) { mat.metadataFromOpts(opts, log, function (err, metadata) { if (err) { next(err); return; } if (metadata) { log.trace({metadata: metadata}, 'metadata loaded from opts'); ctx.metadata = metadata; } next(); }); }, function loadTags(ctx, next) { mat.tagsFromCreateOpts(opts, log, function (err, tags) { if (err) { next(err); return; } if (tags) { log.trace({tags: tags}, 'tags loaded from opts'); ctx.tags = tags; } next(); }); }, function getImg(ctx, next) { var _opts = { name: args[0], useCache: true }; tritonapi.getImage(_opts, function (err, img) { if (err) { return next(err); } ctx.img = img; log.trace({img: img}, 'create-instance img'); next(); }); }, function getPkg(ctx, next) { if (args.length < 2) { return next(); } var id = args[1]; if (common.isUUID(id)) { ctx.pkg = {id: id}; next(); return; } tritonapi.getPackage(id, function (err, pkg) { if (err) { return next(err); } log.trace({pkg: pkg}, 'create-instance pkg'); ctx.pkg = pkg; next(); }); }, function getNets(ctx, next) { if (!opts.network) { return next(); } // TODO: want an error or warning on no networks? ctx.nets = []; vasync.forEachPipeline({ inputs: opts.network, func: function getOneNetwork(name, nextNet) { tritonapi.getNetwork(name, function (err, net) { if (err) { nextNet(err); } else { ctx.nets.push(net); nextNet(); } }); } }, next); }, function createInst(ctx, next) { assert.optionalArrayOfObject(ctx.volMounts, 'ctx.volMounts'); var createOpts = { name: opts.name, image: ctx.img.id, 'package': ctx.pkg && ctx.pkg.id, networks: ctx.nets && ctx.nets.map( function (net) { return net.id; }) }; if (ctx.volMounts) { createOpts.volumes = ctx.volMounts; } if (ctx.locality) { createOpts.locality = ctx.locality; } if (ctx.metadata) { Object.keys(ctx.metadata).forEach(function (key) { createOpts['metadata.'+key] = ctx.metadata[key]; }); } if (ctx.tags) { Object.keys(ctx.tags).forEach(function (key) { createOpts['tag.'+key] = ctx.tags[key]; }); } for (var i = 0; i < opts._order.length; i++) { var opt = opts._order[i]; if (opt.key === 'firewall') { createOpts.firewall_enabled = opt.value; } } log.trace({dryRun: opts.dry_run, createOpts: createOpts}, 'create-instance createOpts'); ctx.start = Date.now(); if (opts.dry_run) { ctx.inst = { id: 'beefbeef-4c0e-11e5-86cd-a7fd38d2a50b', name: 'this-is-a-dry-run' }; console.log('Creating instance %s (%s, %s@%s)', ctx.inst.name, ctx.inst.id, ctx.img.name, ctx.img.version); return next(); } tritonapi.cloudapi.createMachine(createOpts, function (err, inst) { if (err) { next(new errors.TritonError(err, 'error creating instance')); return; } ctx.inst = inst; if (opts.json) { console.log(JSON.stringify(inst)); } else { console.log('Creating instance %s (%s, %s@%s%s)', inst.name, inst.id, ctx.img.name, ctx.img.version, inst.package ? format(', %s', inst.package) : ''); } next(); }); }, function maybeWait(ctx, next) { if (!opts.wait) { return next(); } // 1 'wait': no distraction. // >1 'wait': distraction, pass in the N. var distraction; if (process.stderr.isTTY && opts.wait.length > 1) { distraction = distractions.createDistraction(opts.wait.length); } // Dry-run: fake wait for a few seconds. var waiter = (opts.dry_run ? function dryWait(waitOpts, waitCb) { setTimeout(function () { ctx.inst.state = 'running'; waitCb(null, ctx.inst); }, 5000); } : tritonapi.cloudapi.waitForMachineStates.bind( tritonapi.cloudapi)); waiter({ id: ctx.inst.id, states: ['running', 'failed'] }, function (err, inst) { if (distraction) { distraction.destroy(); } if (err) { return next(err); } if (opts.json) { console.log(JSON.stringify(inst)); } else if (inst.state === 'running') { var dur = Date.now() - ctx.start; console.log('Created instance %s (%s) in %s', inst.name, inst.id, common.humanDurationFromMs(dur)); } if (inst.state !== 'running') { next(new Error(format('failed to create instance %s (%s)', inst.name, inst.id))); } else { next(); } }); } ]}, function (err) { cb(err); }); } do_create.options = [ { names: ['help', 'h'], type: 'bool', help: 'Show this help.' }, { group: 'Create options' }, { names: ['name', 'n'], helpArg: 'NAME', type: 'string', help: 'Instance name. If not given, one will be generated server-side.' }, { names: ['tag', 't'], type: 'arrayOfString', helpArg: 'TAG', help: 'Add a tag when creating the instance. Tags are ' + 'key/value pairs available on the instance API object as the ' + '"tags" field. TAG is one of: a "key=value" string (bool and ' + 'numeric "value" are converted to that type), a JSON object ' + '(if first char is "{"), or a "@FILE" to have tags be ' + 'loaded from FILE. This option can be used multiple times.' }, { names: ['affinity', 'a'], type: 'arrayOfString', helpArg: 'RULE', help: 'Affinity rules for selecting a server for this instance. ' + 'Rules have one of the following forms: `instance==INST` (the ' + 'new instance must be on the same server as INST), ' + '`instance!=INST` (new inst must *not* be on the same server as ' + 'INST), `instance==~INST` (*attempt* to place on the same server ' + 'as INST), or `instance!=~INST` (*attempt* to place on a server ' + 'other than INST\'s). `INST` is an existing instance name or ' + 'id. There are two shortcuts: `inst` may be used instead of ' + '`instance` and `instance==INST` can be shortened to just ' + '`INST`. Use this option more than once for multiple rules.', completionType: 'tritonaffinityrule' }, { group: '' }, { names: ['network', 'N'], type: 'arrayOfCommaSepString', helpArg: 'NETWORK', help: 'One or more comma-separated networks (ID, name or short id). ' + 'This option can be used multiple times.', completionType: 'tritonnetwork' }, { // TODO: add boolNegationPrefix:'no-' when that cmdln pull is in names: ['firewall'], type: 'bool', help: 'Enable Cloud Firewall on this instance. See ' + '' }, { names: ['volume', 'v'], type: 'arrayOfString', help: 'Mount a volume into the instance (non-KVM only). VOLMOUNT is ' + '"[:access-mode]" where access mode is ' + 'one of "ro" for read-only or "rw" for read-write (default). For ' + 'example: "-v myvolume:/mnt:ro" to mount "myvolume" read-only on ' + '/mnt in this instance.', helpArg: 'VOLMOUNT', hidden: true }, { group: '' }, { names: ['metadata', 'm'], type: 'arrayOfString', helpArg: 'DATA', help: 'Add metadata when creating the instance. Metadata are ' + 'key/value pairs available on the instance API object as the ' + '"metadata" field, and inside the instance via the "mdata-*" ' + 'commands. DATA is one of: a "key=value" string (bool and ' + 'numeric "value" are converted to that type), a JSON object ' + '(if first char is "{"), or a "@FILE" to have metadata be ' + 'loaded from FILE. This option can be used multiple times.' }, { names: ['metadata-file', 'M'], type: 'arrayOfString', helpArg: 'KEY=FILE', help: 'Set a metadata key KEY from the contents of FILE.' }, { names: ['script'], type: 'arrayOfString', helpArg: 'FILE', help: 'Load a file to be used for the "user-script" metadata key. In ' + 'Joyent-provided images, the user-script is run at every boot ' + 'of the instance. This is a shortcut for `-M user-script=FILE`.' }, { group: 'Other options' }, { names: ['dry-run'], type: 'bool', help: 'Go through the motions without actually creating.' }, { names: ['wait', 'w'], type: 'arrayOfBool', help: 'Wait for the creation to complete. Use multiple times for a ' + 'spinner.' }, { names: ['json', 'j'], type: 'bool', help: 'JSON stream output.' } ]; do_create.synopses = ['{{name}} {{cmd}} [OPTIONS] IMAGE PACKAGE']; do_create.help = [ /* BEGIN JSSTYLED */ 'Create a new instance.', '', '{{usage}}', '', '{{options}}', 'Where IMAGE is an image name, name@version, id, or short id (from ', '`spearhead image list`) and PACKAGE is a package name, id, or short id', '(from `spearhead package list`).' /* END JSSTYLED */ ].join('\n'); do_create.helpOpts = { maxHelpCol: 16 }; do_create.completionArgtypes = ['tritonimage', 'tritonpackage', 'none']; module.exports = do_create;