containers

Please try as best as you can to not setup RobôCIn projects on your own computer, try to use RoboCIn provided docker images if it exists or work with your team to create a new image.

This repo contains the docker image definitions for all RobôCIn officially supported images. There are two types of images here:

• Devcontainer: Used for creating devcontainers and local testing.
• Runtime: Exclusive to deployment in our robots, with size optimization.

Try to use devcontainer docker images on your day-to-day work. For a complete list of existing images, please refer to RobôCIn's Docker Hub.

Prerequisites

• Docker (link)
• Visual Studio Code (link)
• Dev Containers (extension, site, spec)

How to use?

Devcontainers

For development environments, we use devcontainers.

1) Create .devcontainer folder + devcontainer.json file.

your-repo/
└── .devcontainer/
    └── devcontainer.json

2) Target your desired image on devcontainer.json.

The devcontainer extension is managed via the devcontainer.json file. All customizations of your container should be done via this file.

{
	"name": "Example devcontainer",
	"image": "robocin/image/from/dockerhub:version",
	"postCreateCommand": "echo 'Hello from Devcontainer'",
	"containerEnv": {
		"DISPLAY": "${localEnv:DISPLAY}" // Enable GUI on host.
	},
	"customizations": {
		"vscode": {
			"extensions": [
				// Live Share
				"ms-vsliveshare.vsliveshare",
				// C/C++ Extension Pack
				"ms-vscode.cpptools-extension-pack",
				// Python
				"ms-python.python"
			],
			"settings": {
          // Add your custom settings here.
          // See: https://containers.dev/implementors/json_reference/
			}
		}
	}
}

For more details, see devcontainers official specification.

3) Run the devcontainer

Make sure you have Visual Studio Code opened in your project root folder or where your .devcontainer folder exists.

On Visual Studio Code search bar, run: > Dev Containers: Reopen in Container.

Detailed instructions on extension overview.

Runtime

[todo]