Docker for R users

.title[
# Docker for R users
]
.subtitle[
## 
]
.author[
### Nicolas CASAJUS .inst[nicolas.casajus at fondationbiodiversite.fr]
]
.date[
### .inst[Jeudi 30 novembre 2022]
]

---

## Motivations

---

## Motivations

---

## Motivations

---

## Docker en bref

&nbsp;Logiciel open source permettant de :

- empaqueter une application avec toutes ses dépendances système
- partager facilement un environnement de travail complet
- déployer rapidement une application en production

---

## Docker en bref

&nbsp;Un conteneur est _isolé_ du système hôte.

permet donc de :

- tester des choses sans crainte d'endommager son système hôte
- utiliser différentes versions d'une librairie, d'un logiciel, etc.
- garder son système hôte propre, en installant tout sur Docker

> Idéal pour créer un environnement de developpement

---

## Virtualisation _vs._ Conteneurisation

![](img/versus-2.png)

&nbsp;**Avantages de la conteneurisation :**

- Extrêmement léger (exploitation du noyau Linux)
- Utilisation réduite de ressources (RAM, CPU)
- Déploiement simple et instantané

---

## La notion d'Image

> Tout **conteneur** est basé sur une **image** que l'on crée soi-même ou qu'on récupère depuis un site d'archivage

&nbsp;Une **image ** est une sorte de conteneur figé : c'est un template **fixe** (une recette de cuisine) à partir duquel on créera un
ou des conteneurs. Une image est `immuable`.

&nbsp;Un **conteneur ** est donc une instance (exécution) d'une image qui pourra être utilisée/modifiée une fois créée

---

## Docker Hub

Site d'archivage officiel : [**Docker Hub**](https://hub.docker.com)

![](img/docker-hub.png)

---

## Rocker project

Site officiel : [**https://rocker-project.org**](https://rocker-project.org/)

![](img/rocker.png)

---

## Rocker project

Site officiel : [**https://rocker-project.org**](https://rocker-project.org/)

![](img/rocker-img.png)

---

## Installation de Docker

[**https://docs.docker.com/get-docker**](https://docs.docker.com/get-docker/)

![](img/docker-desktop.png)

---

## Mode Développement

---

## Création d'un conteneur - Dev

![](img/workflow-2.png)

---

## Création d'un conteneur - Dev

![](img/workflow-1.png)

---

## Création d'un conteneur - Dev

- Téléchargement de l'image RStudio [`rocker/rstudio`](https://hub.docker.com/r/rocker/rstudio)

```sh
docker pull rocker/rstudio
```

- Téléchargement de l'image avec contrôle de la version de **(meilleure reproductibilité)**

```sh
docker pull rocker/rstudio:4.2.2
```

- Liste des images locales

```sh
docker images

# REPOSITORY                    TAG        IMAGE ID       CREATED       SIZE
# rocker/rstudio                4.1.1      d8a2fe0cc0ff   9 days ago    1.92GB
# rocker/rstudio                4.2.2      d110bab4d154   6 days ago    1.79GB
# rocker/rstudio                latest     d110bab4d154   6 days ago    1.79GB
```

---

## Création d'un conteneur - Dev

- Création d'un conteneur

```sh
docker run --rm                        # Delete the stopped container 
           -d                          # Daemon mode (run in background)
           -p 8787:8787                # Port mapping HOST:CONTAINER
           -e PASSWORD=yourpassword    # Password required (login: rstudio)
           rocker/rstudio:4.2.2        # Name of the image
```

- Sans authentification

```sh
docker run --rm -dp 8787:8787 -e DISABLE_AUTH=true rocker/rstudio:4.2.2
```

---

## Création d'un conteneur - Dev

- Dans un navigateur Web, visitez l'URL: <http://localhost:8787>

---

## Création d'un conteneur - Dev

- Dans un navigateur Web, visitez l'URL: <http://localhost:8787>

---

## Gestion des conteneurs

- Liste des containeurs

```sh
docker ps

# CONTAINER ID   IMAGE                  COMMAND   CREATED         STATUS         PORTS                    NAMES
# baba86ace27a   rocker/rstudio:4.2.2   "/init"   7 seconds ago   Up 6 seconds   0.0.0.0:8787->8787/tcp   lucid_dubinsky
```

- Arrêt d'un containeur

```sh
docker stop baba86ace27a
```

- Suppression d'un containeur

```sh
docker rm baba86ace27a
```

---

## Quelques commandes utiles

```sh
## Images ----

docker search {{ IMAGE }}                              # Search for an image
docker pull {{ IMAGE }}                                # Download an image
docker pull {{ IMAGE }}:{{ TAG }}                      # ... with a specific version
docker images                                          # List local images
docker rmi {{ IMAGE }}:{{ TAG }}                       # Delete a local image

## Containers ----

docker run -it {{ IMAGE }}:{{ TAG }}                   # Start a new container
docker run -it --name "debbie" {{ IMAGE }}:{{ TAG }}   # ... with a custom name
docker run --rm -it {{ IMAGE }}:{{ TAG }}              # Delete after stopped
docker ps                                              # List containers
docker ps -a                                           # List containers (stopped included)
docker stop {{ CONTAINER }}                            # Stop a container
docker start {{ CONTAINER }}                           # Re(start) a container
docker rm {{ CONTAINER }}                              # Delete a container
docker stats                                           # Containers statistics
```

---

## Persistance

---

## Persistance des données

Un conteneur est **isolé** et n'est **pas persistant** : 
tout ce qui est ajouté à l'intérieur (fichiers, logiciels, etc.) n'est pas 
accessible, par défaut, depuis le système hôte. Et lorsque celui-ci est détruit,
tout est perdu.

- Comment récupérer des données créées à l'intérieur ?
  - Comment envoyer des données dans le conteneur ?

&nbsp; Pour les données, on créera des **volumes**

&nbsp; Pour les logiciels, on créera une nouvelle **image**

---

## Volumes de persistance

Un volume est  un pont entre un dossier du conteneur et un dossier
de la machine hôte.

&nbsp;
On parle de **volumes mapping** : tout fichier/dossier créé dans le volume de la machine sera accessible par le conteneur via le volume lié. Et vice-versa.

Le volume local (celui de la machine hôte) sera persistant même après
la suppression du conteneur (et donc de son volume persistant).

---

## Volumes de persistance

Pour créer un volume, il faut ajouter le drapeau `--volume` (ou `-v`) à la
commande `docker run`.

```sh
-v dossier_local:dossier_conteneur
```

&nbsp;
Les volumes mentionnés **doivent exister** tant sur la machine locale que dans le conteneur
et il faut mentionner le **chemin absolu** vers ces dossiers.

Un exemple avec `rocker/rstudio:4.2.2`

```sh
docker run --rm                                   # Delete container after stopped
           -d                                     # Run in background
           - p 8787:8787                          # Port mapping
           -e DISABLE_AUTH=true                   # No password required
           -v ~/Documents/project:/home/rstudio   # Volume mapping
           rocker/rstudio:4.2.2                   # Image
```

---

## Mode production

---

## Mode production

**Objectif :** partager les `données`,
le `code`, les `résultats` et l'`environnement` de développement.

&nbsp;
Création d'une **nouvelle image** spécifique à notre projet

---

## Dockerfile

&nbsp;Le `Dockerfile` est la recette qui va
créer une nouvelle image

C'est un simple fichier texte (**sans extension**) qui fournit une suite d'instructions amenant
à la construction de la future image. Il doit être placé à la racine du projet.

Il est rare de construire une image _from scratch_ : on se base très souvent
sur une (seule) image existante (processus incrémental).

---

## Dockerfile

Exemple basique

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Copy local project ----
COPY . /home/rstudio/

## Set working directory ----
WORKDIR /home/rstudio/
```

---

## Dockerfile

Exemple avec ajout d'outils

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Copy local project ----
COPY . /home/rstudio/

## Set working directory ----
WORKDIR /home/rstudio/

## Install system dependencies ----
RUN sudo apt update -yq
RUN sudo apt install -yq --no-install-recommends htop
```

---

## Dockerfile

Exemple avec ajout d'outils

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Copy local project ----
COPY . /home/rstudio/

## Set working directory ----
WORKDIR /home/rstudio/

## Install system dependencies ----
RUN sudo apt update -yq \
 && sudo apt install -yq --no-install-recommends htop
```

---

## Dockerfile

Exemple avec ajout d'outils

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Copy local project ----
COPY . /home/rstudio/

## Set working directory ----
WORKDIR /home/rstudio/

## Install system dependencies ----
RUN sudo apt update -yq \
 && sudo apt install -yq --no-install-recommends htop \
 && sudo apt clean all \
 && sudo apt purge \
 && sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
```

---

## Dockerfile

Exemple avec installation de packages

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Install system dependencies ----
RUN sudo apt update -yq \
 && sudo apt install -yq --no-install-recommends libxml2-dev \
 && sudo apt clean all \
 && sudo apt purge \
 && sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

## Copy local project ----
ENV FOLDER="/home/rstudio/"
COPY . $FOLDER
RUN chown -R rstudio:rstudio $FOLDER

## Set working directory ----
WORKDIR $FOLDER

## Install R packages ----
RUN R -e "install.packages('remotes', repos = c(CRAN = 'https://cloud.r-project.org'))" \
 && R -e "remotes::install_deps()"
```

---

## Dockerfile

Exemple avec installation de packages - `renv`

```docker
FROM rocker/rstudio:4.2.2

MAINTAINER Nicolas Casajus <nicolas.casajus@fondationbiodiversite.fr>

## Copy local project ----
ENV FOLDER="/home/rstudio/"
COPY . $FOLDER
RUN chown -R rstudio:rstudio $FOLDER

## Set working directory ----
WORKDIR $FOLDER

## Install R packages ----
ENV RENV_VERSION 0.16.0
RUN R -e "install.packages('remotes', repos = c(CRAN = 'https://cloud.r-project.org'))" \
 && R -e "remotes::install_github('rstudio/renv@${RENV_VERSION}')" \
 && sudo -u rstudio R -e "renv::restore()"
```

---

## Le .dockerignore

&nbsp;Tout comme 
et , est capable d'ignorer certains
fichiers/dossiers lors de la construction d'une image grâce à un `.dockerignore`

Cela est particulièrement important lorsque la clause `COPY` copie des dossiers entiers.

Exemple de contenu d'un `.dockerignore`

```docker
# macOS files ----
.DS_Store

# Large files ----
.git
renv/library
renv/local

# History files ----
.Rhistory
.Rapp.history

# Session Data files ----
.RData
.Ruserdata

# RStudio files ----
*.Rproj
.Rproj.user/
```

---

## Build de l'image

&nbsp;
Nous sommes fin prêts pour créer notre image à partir du `Dockerfile`.

```sh
docker build -t "demo.docker" .
```

&nbsp;Utilisation de la nouvelle image

```docker
docker run --rm -dp 8787:8787 -e DISABLE_AUTH=true demo.docker
```

---

## Utiliation de rcompendium

Intégration de Docker à un compendium

```r
rcompendium::new_compendium(dockerfile = TRUE)
rcompendium::new_compendium(dockerfile = TRUE, renv = TRUE)
rcompendium::add_dockerfile()
```

Exemple : https://github.com/ahasverus/demo.compendium