/
cli.js
2146 lines (2021 loc) · 65.3 KB
/
cli.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at http://smartos.org/CDDL
*
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file.
*
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
* Copyright (c) 2018, Joyent, Inc. All rights reserved.
*
* * *
*
* The main entry point for an the imgadm CLI.
*
* Usage:
* var cli = new CLI();
* cmdln.main(cli, argv, {showCode: true});
*/
var p = console.warn;
var assert = require('assert-plus');
var async = require('async');
var bunyan = require('bunyan');
var child_process = require('child_process'),
spawn = child_process.spawn,
exec = child_process.exec;
var Cmdln = require('cmdln').Cmdln;
var fs = require('fs');
var genUuid = require('node-uuid');
var os = require('os');
var path = require('path');
var restify = require('restify');
var rimraf = require('rimraf');
var sprintf = require('extsprintf').sprintf;
var tabula = require('tabula');
var util = require('util'),
format = util.format;
var vasync = require('vasync');
var imgadm = require('./imgadm');
var common = require('./common'),
objCopy = common.objCopy,
objMerge = common.objMerge,
NAME = common.NAME,
pathSlugify = common.pathSlugify,
assertUuid = common.assertUuid;
var docker = require('./sources/docker');
var errors = require('./errors');
// ---- globals
var pkg = require('../package.json');
// ---- internal support functions
/**
* Take CLI input args of the form FIELD=VALUE (or similar) and transform
* to an object of `filters` which can be used with `filterImagesInfo`.
*/
function filtersFromArgs(args) {
assert.arrayOfString(args, 'args');
var filters = {};
for (var i = 0; i < args.length; i++) {
var arg = args[i];
var idx = arg.indexOf('=');
if (idx === -1) {
throw new errors.UsageError(format(
'invalid filter: "%s" (must be of the form "field=value")',
arg));
}
var argVal = arg.slice(idx + 1);
if (argVal === 'true') {
argVal = true;
} else if (argVal === 'false') {
argVal = false;
}
filters[arg.slice(0, idx)] = argVal;
}
return filters;
}
/**
* Return a "row" with the manifest fields and a number of calculate
* convenience fields to be used for filtering and listing.
*
* Dev Note: Update the `do_list.help` docs below when changing row fields.
*
* Dev Note: this modifies `imageInfo.manifest` in-place.
*/
function rowFromImageInfo(imageInfo) {
assert.object(imageInfo, 'imageInfo');
var row = imageInfo.manifest;
if (row.published_at) {
// Just the date.
row.published_date = row.published_at.slice(0, 10);
row.pub = row.published_date;
// Normalize on no milliseconds.
row.published = row.published_at.replace(/\.\d+Z$/, 'Z');
}
row.source = imageInfo.source;
row.clones = imageInfo.clones;
row.zpool = imageInfo.zpool;
if (row.files && row.files[0]) {
row.size = row.files[0].size;
}
if (row.type === 'docker') {
row.docker_id = row.tags['docker:id'];
row.docker_short_id = row.docker_id.slice(0, 12);
row.docker_repo = row.tags['docker:repo'];
row.docker_tags = Object.keys(row.tags).filter(function (t) {
return t.slice(0, 11) === 'docker:tag:';
}).map(function (t) { return t.slice(11); });
}
return row;
}
/* BEGIN JSSTYLED */
var rowFieldsHelp = (
' Any of the manifest fields (see `imgadm {{cmd}} -j` output) plus the\n'
+ ' following computed fields for convenience.\n'
+ '\n'
+ ' published_date, pub just the date part of `published_at`\n'
+ ' published `published_at` with the milliseconds removed\n'
+ ' source the source URL, if available\n'
+ ' clones the number of clones (dependent images and VMs)\n'
+ ' size the size, in bytes, of the image file\n'
+ '\n'
+ ' In addition if this is a docker image, then the following:\n'
+ '\n'
+ ' docker_id the full docker id string\n'
+ ' docker_short_id the short 12 character docker id\n'
+ ' docker_repo the docker repo from which this image\n'
+ ' originates, if available\n'
+ ' docker_tags a JSON array of docker repo tags, if available\n');
/* END JSYSTYLED */
function filterImagesInfo(imagesInfo, filters) {
assert.arrayOfObject(imagesInfo, 'imagesInfo');
assert.object(filters, 'filters');
var fields = Object.keys(filters);
if (fields.length === 0) {
return imagesInfo;
}
var filtered = [];
for (var j = 0; j < imagesInfo.length; j++) {
var row = rowFromImageInfo(imagesInfo[j]);
var keep = true;
for (var f = 0; f < fields.length; f++) {
var field = fields[f];
var val = filters[field];
var lookups = field.split(/\./g);
var actual = row;
for (var k = 0; k < lookups.length; k++) {
actual = actual[lookups[k]];
if (actual === undefined) {
break;
}
}
if (actual === undefined) {
keep = false;
break;
} else if (typeof (val) === 'boolean') {
if (val !== actual) {
keep = false;
break;
}
} else if (val[0] === '~') {
if (actual.indexOf(val.slice(1)) === -1) {
keep = false;
break;
}
} else {
if (String(actual) !== val) {
keep = false;
break;
}
}
}
if (keep) {
filtered.push(imagesInfo[j]);
}
}
return filtered;
}
function listImagesInfo(imagesInfo, opts) {
assert.arrayOfObject(imagesInfo, 'imagesInfo');
assert.optionalObject(opts, 'opts');
if (!opts) {
opts = {};
}
assert.optionalBool(opts.json, 'opts.json');
assert.optionalBool(opts.skipHeader, 'opts.skipHeader');
assert.optionalBool(opts.docker, 'opts.docker');
assert.optionalArrayOfString(opts.columns, 'opts.columns');
assert.optionalArrayOfString(opts.sort, 'opts.sort');
if (opts.json) {
console.log(JSON.stringify(imagesInfo, null, 2));
} else {
var rows = imagesInfo.map(
function (imageInfo) { return rowFromImageInfo(imageInfo); });
/**
* `docker images`-like output:
* - only docker images
* - one row per *tag*
* - skip "non-head" images (see docker/graph/list.go)
*/
if (opts.docker) {
var i, row;
var isOriginFromUuid = {};
for (i = 0; i < rows.length; i++) {
row = rows[i];
if (isOriginFromUuid[row.uuid] === undefined) {
isOriginFromUuid[row.uuid] = false;
}
if (row.origin) {
isOriginFromUuid[row.origin] = true;
}
}
var dRows = [];
for (i = 0; i < rows.length; i++) {
row = rows[i];
if (row.type !== 'docker') {
continue;
}
var isHead = !isOriginFromUuid[row.uuid];
if (!isHead) {
continue;
}
(row.docker_tags.length ? row.docker_tags : [null]).forEach(
function (dTag) {
var dRow = objCopy(row);
dRow.docker_tag = dTag;
dRows.push(dRow);
});
}
rows = dRows;
// Override display opts.
opts.columns = [
{name: 'UUID', lookup: 'uuid'},
{name: 'REPOSITORY', lookup: 'docker_repo'},
{name: 'TAG', lookup: 'docker_tag'},
{name: 'IMAGE_ID', lookup: 'docker_short_id'},
{name: 'CREATED', lookup: 'published'}
];
opts.sort = ['published_at'];
}
tabula(rows, {
skipHeader: opts.skipHeader,
columns: opts.columns,
sort: opts.sort
});
}
}
// ---- CLI object
/**
* Create an imgadm CLI instance.
*/
function CLI() {
Cmdln.call(this, {
name: NAME,
desc: pkg.description,
options: [
{names: ['help', 'h'], type: 'bool', help: 'Print help and exit.'},
{name: 'version', type: 'bool', help: 'Print version and exit.'},
{names: ['verbose', 'v'], type: 'bool',
help: 'Verbose output: trace-level logging, stack on error. '
+ 'See IMGADM_LOG_LEVEL envvar.'},
{name: 'E', type: 'bool',
help: 'On error, emit a structured JSON error object as the '
+ 'last line of stderr output.'}
],
helpOpts: {
includeEnv: true,
minHelpCol: 30 /* line up with option help */
}
});
}
util.inherits(CLI, Cmdln);
CLI.prototype.init = function init(opts, args, cb) {
var self = this;
/*
* Logging setup.
*
* - Log to stderr.
* TODO: see sdcadm/vmadm for logging trace-level to separate files
* for subsequent rollup and rotation.
* - By default we log at the 'warn' level. Intentionally that is
* almost no logging.
* - use IMGADM_LOG_LEVEL=trace envvar to set to trace level and enable
* source location (src=true) in log records
* - '-v|--verbose' or IMGADM_LOG_LEVEL=trace to set to trace-level
* - use IMGADM_LOG_LEVEL=<bunyan level> to set to a different level
* - '-E' to have a possible error be logged as the last single line
* of stderr as a raw Bunyan log JSON record with an 'err'. I.e. in a
* structured format more useful to automation tooling.
* - Include a `req_id` in log output. This is the ID for this imgadm
* run. If `REQ_ID` envvar is set, then use that.
*
* Logging is in Bunyan (JSON) format so one needs to pipe via
* `bunyan` for readable output (at least until bunyan.js supports
* doing it inline). Admittedly this is a bit of a pain:
*
* imgadm -v ... 2>&1 | bunyan
*/
var req_id;
if (process.env.REQ_ID) {
req_id = process.env.REQ_ID;
} else if (process.env.req_id) {
req_id = process.env.req_id;
} else {
req_id = genUuid();
}
var log = bunyan.createLogger({
name: self.name,
streams: [
{
stream: process.stderr,
level: 'warn'
}
],
// TODO hack serializers until
// https://github.com/mcavage/node-restify/pull/501 is fixed
// serializers: bunyan.stdSerializers,
serializers: restify.bunyan.serializers,
req_id: req_id
});
var IMGADM_LOG_LEVEL;
try {
if (process.env.IMGADM_LOG_LEVEL
&& bunyan.resolveLevel(process.env.IMGADM_LOG_LEVEL))
{
IMGADM_LOG_LEVEL = process.env.IMGADM_LOG_LEVEL;
}
} catch (e) {
log.warn('invalid IMGADM_LOG_LEVEL=%s envvar (ignoring)',
process.env.IMGADM_LOG_LEVEL);
}
if (opts.verbose) {
log.level('trace');
log.src = true;
} else if (IMGADM_LOG_LEVEL) {
log.level(IMGADM_LOG_LEVEL);
if (IMGADM_LOG_LEVEL === 'trace') {
log.src = true;
}
}
self.log = log;
// Log the invocation args (trim out dashdash meta vars).
var trimmedOpts = common.objCopy(opts);
delete trimmedOpts._args;
delete trimmedOpts._order;
this.log.debug({opts: trimmedOpts, args: args, cli: true}, 'cli init');
// Error printing options.
if (log.level() <= bunyan.DEBUG) {
self.showErrStack = true;
}
self.structuredErr = opts.E;
if (opts.version) {
console.log(self.name + ' ' + common.getVersion());
cb(false);
return;
}
// Cmdln class handles `opts.help`.
Cmdln.prototype.init.call(this, opts, args, function (err) {
if (err || err === false) {
cb(err);
return;
}
imgadm.createTool({log: self.log}, function (createErr, tool) {
if (createErr) {
cb(createErr);
return;
}
self.tool = tool;
cb();
});
});
};
CLI.prototype.fini = function fini(subcmd, err, cb) {
/*
* We want to log these `cli:true` entry and exits for CLI usage and
* we want to the exitStatus -- which means some duplication (see
* `cmdln.main` as well) on pulling it out, unfortunately.
*/
var exitStatus = (err ? err.exitStatus || 1 : 0);
this.log.debug({subcmd: subcmd, exitStatus: exitStatus, cli: true},
'cli exit');
/*
* Handle `-E`: last line stderr is a structured JSON object
* with the error.
*/
if (err && this.structuredErr) {
this.log.error(err, err.message);
this.showErr = false;
}
cb();
};
/**
* Override `Cmdln.printHelp` to have custom output for the commands.
* Manual, but much nicer.
*/
CLI.prototype.printHelp = function printHelp(cb) {
var lines = [];
if (this.desc) {
lines.push(this.desc);
}
lines = lines.concat([
'',
'Usage:',
' {{name}} [<options>] <command> [<args>...]',
' {{name}} help <command>',
''
]);
if (this.optParser.help) {
lines.push('Options:');
lines.push(this.optParser.help(this.helpOpts).trimRight());
}
lines = lines.concat([
'',
'Environment:',
' IMGADM_LOG_LEVEL=<level> Set log level to one of "trace",',
' "debug", "info", "warn" (default)',
' "error", "fatal".'
]);
/* BEGIN JSSTYLED */
lines = lines.concat([
'',
'Commands:',
' imgadm help [<command>] help on commands',
'',
' imgadm sources [<options>] list and edit image sources',
'',
' imgadm avail [<filters>] list available images',
' imgadm show <uuid|docker-repo-tag> show manifest of an available image',
'',
' imgadm import [-P <pool>] <image-id> import image from a source',
' imgadm install [-P <pool>] -m <manifest> -f <file>',
' import from local image data',
'',
' imgadm list [<filters>] list installed images',
' imgadm get [-P <pool>] <uuid> info on an installed image',
' imgadm update [<uuid>...] update installed images',
' imgadm delete [-P <pool>] <uuid> remove an installed image',
' imgadm ancestry [-P <pool>] <uuid> show ancestry of an installed image',
' imgadm vacuum [-n] [-f] delete unused images',
'',
' imgadm create <vm-uuid> [<manifest-field>=<value> ...] ...',
' create an image from a VM',
' imgadm publish -m <manifest> -f <file> <imgapi-url>',
' publish an image to an image repo',
'',
'See `imgadm help <command>` or the imgadm(1m) man page for more details.'
]);
/* END JSSTYLED */
console.log(lines.join('\n').replace(/{{name}}/g, this.name));
cb();
};
CLI.prototype.do_sources = function do_sources(subcmd, opts, args, cb) {
var self = this;
if (opts.help) {
self.do_help('help', {}, [subcmd], cb);
return;
}
if (args.length > 0) {
cb(new errors.UsageError(
'unexpected args: ' + args.join(' ')));
return;
}
if (opts.add_docker_hub) {
opts.a = 'https://docker.io';
opts.type = 'docker';
}
var nActions = 0;
if (opts.e) nActions++;
if (opts.a) nActions++;
if (opts.d) nActions++;
if (opts.check) nActions++;
if (nActions > 1) {
cb(new errors.UsageError(
'cannot specify more than one of "-a", "-d", "-e", and "-c"'));
return;
}
var skipPingCheck = opts.force === true;
if (opts.e) {
var before = self.tool.sources.map(function (s) {
return s.toJSON();
});
var width = 0;
self.tool.sources.forEach(function (s) {
width = Math.max(width, s.url.length);
});
var template = format('%%-%ds %%-%ds %%s', Math.min(width, 50), 6);
var beforeText = before.map(function (s) {
var options = [];
if (s.insecure) {
options.push('insecure');
}
return sprintf(template, s.url, s.type, options.join(','))
.trimRight();
}).join('\n')
+ '\n\n'
+ '#\n'
+ '# Enter sources, one per line, as follows:\n'
+ '#\n'
+ '# URL TYPE [OPTIONS]\n'
+ '#\n'
+ '# where "TYPE" is one of "imgapi" (the default), "docker", or\n'
+ '# "dsapi" (deprecated); and where "OPTIONS" is the literal\n'
+ '# string "insecure" to skip TLS server certificate checking\n'
+ '# for this source.\n'
+ '#\n'
+ '# Comments beginning with "#" are stripped.\n'
+ '#\n';
var tmpPath = path.resolve(os.tmpDir(),
format('imgadm-sources-%s.txt', process.pid));
fs.writeFileSync(tmpPath, beforeText, 'utf8');
function sourcesInfoFromText(text) {
return text.trim().split(/\n/g)
.map(function (line) {
return line.split('#')[0].trim(); // drop comments
}).filter(function (line) {
return line.length; // drop blank lines
}).map(function (line) {
var parts = line.split(/\s+/g);
if (!parts[1]) {
parts[1] = 'imgapi'; // default type
}
var s = {url: parts[0], type: parts[1]};
if (parts[2]) {
// JSSTYLED
var options = parts[2].trim().split(/,/g);
for (var i = 0; i < options.length; i++) {
switch (options[i]) {
case 'insecure':
s.insecure = true;
break;
default:
throw new errors.UsageError('unknown source '
+ 'option: ' + options[i]);
}
}
}
return s;
});
}
// TODO: re-editing if error adding (e.g. typo in type or whtaever)
var vi = spawn('/usr/bin/vi', ['-f', tmpPath], {stdio: 'inherit'});
vi.on('exit', function (code) {
if (code) {
console.warn('Error editing image sources: %s (ignoring)',
code);
cb();
return;
}
var afterText = fs.readFileSync(tmpPath, 'utf8');
fs.unlinkSync(tmpPath);
if (afterText === beforeText) {
console.log('Image sources unchanged');
cb();
return;
}
try {
var after = sourcesInfoFromText(afterText);
} catch (ex) {
cb(ex);
return;
}
if (JSON.stringify(after) === JSON.stringify(before)) {
console.log('Image sources unchanged');
cb();
return;
}
self.log.info({after: after}, 'update sources');
self.tool.updateSources(after, skipPingCheck,
function (err, changes) {
if (err) {
cb(err);
} else {
changes.forEach(function (change) {
if (change.type === 'reorder') {
console.log('Reordered image sources');
} else if (change.type === 'add') {
console.log('Added %s', change.source);
} else if (change.type === 'del') {
console.log('Deleted %s', change.source);
}
});
cb();
}
});
});
} else if (opts.a) {
var addOpts = {
url: opts.a,
type: opts.type,
insecure: opts.insecure
};
this.tool.configAddSource(addOpts, skipPingCheck,
function (err, changed, source) {
if (err) {
cb(err);
} else if (changed) {
console.log('Added %s', source);
cb();
} else {
console.log('Already have %s, no change', source);
cb();
}
}
);
} else if (opts.d) {
this.tool.configDelSourceUrl(opts.d, function (err, deleted) {
if (err) {
cb(err);
} else if (deleted) {
deleted.forEach(function (s) {
console.log('Deleted %s', s);
});
cb();
} else {
console.log('Do not have image source "%s", no change',
opts.d);
cb();
}
});
} else if (opts.check) {
var rows = [];
vasync.forEachParallel({
inputs: this.tool.sources,
func: function pingCheck(source, next) {
source.ping(function (pingErr) {
var row = {url: source.url, type: source.type};
if (pingErr) {
row.ok = false;
row.error = pingErr.toString();
} else {
row.ok = true;
}
rows.push(row);
next(null);
});
}
}, function donePingChecks(err) {
if (err) {
cb(err);
return;
}
tabula(rows, {columns: ['url', 'type', 'ok', 'error']});
cb();
});
} else {
// The default flat list of source *urls*.
var sources = this.tool.sources.map(function (s) {
return {url: s.url, type: s.type, insecure: s.insecure};
});
if (opts.json) {
console.log(JSON.stringify(sources, null, 2));
} else if (opts.verbose) {
tabula(sources, {columns: ['url', 'type', 'insecure']});
} else {
// The default flat list of source *urls*.
sources.forEach(function (s) {
console.log(s.url);
});
}
cb();
}
};
CLI.prototype.do_sources.help = (
/* BEGIN JSSTYLED */
'List and edit image sources.\n'
+ '\n'
+ 'An image source is a URL to a server implementing the IMGAPI, or\n'
+ 'the Docker Registry API. The default IMGAPI is ' + common.DEFAULT_SOURCE.url + '\n'
+ '\n'
+ 'Usage:\n'
+ ' {{name}} sources [--verbose|-v] [--json|-j] # list sources\n'
+ ' {{name}} sources -a <url> [-t <type>] # add a source\n'
+ ' {{name}} sources -d <url> # delete a source\n'
+ ' {{name}} sources -e # edit sources\n'
+ ' {{name}} sources -c # check current sources\n'
+ '\n'
+ '{{options}}'
+ '\n'
+ 'Examples:\n'
+ ' # Joyent\'s primary public image repository (defaults to "imgapi")\n'
+ ' {{name}} sources -a https://images.joyent.com\n'
+ ' # Docker Hub\n'
+ ' {{name}} sources -a https://docker.io -t docker\n'
+ ' # Legacy SDC 6.5 DSAPI (deprecated)\n'
+ ' {{name}} sources -a https://datasets.joyent.com/datasets -t dsapi\n'
/* END JSSTYLED */
);
CLI.prototype.do_sources.options = [
{
names: ['help', 'h'],
type: 'bool',
help: 'Show this help.'
},
{
names: ['verbose', 'v'],
type: 'bool',
help: 'Verbose output. List source URL and TYPE.'
},
{
names: ['json', 'j'],
type: 'bool',
help: 'List sources as JSON.'
},
{
group: ''
},
{
names: ['a'],
type: 'string',
helpArg: '<source>',
help: 'Add a source. It is appended to the list of sources.'
},
{
names: ['add-docker-hub'],
type: 'bool',
help: 'A shortcut for "imgadm sources -t docker -a https://docker.io".'
},
{
names: ['d'],
type: 'string',
helpArg: '<source>',
help: 'Delete a source.'
},
{
names: ['e'],
type: 'bool',
help: 'Edit sources in an editor.'
},
{
names: ['check', 'c'],
type: 'bool',
help: 'Ping check all sources.'
},
{
group: ''
},
{
names: ['type', 't'],
type: 'string',
default: 'imgapi',
helpArg: '<type>',
help: 'The source type for an added source. One of "imgapi" (the '
+ 'default), "docker", or "dsapi" (deprecated).'
},
{
names: ['insecure', 'k'],
type: 'bool',
help: 'Allow insecure (no server certificate checking) access '
+ 'to the added HTTPS source URL.'
},
{
names: ['force', 'f'],
type: 'bool',
help: 'Force no "ping check" on new source URLs. By default '
+ 'a ping check is done against new source URLs to '
+ 'attempt to ensure they are a running IMGAPI server.'
}
];
CLI.prototype.do_avail = function do_avail(subcmd, opts, args, cb) {
var self = this;
if (opts.help) {
self.do_help('help', {}, [subcmd], cb);
return;
}
try {
var filters = filtersFromArgs(args);
} catch (e) {
cb(e);
return;
}
self.log.debug({filters: filters}, 'avail filters');
/* JSSTYLED */
var columns = opts.o.trim().split(/\s*,\s*/g);
/* JSSTYLED */
var sort = opts.s.trim().split(/\s*,\s*/g);
self.tool.sourcesList(function (err, imagesInfo) {
// Even if there was an err, we still attempt to return results
// for working sources.
try {
imagesInfo = filterImagesInfo(imagesInfo, filters);
listImagesInfo(imagesInfo, {
json: opts.json,
columns: columns,
sort: sort,
skipHeader: opts.H
});
} catch (e) {
cb(e);
return;
}
cb(err);
});
};
CLI.prototype.do_avail.help = (
'List available images from all sources.\n'
+ 'This is not supported for Docker sources.\n'
+ '\n'
+ 'Usage:\n'
+ ' {{name}} avail [<options>...]\n'
+ '\n'
+ '{{options}}'
+ '\n'
+ 'Fields for "-o" and "-s":\n'
+ rowFieldsHelp
);
CLI.prototype.do_avail.options = [
{
names: ['help', 'h'],
type: 'bool',
help: 'Show this help.'
},
{
names: ['json', 'j'],
type: 'bool',
help: 'JSON output.'
},
{
names: ['H'],
type: 'bool',
help: 'Do not print table header row.'
},
{
names: ['o'],
type: 'string',
helpArg: 'FIELD,...',
help: 'Specify fields (columns) to output. Default is '
+ '"uuid,name,version,os,type,pub".',
default: 'uuid,name,version,os,type,pub'
},
{
names: ['s'],
type: 'string',
helpArg: 'FIELD,...',
help: 'Sort on the given fields. Default is "published_at,name".',
default: 'published_at,name'
}
];
CLI.prototype.do_avail.aliases = ['available'];
CLI.prototype.do_list = function do_list(subcmd, opts, args, cb) {
var self = this;
if (opts.help) {
self.do_help('help', {}, [subcmd], cb);
return;
}
var log = self.log;
log.debug({opts: opts}, 'list');
try {
var filters = filtersFromArgs(args);
} catch (e) {
cb(e);
return;
}
if (opts.docker) {
filters['type'] = 'docker';
}
if (args) {
log.debug({filters: filters}, 'list filters');
}
/* JSSTYLED */
var columns = opts.o.trim().split(/\s*,\s*/g);
/* JSSTYLED */
var sort = opts.s.trim().split(/\s*,\s*/g);
self.tool.listImages(function (err, imagesInfo) {
log.debug({err: err, imagesInfo: imagesInfo}, 'listImages');
if (err) {
cb(err);
return;
}
try {
imagesInfo = filterImagesInfo(imagesInfo, filters);
listImagesInfo(imagesInfo, {
json: opts.json,
columns: columns,
sort: sort,
skipHeader: opts.H,
docker: opts.docker
});
} catch (e) {
cb(e);
return;
}
cb();
});
};
CLI.prototype.do_list.help = (
'List locally installed images.\n'
+ '\n'
+ 'Usage:\n'
+ ' {{name}} list [<options>...] [<filters>]\n'
+ '\n'
+ '{{options}}'
+ '\n'
+ 'Filters:\n'
+ ' FIELD=VALUE exact string match\n'
+ ' FIELD=true|false boolean match\n'
+ ' FIELD=~SUBSTRING substring match\n'
+ '\n'
+ 'Fields for filtering, "-o" and "-s":\n'
+ rowFieldsHelp
);
CLI.prototype.do_list.options = [
{
names: ['help', 'h'],
type: 'bool',
help: 'Show this help.'
},
{
names: ['json', 'j'],
type: 'bool',
help: 'JSON output.'
},
{
names: ['H'],
type: 'bool',
help: 'Do not print table header row.'