Skip to content

Commit

Permalink
Merge pull request #5 from kpedro88/apptainer
Browse files Browse the repository at this point in the history
Updates for Apptainer etc.
  • Loading branch information
kpedro88 authored Aug 23, 2023
2 parents 6e64e4e + 34f8fe1 commit 10bb4c0
Show file tree
Hide file tree
Showing 19 changed files with 185 additions and 93 deletions.
4 changes: 3 additions & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Alexx Perloff <alexx.stephen.perloff@cern.ch>
Alexx Perloff <alexx.stephen.perloff@cern.ch>
Clemens Lange <clemens.lange@cern.ch>
Kevin Pedro <pedrok@fnal.gov>
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docker/Singularity HATS@LPC
# Docker/Apptainer HATS@LPC

This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons.

Expand All @@ -23,7 +23,7 @@ For a live preview of the pages while editing, follow [this guide](https://carpe

Current maintainers of this lesson are

* [Alexx Perloff](mailto:alexx.stephen.perloff@cern.ch)
* [Kevin Pedro](mailto:pedrok@fnal.gov)

## Authors

Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ curriculum: "swc-gapminder"
# value of the variable below ("flavor") to get the schedule and installation
# instructions updated accordingly (valid values are 'r' or 'python').
# Note: this is only for Data Carpentry and SWC at this time.
flavor: "Docker/Singularity"
flavor: "Docker/Apptainer"

# Overall title for the Workshop.
# This variable is used to (optionally) add a title in the "jumbotron"
# (the grey box at the top of the page), and to the extra pages.
# Most workshops don't use extra pages. More information about extra
# pages are included in the README:
# https://github.com/carpentries/workshop-template#creating-extra-pages
title: "Docker/Singularity HATS@LPC"
title: "Docker/Apptainer HATS@LPC"


#------------------------------------------------------------
Expand Down
6 changes: 6 additions & 0 deletions _episodes/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ with the command line tools for them then most of Docker should seem somewhat na
[docker-tutorial]: https://docs.docker.com/get-started
[docker-containers]: https://www.docker.com/resources/what-container

### Licensing

The Docker Desktop application is free for personal use, but requires a [license](https://www.docker.com/pricing/faq/) for most organizational usage.

However, the underlying Docker engine is fully open source ([Apache 2.0 license](https://docs.docker.com/engine/#licensing)) and free for all use.

# Container Tool-chain Ecosystem

Docker is one among many container platforms which are governed by the [Open Container Initiative (OCI)](https://opencontainers.org/). Started by Docker and others in 2015, the OCI fosters industry standards and innovation among the various groups developing container environments. The OCI defines an image specification (image-spec) and a runtime specification (runtime-spec). These specifications provide for common ways to download, unpack, and run images/containers, allowing for greater interoperability among the containerization tool-chains. This way we can choose to work with Docker, Podman, Buildah, OpenShift, and others.
Expand Down
4 changes: 2 additions & 2 deletions _episodes/02-pulling-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Much like GitHub allows for web hosting and searching for code, the [Docker Hub]

<img align="center" src="../fig/High-level-overview-of-Docker-architecture.png" alt="High-level overview of the Docker architecture" style="width:600px">

While Docker Hub is maintained by Docker and is the defacto default registry for Docker images, it is not the only registry in existence. There are many registries, both private and public, in existence. For example, the GitLab software allows for a registry service to be setup alongside its Git and CI/CD management software. CERN's GitLab instance has such a registry available. See later episodes for more information on CERN's GitLab Docker image registry.
While Docker Hub is maintained by Docker and is the defacto default registry for Docker images, it is not the only registry in existence. There are many registries, both private and public, in existence. For example, the GitLab software allows for a registry service to be setup alongside its Git and CI/CD management software. CERN's GitLab instance has such a registry available. See later episodes for more information on CERN's GitLab Docker image registry. GitHub also now provides [its own container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) called GHCR, which uses the namespace `https://ghcr.io`.

# Pulling Images

Expand All @@ -37,7 +37,7 @@ To begin with we're going to [pull][docker-docs-pull] down the Docker image we'r
~~~bash
docker pull sl

#if you run into a premission error, use "sudo docker run ..." as a quick fix
# if you run into a permission error, use "sudo docker run ..." as a quick fix
# to fix this for the future, see https://docs.docker.com/install/linux/linux-postinstall/
~~~
{: .source}
Expand Down
2 changes: 1 addition & 1 deletion _episodes/03-running-containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ docker stop <CONTAINER ID> # or <NAME>
~~~
{: .source}
Stopping the container is a prerequisite for it's [removal]({{ page.root }}{% link _episodes/04-removal.md %}).
Stopping the container is a prerequisite for its [removal]({{ page.root }}{% link _episodes/04-removal.md %}).
[docker-docs-run]: https://docs.docker.com/engine/reference/run/
[docker-docs-run-detached]: https://docs.docker.com/engine/reference/run/#detached-vs-foreground
Expand Down
Loading

0 comments on commit 10bb4c0

Please sign in to comment.