diff --git a/docs/getting-started/docker-quickstart.md b/docs/getting-started/docker-quickstart.md index 2c49f1014851..b096dd5d4b46 100644 --- a/docs/getting-started/docker-quickstart.md +++ b/docs/getting-started/docker-quickstart.md @@ -10,7 +10,7 @@ Please ensure that Docker or another container runtime is working on your machin All of the Tracee container images are stored in a public registry on [Docker Hub.](https://hub.docker.com/r/aquasec/tracee) You can easily start experimenting with Tracee using the Docker image. -**On x86 architecture, please run the following command:** +### On x86 architecture, please run the following command: ```console docker run \ @@ -20,8 +20,35 @@ docker run \ aquasec/tracee:latest ``` -**If you are on arm64 architecture, you will need to replace the container image tag to `aarch64`:** +### Steps to run the Tracee container image on arm64: +There are a few more steps involved in running Tracee through a container image on arm64 (M1). + +Prerequisites: + +* [Vagrant CLI](https://developer.hashicorp.com/vagrant/downloads) installed +* [Parallels Pro](https://www.parallels.com/uk/products/desktop/pro/) installed + +First, clone the Tracee Git repository and move into the root directory: +```console +git clone git@github.com:aquasecurity/tracee.git + +cd tracee +``` + +Next, use Vagrant to start a Parallels VM: +``` +vagrant up +``` + +This will use the [Vagrantfile](https://github.com/aquasecurity/tracee/blob/main/Vagrantfile) in the root of the Tracee directory. + +Lastly, ssh into the created VM: +```console +vagrant ssh +``` + +Now, it is possible to run the Tracee Container image, using the `aarch64` tag: ```console docker run \ --name tracee --rm -it \ @@ -30,4 +57,8 @@ docker run \ aquasec/tracee:aarch64 ``` +The Tracee output should be similar to the following screenshot: + +![Tracee Container Image output in Vragrant on arm64](../images/docker-arm64.png) + To learn how to install Tracee in a production environment, [check out the Kubernetes guide](./kubernetes-quickstart). diff --git a/docs/images/docker-arm64.png b/docs/images/docker-arm64.png new file mode 100644 index 000000000000..2a77f40c2848 Binary files /dev/null and b/docs/images/docker-arm64.png differ