Skip to content

Commit

Permalink
Bumped version to 1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Madeeks committed May 25, 2022
1 parent cf6d94c commit 3e244ec
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 36 deletions.
4 changes: 1 addition & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]
## [1.5.0]

### Added

Expand All @@ -30,8 +30,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- zlib is no longer a dependency of Sarus itself, but remains a dependency of the Dropbear software used by the SSH hook
- Updated the build environment of the Sarus static standalone package to Alpine Linux 3.15

### Fixed

### Removed

- Removed the `insecureRegistries` parameter from `sarus.json` and the built-in support for insecure registries.
Expand Down
10 changes: 5 additions & 5 deletions doc/config/configuration_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,8 @@ Example configuration file
"securityChecks": true,
"OCIBundleDir": "/var/sarus/OCIBundleDir",
"rootfsFolder": "rootfs",
"prefixDir": "/opt/sarus/1.0.0",
"hooksDir": "/opt/sarus/1.0.0/etc/hooks.d",
"prefixDir": "/opt/sarus/1.5.0",
"hooksDir": "/opt/sarus/1.5.0/etc/hooks.d",
"tempDir": "/tmp",
"localRepositoryBaseDir": "/home",
"centralizedRepositoryDir": "/var/sarus/centralized_repository",
Expand Down Expand Up @@ -424,13 +424,13 @@ Example configuration file
"/opt"
]
},
"seccompProfile": "/opt/sarus/1.0.0/etc/seccomp/default.json",
"seccompProfile": "/opt/sarus/1.5.0/etc/seccomp/default.json",
"apparmorProfile": "sarus-default",
"selinuxLabel": "system_u:system_r:svirt_sarus_t:s0:c124,c675",
"selinuxMountLabel": "system_u:object_r:svirt_sarus_file_t:s0:c715,c811"
"containersPolicy": {
"path": "/opt/sarus/1.0.0/etc/policy.json",
"path": "/opt/sarus/1.5.0/etc/policy.json",
"enforce": false
},
"containersRegistries.dPath": "/opt/sarus/1.0.0/etc/registries.d"
"containersRegistries.dPath": "/opt/sarus/1.5.0/etc/registries.d"
}
2 changes: 1 addition & 1 deletion doc/overview/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This is accomplished by either:

* retrieving images from a remote registry
(e.g. `Docker Hub <https://hub.docker.com>`_) using the :program:`sarus pull`
command
command;

* loading images from local :program:`tar` archives using the
:program:`sarus load` command.
Expand Down
30 changes: 16 additions & 14 deletions doc/quickstart/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can install Sarus by following the steps below.
on the system, which is typically available through the ``squashfs-tools`` package.

As explained by the output of the script, you need to persistently add Sarus to your
``PATH``; one option is to add a line like "export PATH=/opt/sarus/bin:${PATH}" to
``PATH``; one option is to add a line like ``export PATH=/opt/sarus/bin:${PATH}`` to
your ``.bashrc`` file.

Also note that the configuration script will create a minimal working configuration.
Expand Down Expand Up @@ -92,28 +92,30 @@ Below is an example of some basic usage of Sarus:
.. code-block:: bash
$ sarus pull alpine
# image : index.docker.io/library/alpine/latest
# cache directory : "/home/user/.sarus/cache"
# image : index.docker.io/library/alpine:latest
# cache directory : "/home/docker/.sarus/cache"
# temp directory : "/tmp"
# images directory : "/home/user/.sarus/images"
> save image layers ...
> pulling : sha256:9d48c3bd43c520dc2784e868a780e976b207cbf493eaff8c6596eb871cbd9609
> completed : sha256:9d48c3bd43c520dc2784e868a780e976b207cbf493eaff8c6596eb871cbd9609
> expanding image layers ...
> extracting : "/home/user/.sarus/cache/sha256:9d48c3bd43c520dc2784e868a780e976b207cbf493eaff8c6596eb871cbd9609.tar"
> make squashfs image: "/home/user/.sarus/images/index.docker.io/library/alpine/latest.squashfs"
# images directory : "/home/docker/.sarus/images"
# image digest : sha256:4ff3ca91275773af45cb4b0834e12b7eb47d1c18f770a0b151381cd227f4c253
Getting image source signatures
Copying blob 2408cc74d12b done
Copying config a366738a18 done
Writing manifest to image destination
Storing signatures
> unpacking OCI image
> making squashfs image: "/home/docker/.sarus/images/index.docker.io/library/alpine/latest.squashfs"
$ sarus images
REPOSITORY TAG IMAGE ID CREATED SIZE SERVER
alpine latest 65e50dd72f89 2019-08-21T16:07:06 2.59MB index.docker.io
alpine latest a366738a1861 2022-05-25T09:19:59 2.59MB index.docker.io
$ sarus run alpine cat /etc/os-release
NAME="Alpine Linux"
ID=alpine
VERSION_ID=3.10.2
PRETTY_NAME="Alpine Linux v3.10"
VERSION_ID=3.16.0
PRETTY_NAME="Alpine Linux v3.16"
HOME_URL="https://alpinelinux.org/"
BUG_REPORT_URL="https://bugs.alpinelinux.org/"
BUG_REPORT_URL="https://gitlab.alpinelinux.org/alpine/aports/-/issues"
.. note::
You can refer to the section :doc:`User guides </user/index>`
Expand Down
25 changes: 13 additions & 12 deletions doc/user/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,11 @@ image.
Digests are useful to increase clarity and reproducibility in container workflows
by allowing to reference exact software stack versions.

As defined by the
`OCI Image Specification <https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests>`,
digests take the form of a string using the ``<algorithm>:<encoded>``
pattern. The ``algorithm`` portion indicates the cryptographic algorithm
used for the digest, while the ``encoded`` portion represents the result of
the hash function.
As `defined <https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests>`_
by the OCI Image Specification, digests take the form of a string using the
``<algorithm>:<encoded>`` pattern. The ``algorithm`` portion indicates the
cryptographic algorithm used for the digest, while the ``encoded`` portion
represents the result of the hash function.

To pull an image by digest, append the digest to the image name using ``@`` as
separator:
Expand Down Expand Up @@ -509,7 +508,7 @@ First, save an image to a tar archive using Docker *on your workstation*:
124M debian.tar
Then, transfer the archive to the HPC system and use the :program:`sarus load`
command, followed by the archive filename and the descriptor you want to give to
command, followed by the archive filename and the reference you want to give to
the Sarus image:
.. code-block:: bash
Expand Down Expand Up @@ -538,8 +537,8 @@ compute nodes. Should you run out of space while unpacking the image,
alternative unpacking directory.
As with images from 3rd party registries, to use or remove loaded images you
need to enter the image descriptor (repository[:tag]) as displayed by the
:program:`sarus images` command in the first two columns.
need to enter the image reference as displayed by the :program:`sarus images`
command in the first two columns (repository[:tag]).
Displaying image digests
------------------------
Expand Down Expand Up @@ -610,7 +609,7 @@ rmi` command:
REPOSITORY TAG IMAGE ID CREATED SIZE SERVER
To remove images pulled from 3rd party registries or images loaded from local
tar archives you need to enter the image descriptor (repository[:tag]) as
tar archives you need to enter the image reference as
displayed by the :program:`sarus images` command:
.. code-block:: bash
Expand Down Expand Up @@ -764,8 +763,10 @@ The following example demonstrates the use of a custom read-only bind mount.
use the FUSE option ``allow_root`` when creating the mount point.
For example, when creating an `EncFS <https://vgough.github.io/encfs/>`_ filesystem:
``$ encfs -o allow_root --nocache $PWD/encfs.enc/ /tmp/encfs.dec/``
``$ sarus run -t --mount=type=bind,src=/tmp/encfs.dec,dst=/var/tmp/encfs ubuntu ls -l /var/tmp``
.. code-block:: bash
$ encfs -o allow_root --nocache $PWD/encfs.enc/ /tmp/encfs.dec/
$ sarus run -t --mount=type=bind,src=/tmp/encfs.dec,dst=/var/tmp/encfs ubuntu ls -l /var/tmp
It is possible to pass ``allow_root`` if the option ``user_allow_other`` is defined in
``/etc/fuse.conf``, as stated in the `FUSE manpage <https://man7.org/linux/man-pages/man8/fuse.8.html>`_.
Expand Down
3 changes: 2 additions & 1 deletion spack/packages/sarus/package.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ class Sarus(CMakePackage):
"""Sarus is an OCI-compliant container engine for HPC systems."""

homepage = "https://github.com/eth-cscs/sarus"
url = "https://github.com/eth-cscs/sarus/archive/1.4.2.tar.gz"
url = "https://github.com/eth-cscs/sarus/archive/1.5.0.tar.gz"
git = "https://github.com/eth-cscs/sarus.git"

version('develop', branch='develop', submodules=True)
version('master', branch='master', submodules=True)
version("1.5.0", tag="1.5.0", submodules=True)
version("1.4.2", commit="13af2723b5c1cd1890d056af715946596f7ff2c6")
version("1.4.1", commit="a73f6ca9cafb768f3132cfcef8c826af34eeff94")
version("1.4.0", commit="c6190faf45d5e0ff5348c70c2d4b1e49b2e01039")
Expand Down

0 comments on commit 3e244ec

Please sign in to comment.