Skip to content

Commit ed7eaa9

Browse files
committed
Added section Remotely Bootstrapped and Built Containers - includes screenshots
1 parent 0ad157c commit ed7eaa9

File tree

4 files changed

+64
-0
lines changed

4 files changed

+64
-0
lines changed

build_gui.png

26.2 KB
Loading

build_output.png

38.3 KB
Loading

mysylabslibrary.png

66.8 KB
Loading

singularity_and_docker.rst

+64
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,8 @@ results in ``lolcow_from_docker_cache.sif`` for native use by Singularity. There
564564
Working with Definition Files
565565
=============================
566566

567+
.. _sec:def_file_mandatory_headers_remotely_boostrapped:
568+
567569
Mandatory Headers: Remotely Boostrapped
568570
---------------------------------------
569571

@@ -618,6 +620,68 @@ enables authenticated use of the private image.
618620
The ``-E`` option is required to preserve the user's existing environment variables upon ``sudo`` invocation - a priviledge escalation *required* to create Singularity containers via the ``build`` command.
619621

620622

623+
Remotely Bootstrapped and Built Containers
624+
------------------------------------------
625+
626+
Consider again :ref:`the definition file used the outset of the section above <sec:def_file_mandatory_headers_remotely_boostrapped>`:
627+
628+
.. code-block:: singularity
629+
630+
Bootstrap: docker
631+
From: godlovedc/lolcow
632+
633+
With two small adjustments to the Singularity ``build`` command, the Sylabs Cloud Remote Builder can be utilized:
634+
635+
636+
.. code-block:: none
637+
638+
$ singularity build --remote lolcow_rb_def.sif lolcow.def
639+
searching for available build agent......INFO: Starting build...
640+
Getting image source signatures
641+
Copying blob sha256:9fb6c798fa41e509b58bccc5c29654c3ff4648b608f5daa67c1aab6a7d02c118
642+
45.33 MiB / 45.33 MiB 0s
643+
Copying blob sha256:3b61febd4aefe982e0cb9c696d415137384d1a01052b50a85aae46439e15e49a
644+
848 B / 848 B 0s
645+
Copying blob sha256:9d99b9777eb02b8943c0e72d7a7baec5c782f8fd976825c9d3fb48b3101aacc2
646+
621 B / 621 B 0s
647+
Copying blob sha256:d010c8cf75d7eb5d2504d5ffa0d19696e8d745a457dd8d28ec6dd41d3763617e
648+
853 B / 853 B 0s
649+
Copying blob sha256:7fac07fb303e0589b9c23e6f49d5dc1ff9d6f3c8c88cabe768b430bdb47f03a9
650+
169 B / 169 B 0s
651+
Copying blob sha256:8e860504ff1ee5dc7953672d128ce1e4aa4d8e3716eb39fe710b849c64b20945
652+
53.75 MiB / 53.75 MiB 0s
653+
Copying config sha256:73d5b1025fbfa138f2cacf45bbf3f61f7de891559fa25b28ab365c7d9c3cbd82
654+
3.33 KiB / 3.33 KiB 0s
655+
Writing manifest to image destination
656+
Storing signatures
657+
INFO: Creating SIF file...
658+
INFO: Build complete: /tmp/image-994007654
659+
INFO: Now uploading /tmp/image-994007654 to the library
660+
87.94 MiB / 87.94 MiB 100.00% 41.76 MiB/s 2s
661+
INFO: Setting tag latest
662+
87.94 MiB / 87.94 MiB [===============================================================================] 100.00% 19.08 MiB/s 4s
663+
664+
In the above, ``--remote`` has been added as the ``build`` option that causes use of the Remote Builder service. A much more subtle change, however, is the *absence* of ``sudo`` ahead of ``singulartiy build``. Though subtle here, this absence is notable, as users can build containers via the Remote Builder with *escalated privileges*; in other words, steps in container creation that require ``root`` access *are* enabled via the Remote Builder even for users *without* admninistrative privileges locally.
665+
666+
In addition to the command-line support described above, The Sylabs Cloud Remote Builder also allows definition files to be copied and pasted for via its Graphical User Interface (GUI). After pasting a definition file, and having that file validated by the service, the build-centric part of the GUI appears as illustrated below. By clicking on the ``Build`` button, creation of the container is initiated.
667+
668+
.. image:: build_gui.png
669+
670+
Once the build process has been completed, the corresponding SIF File can be retrieved from the service - as shown below. A log file for the ``build`` process is provided by the GUI, and made available for download as a text file (not shown).
671+
672+
.. image:: build_output.png
673+
674+
A copy of the SIF file created by the service remains in the Sylabs Cloud Singularity Library as illustrated below.
675+
676+
.. image:: mysylabslibrary.png
677+
678+
The GUI that is the Sylabs Cloud is robust, responsive, intuitive and therefore extremely useful.
679+
680+
.. note::
681+
682+
The Sylabs Cloud is currently available as an Alpha Preview. In addition to the Singularity Library and Remote Builder, a Keystore service is also available. All three services make use of a *freemium* pricing model in supporting Singularity Community Edition. In contrast, all three services are included in SingularityPRO - an enterprise grade subscription for Singularity that is offered for a fee from Sylabs. For addtional details regarding the different offerings available for Singularity, please `consult the Sylabs website <https://www.sylabs.io/singularity/>`_.
683+
684+
621685
.. _sec:mandatory_headers_docker_locally_boostrapped_def_file:
622686

623687
Mandatory Headers: Locally Boostrapped

0 commit comments

Comments
 (0)