USER_GUIDE.md

User guide

Known working environments

The following setups have been known to work on the following Operating Systems.

Please feel free to extend the list via a Pull Request if you have verified the demo on another setup.

Linux

• Using docker-ce
• Using Rancher Desktop

MacOS (Apple Silicon and Intel)

• Using Colima
• Using Rancher Desktop
• Using Docker Desktop

Windows

• Using Rancher Desktop
• Using Docker Desktop

Common actions

This section contains commonly used commands used to interact with the demo.

Preface

All docker compose commands should be run from the folder where the docker-compose.yaml file is located. Otherwise you will need to use the -f path/to/my/docker-compose.yaml argument to all of the documented docker compose commands.

Updating the containers to the latest version

If you are using the default latest tag inside the docker compose project, then you can update to the latest version using:

docker compose up -d

Stopping the demo

The demo can be stopped by using:

docker compose down

Removing everything

Once you are done with the demo, you can clean up all the resources (including the volumes) using:

docker compose down -v

Get logs

Main device

Since the main device is running the services under systemd, you will need to execute a command inside the container.

docker compose exec tedge journalctl -f -u "c8y-*" -u "tedge-*" -n 100

Or you can get a single service using:

docker compose exec tedge journalctl -f -u "tedge-mapper-c8y" -n 100

Child devices

The child devices are single process containers so you can use the standard docker compose logs command.

docker compose logs child01 -f --tail 100
docker compose logs child02 -f --tail 100