-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs-inspect.html
801 lines (472 loc) · 33.3 KB
/
docs-inspect.html
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
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content=" Singularity Inspect How can you sniff an image? We have provided the inspect command for you to easily see the runscript, test script, environment, and metadata labels.Usage$ singularity inspect --helpUSAGE: singularity [...] inspect [exec options...] <container path>This command will show you the runscript for the image.INSPECT OPTIONS: -l/--labels Show the labels associated with the image (default) -d/--deffile Show the bootstrap definition file which was used to generate this image -r/--runscript Show the runscript for this image -t/--test Show the test script for this image -e/--environment Show the environment settings for this container -j/--json Print structured json instead of sectionsEXAMPLES: $ singularity inspect ubuntu.img #!/bin/sh exec /bin/bash "$@" $ singuarity inspect --labels ubuntu.img { "SINGULARITY_DEFFILE_BOOTSTRAP": "docker", "SINGULARITY_DEFFILE": "Singularity", "SINGULARITY_DEFFILE_FROM": "ubuntu:latest", "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99" }For additional help, please visit our public documentation pages which arefound at: http://singularity.lbl.gov/This inspect is essential for making containers understandable by other tools and applications.JSON Api StandardFor any inspect command, by adding --json you can be assured to get a JSON API standardized response, for example:singularity inspect -l --json ubuntu.img{ "data": { "attributes": { "labels": { "SINGULARITY_DEFFILE_BOOTSTRAP": "docker", "SINGULARITY_DEFFILE": "Singularity", "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99", "SINGULARITY_DEFFILE_FROM": "ubuntu:latest" } }, "type": "container" }}Inspect FlagsThe default, if run without any arguments, will show you the container labels file$ singularity inspect ubuntu.img{ "SINGULARITY_DEFFILE_BOOTSTRAP": "docker", "SINGULARITY_DEFFILE": "Singularity", "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99", "SINGULARITY_DEFFILE_FROM": "ubuntu:latest"}and as outlined in the usage, you can specify to see any combination of --labels, --environment, --runscript, --test, and --deffile. The quick command to see everything, in json format, would be:$ singularity inspect -l -r -d -t -e -j ubuntu.img{ "data": { "attributes": { "test": null, "environment": "# Custom environment shell code should follow\n\n", "labels": { "SINGULARITY_DEFFILE_BOOTSTRAP": "docker", "SINGULARITY_DEFFILE": "Singularity", "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99", "SINGULARITY_DEFFILE_FROM": "ubuntu:latest" }, "deffile": "Bootstrap:docker\nFrom:ubuntu:latest\n", "runscript": "#!/bin/sh\n\nexec /bin/bash \"$@\"" }, "type": "container" }}LabelsThe default, if run without any arguments, will show you the container labels file (located at /.singularity.d/labels.json in the container. These labels are the ones that you define in the %labels section of your bootstrap file, along with any Docker LABEL that came with an image that you imported, and other metadata about the bootstrap. For example, here we are inspecting labels for ubuntu.img$ singularity inspect ubuntu.img{ "SINGULARITY_DEFFILE_BOOTSTRAP": "docker", "SINGULARITY_DEFFILE": "Singularity", "SINGULARITY_BOOTSTRAP_VERSION": "2.2.99", "SINGULARITY_DEFFILE_FROM": "ubuntu:latest"}This is the equivalent of both of:$ singularity inspect -l ubuntu.img$ singularity inspect --labels ubuntu.imgRunscriptThe commands --runscript or -r will show you the runscript, which also can be shown in --json:$ singularity inspect -r -j ubuntu.img{ "data": { "attributes": { "runscript": "#!/bin/sh\n\nexec /bin/bash \"$@\"" }, "type": "container" }}or in a human friendly, readable print to the screen:$ singularity inspect -r ubuntu.img##runscript#!/bin/shexec /bin/bash "$@"EnvironmentThe commands --environment and -e will show you the container’s environment, again specified by the %environment section of a bootstrap file, and other ENV labels that might have come from a Docker import. You can again choose to see --json:$ singularity inspect -e --json ubuntu.img{ "data": { "attributes": { "environment": "# Custom environment shell code should follow\n\n" }, "type": "container" }}or human friendly:$ singularity inspect -e ubuntu.img##environment# Custom environment shell code should followThe container in the example above did not have any custom environment variables set.TestThe equivalent --test or -t commands will print any test defined for the container, which comes from the %test section of the bootstrap specification Singularity file. Again, we can ask for --json or human friendly (default):$ singularity --inspect -t --json ubuntu.img{ "data": { "attributes": { "test": null }, "type": "container" }}$ singularity inspect -t ubuntu.img{ "status": 404, "detail": "This container does not have any tests defined", "title": "Tests Undefined"}DeffileWant to know where your container came from? You can see the entire Singularity definition file, if the container was created with a bootstrap, by using --deffile or -d:$ singularity inspect -d ubuntu.img##deffileBootstrap:dockerFrom:ubuntu:latestor with --json output.$ singularity inspect -d --json ubuntu.img{ "data": { "attributes": { "deffile": "Bootstrap:docker\nFrom:ubuntu:latest\n" }, "type": "container" }}The goal of these commands is to bring more transparency to containers, and to help better integrate them into common workflows by having them expose their guts to the world! If you have feedback for how we can improve or amend this, please let us know! Previous Next Edit me Site last generated: Jul 26, 2017 ">
<meta name="name" content="Singularity Inspect">
<meta name="thumbnail" content="http://singularity.lbl.gov/images/logo/logo.svg">
<title>Singularity Inspect | Singularity</title>
<link rel="stylesheet" href="assets/css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="assets/css/modern-business.css">
<link rel="stylesheet" href="assets/css/lavish-bootstrap.css">
<link rel="stylesheet" href="assets/css/customstyles.css">
<link rel="stylesheet" href="assets/css/theme-blue.css">
<link rel="stylesheet" type="text/css" href="assets/css/asciinema-player.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="assets/js/jquery.navgoco.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="assets/js/toc.js"></script>
<script src="assets/js/customscripts.js"></script>
<link rel="shortcut icon" href="images/favicon/favicon.ico">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="" href="http://localhost:4005feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
</head>
<body>
<!-- asciinema player -->
<script src="assets/js/asciinema-player.js"></script>
<!-- Show or hide players on button clicks-->
<script>
$( document ).ready(function() {
$(".asciinema-button").click(function(){
var asciinemaVideo = "#asciinema-" + $(this).attr('id');
if ($(asciinemaVideo).hasClass('hidden')){
$(asciinemaVideo).removeClass('hidden');
$(this).text('Hide Tutorial')
} else {
$(asciinemaVideo).addClass('hidden');
$(this).text('Show Tutorial')
}
});
});
</script>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"> <span class="projectTitle"> Singularity</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- entries without drop-downs appear here -->
<li><a href="blog">News</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Docs<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="admin-guide">Admin Guide</a></li>
<li><a href="user-guide">User Guide</a></li>
<li><a href="links">Contributed Content</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Quick Links<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://github.com/singularityware/singularity" target="_blank">Github Repo</a></li>
<li><a href="https://groups.google.com/a/lbl.gov/forum/#!forum/singularity" target="_blank">Google Group</a></li>
<li><a href="http://stackoverflow.com/questions/tagged/singularity" target="_blank">Singularity on Stack Overflow</a></li>
<li><a href="https://singularity-hub.org/faq" target="_blank">Singularity Hub</a></li>
<li><a href="https://singularity-container.slack.com" target="_blank">Slack</a></li>
<li><a href="faq#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">People<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://github.com/gmkurtzer" target="_blank">Gregory M. Kurtzer</a></li>
<li><a href="https://github.com/vsoch" target="_blank">Vanessa Sochat</a></li>
<li><a href="https://github.com/bauerm97" target="_blank">Michael Bauer</a></li>
<li><a href="https://github.com/bbockelm" target="_blank">Brian Bockelman</a></li>
<li><a href="https://github.com/singularityware/singularity/blob/master/AUTHORS" target="_blank">Complete Authors List</a></li>
</ul>
</li>
<li><a href="/search"><i class="fa fa-search"></i></li>
<!-- jekyll search hidden in favor of google
<li>
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="assets/js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '<li><a href="{url}" title="Singularity Inspect">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<div class="col-lg-12"> </div>
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3">
<div class="shiny"><a href="\"><figure><img src="/images/logo/logo.svg" class="sidebar-logo"/></figure></a></div>
<ul id="mysidebar" class="nav">
<li class="sidebarTitle">User Guide</li>
<li>
<a href="#">Getting Started</a>
<ul>
<li><a href="user-guide">Introduction</a></li>
<li><a href="docs-quick-start-installation">Quick Start Installation</a></li>
<li><a href="create-image">Create an Image</a></li>
<li><a href="bootstrap-image">Bootstrap an Image</a></li>
<li><a href="docs-content">Adding Content</a></li>
<li><a href="docs-mount">Bind Paths and Files</a></li>
<li><a href="docs-environment-metadata">Environment and Metadata</a></li>
<li><a href="docs-changing-containers">Change an Existing Container</a></li>
<li><a href="docs-docker">Singularity and Docker</a></li>
<li><a href="faq#troubleshooting">Troubleshooting</a></li>
</ul>
<li>
<a href="#">Commands</a>
<ul>
<li><a href="docs-usage">Command Usage</a></li>
<li><a href="docs-bootstrap">bootstrap</a></li>
<li><a href="docs-exec">exec</a></li>
<li><a href="docs-export">export</a></li>
<li><a href="docs-import">import</a></li>
<li class="active"><a href="docs-inspect">inspect</a></li>
<li><a href="docs-pull">pull</a></li>
<li><a href="docs-run">run</a></li>
<li><a href="docs-shell">shell</a></li>
</ul>
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
</p>
-->
</li>
</ul>
</div>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
<!-- Content Column -->
<div class="col-md-9">
<div class="post-header">
<h1 class="post-title-main">Singularity Inspect</h1>
</div>
<div class="post-content">
<!-- Previous and next buttons-->
<div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
<a href="#"><button style="float:left" class="hidden previous-button btn btn-circle btn-default"><i class="fa-2x fa fa-angle-double-left"></i></button></a>
<a href="#"><button style="float:right" class="hidden next-button btn btn-circle btn-default"><i class="fa fa-angle-double-right fa-2x"></i></button></a>
</div></div>
<script>
$(document).ready(function(){
var next = $("li.active").next().last().find('a').attr('href');
var previous = $("li.active").prev().last().find('a').attr('href');
// NEXT BUTTON
if (typeof next == 'undefined'){
console.log("disabling next button")
$(".next-button").addClass("hidden")
} else if (next == "#") {
next = $("li.active").next().find("li").first().find('a').attr('href');
$(".next-button").closest('a').attr('href', next)
$(".next-button").removeClass('hidden')
} else {
$(".next-button").closest('a').attr('href', next)
$(".next-button").removeClass('hidden')
}
// PREVIOUS BUTTON
if (typeof previous == 'undefined'){
console.log("disabling previous button")
$(".previous-button").addClass("hidden")
} else if (previous == "#") {
previous = $("li.active").prev().find("li").last().find('a').attr('href')
$(".previous-button").closest('a').attr('href', previous)
$(".previous-button").removeClass('hidden')
} else {
$(".previous-button").closest('a').attr('href', previous)
$(".previous-button").removeClass('hidden')
}
})
</script>
<p>How can you sniff an image? We have provided the inspect command for you to easily see the runscript, test script, environment, and metadata labels.</p>
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 10);
return false
})
});
</script>
<div id="toc"></div>
<h2 id="usage">Usage</h2>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>singularity inspect --help
USAGE: singularity <span class="o">[</span>...] inspect <span class="o">[</span><span class="nb">exec </span>options...] <container path>
This <span class="nb">command </span>will show you the runscript <span class="k">for </span>the image.
INSPECT OPTIONS:
-l/--labels Show the labels associated with the image <span class="o">(</span>default<span class="o">)</span>
-d/--deffile Show the bootstrap definition file which was used
to generate this image
-r/--runscript Show the runscript <span class="k">for </span>this image
-t/--test Show the <span class="nb">test </span>script <span class="k">for </span>this image
-e/--environment Show the environment settings <span class="k">for </span>this container
-j/--json Print structured json instead of sections
EXAMPLES:
<span class="nv">$ </span>singularity inspect ubuntu.img
<span class="c">#!/bin/sh</span>
<span class="nb">exec</span> /bin/bash <span class="s2">"</span><span class="nv">$@</span><span class="s2">"</span>
<span class="nv">$ </span>singuarity inspect --labels ubuntu.img
<span class="o">{</span>
<span class="s2">"SINGULARITY_DEFFILE_BOOTSTRAP"</span>: <span class="s2">"docker"</span>,
<span class="s2">"SINGULARITY_DEFFILE"</span>: <span class="s2">"Singularity"</span>,
<span class="s2">"SINGULARITY_DEFFILE_FROM"</span>: <span class="s2">"ubuntu:latest"</span>,
<span class="s2">"SINGULARITY_BOOTSTRAP_VERSION"</span>: <span class="s2">"2.2.99"</span>
<span class="o">}</span>
For additional <span class="nb">help</span>, please visit our public documentation pages which are
found at:
http://singularity.lbl.gov/
</code></pre>
</div>
<p>This inspect is essential for making containers understandable by other tools and applications.</p>
<h2 id="json-api-standard">JSON Api Standard</h2>
<p>For any inspect command, by adding <code class="highlighter-rouge">--json</code> you can be assured to get a <a href="http://jsonapi.org/" target="_blank">JSON API</a> standardized response, for example:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>singularity inspect -l --json ubuntu.img
{
"data": {
"attributes": {
"labels": {
"SINGULARITY_DEFFILE_BOOTSTRAP": "docker",
"SINGULARITY_DEFFILE": "Singularity",
"SINGULARITY_BOOTSTRAP_VERSION": "2.2.99",
"SINGULARITY_DEFFILE_FROM": "ubuntu:latest"
}
},
"type": "container"
}
}
</code></pre>
</div>
<h2 id="inspect-flags">Inspect Flags</h2>
<p>The default, if run without any arguments, will show you the container labels file</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect ubuntu.img
{
"SINGULARITY_DEFFILE_BOOTSTRAP": "docker",
"SINGULARITY_DEFFILE": "Singularity",
"SINGULARITY_BOOTSTRAP_VERSION": "2.2.99",
"SINGULARITY_DEFFILE_FROM": "ubuntu:latest"
}
</code></pre>
</div>
<p>and as outlined in the usage, you can specify to see any combination of <code class="highlighter-rouge">--labels</code>, <code class="highlighter-rouge">--environment</code>, <code class="highlighter-rouge">--runscript</code>, <code class="highlighter-rouge">--test</code>, and <code class="highlighter-rouge">--deffile</code>. The quick command to see everything, in json format, would be:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -l -r -d -t -e -j ubuntu.img
{
"data": {
"attributes": {
"test": null,
"environment": "# Custom environment shell code should follow\n\n",
"labels": {
"SINGULARITY_DEFFILE_BOOTSTRAP": "docker",
"SINGULARITY_DEFFILE": "Singularity",
"SINGULARITY_BOOTSTRAP_VERSION": "2.2.99",
"SINGULARITY_DEFFILE_FROM": "ubuntu:latest"
},
"deffile": "Bootstrap:docker\nFrom:ubuntu:latest\n",
"runscript": "#!/bin/sh\n\nexec /bin/bash \"$@\""
},
"type": "container"
}
}
</code></pre>
</div>
<h3 id="labels">Labels</h3>
<p>The default, if run without any arguments, will show you the container labels file (located at <code class="highlighter-rouge">/.singularity.d/labels.json</code> in the container. These labels are the ones that you define in the <code class="highlighter-rouge">%labels</code> section of your bootstrap file, along with any Docker <code class="highlighter-rouge">LABEL</code> that came with an image that you imported, and other metadata about the bootstrap. For example, here we are inspecting labels for <code class="highlighter-rouge">ubuntu.img</code></p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect ubuntu.img
{
"SINGULARITY_DEFFILE_BOOTSTRAP": "docker",
"SINGULARITY_DEFFILE": "Singularity",
"SINGULARITY_BOOTSTRAP_VERSION": "2.2.99",
"SINGULARITY_DEFFILE_FROM": "ubuntu:latest"
}
</code></pre>
</div>
<p>This is the equivalent of both of:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -l ubuntu.img
$ singularity inspect --labels ubuntu.img
</code></pre>
</div>
<h3 id="runscript">Runscript</h3>
<p>The commands <code class="highlighter-rouge">--runscript</code> or <code class="highlighter-rouge">-r</code> will show you the runscript, which also can be shown in <code class="highlighter-rouge">--json</code>:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -r -j ubuntu.img{
"data": {
"attributes": {
"runscript": "#!/bin/sh\n\nexec /bin/bash \"$@\""
},
"type": "container"
}
}
</code></pre>
</div>
<p>or in a human friendly, readable print to the screen:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -r ubuntu.img
##runscript
#!/bin/sh
exec /bin/bash "$@"
</code></pre>
</div>
<h3 id="environment">Environment</h3>
<p>The commands <code class="highlighter-rouge">--environment</code> and <code class="highlighter-rouge">-e</code> will show you the container’s environment, again specified by the <code class="highlighter-rouge">%environment</code> section of a bootstrap file, and other <code class="highlighter-rouge">ENV</code> labels that might have come from a Docker import. You can again choose to see <code class="highlighter-rouge">--json</code>:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -e --json ubuntu.img
{
"data": {
"attributes": {
"environment": "# Custom environment shell code should follow\n\n"
},
"type": "container"
}
}
</code></pre>
</div>
<p>or human friendly:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -e ubuntu.img
##environment
# Custom environment shell code should follow
</code></pre>
</div>
<p>The container in the example above did not have any custom environment variables set.</p>
<h3 id="test">Test</h3>
<p>The equivalent <code class="highlighter-rouge">--test</code> or <code class="highlighter-rouge">-t</code> commands will print any test defined for the container, which comes from the <code class="highlighter-rouge">%test</code> section of the bootstrap specification Singularity file. Again, we can ask for <code class="highlighter-rouge">--json</code> or human friendly (default):</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity --inspect -t --json ubuntu.img
{
"data": {
"attributes": {
"test": null
},
"type": "container"
}
}
$ singularity inspect -t ubuntu.img
{
"status": 404,
"detail": "This container does not have any tests defined",
"title": "Tests Undefined"
}
</code></pre>
</div>
<h3 id="deffile">Deffile</h3>
<p>Want to know where your container came from? You can see the entire Singularity definition file, if the container was created with a bootstrap, by using <code class="highlighter-rouge">--deffile</code> or <code class="highlighter-rouge">-d</code>:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -d ubuntu.img
##deffile
Bootstrap:docker
From:ubuntu:latest
</code></pre>
</div>
<p>or with <code class="highlighter-rouge">--json</code> output.</p>
<div class="highlighter-rouge"><pre class="highlight"><code>$ singularity inspect -d --json ubuntu.img
{
"data": {
"attributes": {
"deffile": "Bootstrap:docker\nFrom:ubuntu:latest\n"
},
"type": "container"
}
}
</code></pre>
</div>
<p>The goal of these commands is to bring more transparency to containers, and to help better integrate them into common workflows by having them expose their guts to the world! If you have feedback for how we can improve or amend this, please <a href="https://github.com/singularityware/singularity/issues" target="_blank">let us know!</a></p>
<!-- More navigation on the bottom -->
<div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
<a href="#"><button style="width:20%; height: 70px; float:left" class="hidden previous-button btn btn-lg btn-default">Previous</button></a>
<a href="#"><button style="width:20%; height: 70px; float:right" class="hidden next-button btn btn-lg btn-default">Next</button></a>
</div></div>
<a style="margin-top:10px;margin-bottom:10px" target="_blank" href="https://github.com/singularityware/singularityware.github.io/blob/master/pages/_pages/docs/docs-inspect.md" class="btn btn-default btn-xs githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
<div class="tags">
</div>
</div>
<hr class="shaded"/>
<footer>
<div class="row">
<!-- Social Media links, etc -->
<div class="col-lg-6 footer">
<a class="no-after social-icon" href="https://twitter.com/SingularityApp">
<i class="fa fa-4x fa-twitter no-after"></i>
</a>
<a class="no-after social-icon" href="https://github.com/singularityware">
<i class="fa fa-4x fa-github no-after"></i>
</a>
</div>
<div class="col-lg-6 footer">
<p><img src="images/logo/logo.png" alt="Company logo" style="width:40px;padding-bottom:10px"/></p>
Site last generated: Jul 26, 2017 <br />
</div>
</div>
</footer>
</div>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
</body>
<!-- the google_analytics_id gets auto inserted from the config file -->
<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','UA-84672381-1','auto');ga('require','displayfeatures');ga('send','pageview');</script>
</html>