Skip to content

filoucool/Dockerized-ROS2-Jazzy

Repository files navigation

Dockerized ROS 2 Jazzy Setup

This repository contains the necessary scripts and configurations to build, run, and manage a Docker container for ROS 2 Jazzy on Ubuntu 24.04. Below is a detailed explanation of each script and its purpose.

Table of Contents

Prerequisites

  • Docker installed on your system.
  • A GitHub Personal Access Token with read:packages, write:packages, delete:packages, repo scopes stored in TOKEN.txt.

Usage

Build the Docker image:

./build.sh

Login to Docker using GitHub Personal Access Token:

./docker-login.sh

Run the Docker container:

./run.sh

Execute a shell inside the running container:

./docker-exec.sh

Logs the running container:

./docker-log.sh

Pulls de master ROS2 Jazzy Jalisco Image:

./pull-master-image.sh

Scripts / Files

build.sh

This script builds the Docker image for ROS 2 Jazzy using the Dockerfile. It also tags the image and pushes it to GitHub Container Registry (GHCR).

Parameters: git_personal_token (required): The GitHub Personal Access Token.

docker-compose.yaml

This file defines the Docker services, networks, and volumes for running multi-container Docker applications.

docker-exec.sh

This script is used to execute a shell inside the running Docker container.

Parameters: container_name (optional): The name of the Docker container to execute the shell in. Default is jazzy_container.

docker-log.sh

This script retrieves the logs from the running Docker container.

Parameters: container_name (optional): The name of the Docker container to get logs from. Default is jazzy_container.

docker-login.sh

This script logs into GitHub Container Registry (GHCR) using the Personal Access Token stored in TOKEN.txt.

Parameters: git_personal_token (required): The GitHub Personal Access Token.

Dockerfile

This file contains the instructions to build the Docker image for ROS 2 Jazzy.

pull-master-image.sh

This script pulls the master Docker image from GHCR.

Parameters: image_name (required): The name of the Docker image to pull.

run.sh

This script runs the Docker container with the necessary settings.

Parameters: container_name (optional): The name of the Docker container to run. Default is jazzy_container.

setup_ros2_jazzy.sh

This script initializes the ROS 2 Jazzy environment and sets up the workspace.

TOKEN.txt

This file contains the GitHub Personal Access Token used for authentication. Ensure this file is kept secure and not shared.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages