Docker

In this guide, we will walk you through the use cases of integrating Runme and Docker.

Prerequisites

To get started, ensure you have the following:

• Clone the repository: We created a notebook repository containing all the instructions and commands required for this guide. To clone this repo and go into the folder for this guide, run the command below

git clone --branch T-doc-notebook https://github.com/stateful/blog-examples.git
cd blog-examples/docker-notebook

• Install Runme: Install the Runme extension on VS Code and set it as your default Markdown viewer.
• Required Packages: Run the command below to install the required packages for this guide.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install docker

Example Use Case

In this section, we will walk you through how you can perform various docker commands from your Runme cell and utilize the several features of Runme for more effective workflow execution. This use case focuses on a simple Python app named my-test-app.

Automating Docker Build in Runme

Building an image in Docker enables you to create one from a set of instructions defined in a Dockerfile. These instructions specify the steps needed to assemble the necessary configurations for the image.

docker build is the command to build a Docker image from a Dockerfile.

To build your image from a Dockerfile, use the command below

docker build -t <image_name>:<tag> <path_to_dockerfile>

Example:

docker build -t my-test-app .

Run a Docker Image

You can run a Docker image and customize your container's interaction with the host system and external networks. Here are some commands to do this:

Docker Run

Running a container in Docker allows you to create an instance of a Docker image as an isolated and lightweight environment. This instance, a container, condenses an application along with its dependencies and configurations. When a container is run, it executes the commands specified in its Dockerfile.

docker run is the command to create and start a new container based on a Docker image.

To run a Docker image, use the command below

docker run <image_name>

Example:

docker run nginx

Run Container Using Runme Environment Variable

You can run your container using the Runme environment variable. This will prompt you to input a variable you want executed along with your command. To see how this works, run the command below in the Runme cell.

export CONTAINER_ID=$(docker run -d -p 80:5000 nginx)
echo "Starting container ${CONTAINER_ID}"

Now you can open the app using the command below

open http://localhost:8000

Volume Mount

Volume mount maps directories or files on the host machine to directories inside the container, providing data persistence and allowing for easy file access.

docker run -v <host_directory>:<container_directory> <image_name>

Example:

docker run -d -p 8010:8010 -v ${PWD}/nginx.conf:/etc/nginx/nginx.conf:ro nginx

Port Mapping

Port Mapping maps ports on the host machine to ports exposed by the container, allowing external access to services inside the container.

To do this, use the command below:

docker run -p <host_port>:<container_port> <image_name>

Example:

docker run -p 80:5000 nginx

If a cell block takes a lot of time to execute, you can also run such a cell in the background using Runme’s background mode. This will enable you to save time and move on to other tasks while your previous task is still running.

Sleep a Container

You can instruct Docker to make a container sleep.

docker run $CONTAINER_ID sleep 5

When you run the command docker run $CONTAINER_ID sleep 5, you instruct Docker to create and start a new container from the specified image and then run the sleep command inside the container for 5 seconds.

Manage Docker Images

There are several commands which can enable you to manage your Docker image. Here are some of these commands:

List all Images

It is possible to list all the images currently available on your Docker host. To do this, run the command below:

docker images

Remove an Image

If you would love to remove an image from your local Docker host, run the command below:

docker rmi nginx

This command will try to remove the Docker image with the name nginx.

Replace nginx with the image of your choice.

Container Management in Docker Within the Runme Cell

With Docker within Runme, you can easily manage your container's activities inside your Runme cell and Markdown file. Container management entails organizing and supervising containers to ensure smooth operation and optimal performance.

In this section, we explore several commands for managing your containers.

Start a container

Starting a container is the same as running a container. To start a container, use the command below:

docker run <image_name>

Example:

docker run nginx

List Containers

To get a list of all running containers, use the command below:

docker ps

Example:

If you would love to get a list of all containers (including stopped ones), use the command below:

docker ps -a

Example:

Container Logs

In Docker, container logs provide you with the recorded output generated by a Docker container during its execution. They are useful for troubleshooting, monitoring, auditing, and debugging.

To view the logs of a container, use the command below:

docker logs <container_id or container_name>

Example:

docker logs $CONTAINER_ID

You can also use the inspect command to retrieve detailed information about your container or docker image. To do this, run the command below

docker inspect $CONTAINER_ID

Execute a Command Inside a Container

Executing a command inside a Docker container means running a specific command within the container. This allows you to interact with the containerized environment without interactively entering the container.

Runme makes this easy through the use of environment variables prompts. Runme’s environment variable prompts allow you to input values directly within your notebook environment and store them easily.

To execute a command inside a container leveraging Runme’s environment variable prompt, run the command below:

export CONTAINER_ID_TEST=$(docker ps --filter "ancestor=nginx" --format "{{.ID}}")
echo "here is your container id ${CONTAINER_ID_TEST}"

docker exec -it $CONTAINER_ID_TEST bash

Example:

Stop a Running Container

To stop a running container, use the command below:

docker stop <container_id or container_name>

Example:

docker stop $CONTAINER_ID_TEST

Remove a Container

To remove a container, run the command below:

docker rm <container_id or container_name>

Example:

docker rm $CONTAINER_ID_TEST

Docker compose

Docker Compose is a tool for defining and running multi-container Docker applications. It uses YAML files to configure the application’s services and performs the creation and setup process for all the containers.

For this example, we created a YAML file to demonstrate how docker-compose works. If your YAML file is in a different directory from your current working directory, you can easily change your Runme cell to the directory where the file exists and then run the docker-compose command.

How to Manage Docker Containers using Runme Run Cells by Section Feature

With Runme, you can efficiently manage your Docker containers by running your commands by section. Rather than running each cell individually, you run them by section. The video below provides a visual illustration of how this feature works.

In this guide, we covered the basics of running Docker commands in Runme.

Runme has several features that make it a choice platform for integrating and using Docker. Some key features of Runme include

• The background mode makes it possible to run commands in the background.
• Autosave feature, which provides you with the opportunity to auto-save your outputs without manual intervention.
• You can run your Markdown file by cells, an entire document, or sections.

To explore more features of Runme and learn how they can be utilized in your workflows, visit our documentation page.