Skip to content

Commit

Permalink
chore(docs): update aarch64 references to latest in docs
Browse files Browse the repository at this point in the history
commit: d2b8dbe (main), cherry-pick
  • Loading branch information
rafaeldtinoco committed Oct 18, 2023
1 parent 59ee33d commit a775700
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 23 deletions.
17 changes: 5 additions & 12 deletions docs/contributing/building/containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,17 @@ release):
latest daily built container images (based on the version currently being
developed).

- **aquasec/tracee:dev** (arch: amd64)

Multiple architecture tags:

- **aquasec/tracee:x86_64-dev**
- **aquasec/tracee:aarch64-dev**
- **aquasec/tracee:dev**

2. **RELEASE (official versions) container images:**

Preferable aliases for latest released images (per arch)):
Preferable alias for latest released image:

- **aquasec/tracee:x86_64**
- **aquasec/tracee:aarch64**
- **aquasec/tracee:latest**

And the container images for each released version of Tracee (per arch):
And the container images for each released version of Tracee:

- **aquasec/tracee:x86_64-VERSION**
- **aquasec/tracee:aarch64-VERSION**
- **aquasec/tracee:VERSION**

## Generating Tracee Container Images

Expand Down
23 changes: 12 additions & 11 deletions docs/getting-started/docker-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ This section details how you can run Tracee through a container image.

## Prerequisites

Please ensure that Docker or another container runtime is working on your machine.
Please ensure that Docker or another container runtime is working on your machine.

## Run the Tracee container images

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 \
Expand All @@ -20,45 +21,45 @@ docker run \
aquasec/tracee:latest
```

### Steps to run the Tracee container image on arm64:
### 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
* [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 [email protected]:aquasecurity/tracee.git

cd tracee
```

Next, use Vagrant to start a Parallels VM:
```

```console
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:
Now, it is possible to run the Tracee Container image:

```console
docker run \
--name tracee --rm -it \
--pid=host --cgroupns=host --privileged \
-v /etc/os-release:/etc/os-release-host:ro \
aquasec/tracee:aarch64
aquasec/tracee:latest
```

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).
Binary file removed docs/images/docker-arm64.png
Binary file not shown.

0 comments on commit a775700

Please sign in to comment.