Getting started#

The scotty tool relies on a docker container to embed as much as possible the software dependencies it relies on. As a consequence, you will need to make sure to install Docker<https://www.docker.com/> on your system and make sure your user has rights to use docker. The scotty tool also needs OpenSSL<https://www.openssl.org/> to function properly.

On Ubuntu 20.04 platforms, they can be installed with following commands:

$ sudo apt install docker.io openssl
$ sudo gpasswd -a ${USER} docker

In addition, if you plan to use QEMU images, it is advised to make sure the current user is able to use KVM, having write permissions to /dev/kvm. On Ubuntu 20.04, this can be done by adding your user to the kvm group, with the following command:

$ sudo gpasswd -a ${USER} kvm

Note

After adding your user to the docker or kvm group with the gpasswd command, you will need to open a new session to apply your new privileges.

Installing the scotty tool can be easily done with pip

pip install --user avnet-scotty

upgrading an existing installation can be done with

pip install --user --upgrade avnet-scotty

Important

On Ubuntu 20.04 you might be affected by this bug, so ${HOME}/.local/bin is not part of the standard search path.

This can be fixed by running

echo 'export PATH="$(systemd-path user-binaries):$PATH"' >> ~/.bashrc

Note

A reboot is required for the setting to become effective.

You can also install scotty with

sudo pip install avnet-scotty

but that requires you to have sudo rights on your system.

Alternatively, the current development version can be obtained by cloning avnet-embedded/simplecore-tools.

Potential pitfall

If you are facing the following issue

Error response from daemon: Head "https://ghcr.io/v2/avnet-embedded/scotty/manifests/2023.10": denied: denied
scotty failed on line 157

please run

docker logout ghcr.io

on your computer.

To fix it permanently, please create a personal access token, as described at Github container registry (GHCR) with at least read:packages permissions.

And re-login to docker using

docker login ghcr.io

Github preparations#

Before we can start to build, we need to make sure that Github allows us to connect via ssh.

See this video on how to do it

Please also keep in mind that most of the repositories are only available for users being part of avnet-embedded GitHub organization.

Please reach out to support to request access.