Install¶

There are many different ways to install imds-mock. You can install the binary using either a supported package manager, manually, or by compiling the source yourself. Or you can pull a prebuilt image using Docker.

Installing the binary¶

Homebrew¶

To use Homebrew:

brew install purpleclay/tap/imds-mock

Apt¶

To install using the apt package manager:

echo 'deb [trusted=yes] https://fury.purpleclay.dev/apt/ /' | sudo tee /etc/apt/sources.list.d/purpleclay.list
sudo apt update
sudo apt install -y imds-mock

You may need to install the ca-certificates package if you encounter trust issues with regards to the gemfury certificate:

sudo apt update && sudo apt install -y ca-certificates

Yum¶

To install using the yum package manager:

echo '[purpleclay]
name=purpleclay
baseurl=https://fury.purpleclay.dev/yum/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/purpleclay.repo
sudo yum install -y imds-mock

Aur¶

To install from the aur using yay:

yay -S imds-mock-bin

Linux Packages¶

Download and manually install one of the .deb, .rpm or .apk packages from the Releases page.

sudo apt install imds-mock_*.deb

sudo yum localinstall imds-mock_*.rpm

sudo apk add --no-cache --allow-untrusted imds-mock_*.apk

Go Install¶

go install github.com/purpleclay/imds-mock@latest

Bash Script¶

To install the latest version using a bash script:

curl https://raw.githubusercontent.com/purpleclay/imds-mock/main/scripts/install | bash

A specific version can be downloaded by using the -v flag. By default the script uses sudo, which can be turned off by using the --no-sudo flag.

curl https://raw.githubusercontent.com/purpleclay/imds-mock/main/scripts/install | bash -s -- -v v0.1.0 --no-sudo

Manually¶

Binary downloads of imds-mock can be found on the Releases page. Unpack the imds-mock binary and add it to your PATH.

Compiling from source¶

imds-mock is written using Go 1.18+ and should be installed along with go-task, as it is preferred over using make.

Then clone the code from GitHub:

git clone https://github.com/purpleclay/imds-mock.git
cd imds-mock

Build imds-mock:

task

And check that everything works:

./imds-mock version

Running with Docker¶

You can run imds-mock directly from a docker image.

docker run -p 1338:1338 purpleclay/imds-mock

docker run -p 1338:1338 ghcr.io/purpleclay/imds-mock

Verifying Artefacts¶

All verification is carried out using cosign and it must be installed before proceeding.

Binaries¶

All binaries can be verified using the checksum file, which has been signed using cosign.

1. Download the checksum files that need to be verified:

curl -sL https://github.com/purpleclay/imds-mock/releases/download/v0.1.0/checksums.txt -O
curl -sL https://github.com/purpleclay/imds-mock/releases/download/v0.1.0/checksums.txt.sig -O
curl -sL https://github.com/purpleclay/imds-mock/releases/download/v0.1.0/checksums.txt.pem -O

1. Verify the signature of the checksum file:

cosign verify-blob --cert checksums.txt.pem --signature checksums.txt.sig checksums.txt

1. Download any release artefact and verify its SHA256 signature matches the entry within the checksum file:

sha256sum --ignore-missing -c checksums.txt

Docker¶

Docker images can be verified using cosign directly, as the signature will be embedded within the docker manifest.

COSIGN_EXPERIMENTAL=1 cosign verify purpleclay/imds-mock

COSIGN_EXPERIMENTAL=1 cosign verify ghcr.io/purpleclay/imds-mock