-
Notifications
You must be signed in to change notification settings - Fork 389
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docs): update getting started instructions #2681
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,15 +23,39 @@ The easiest way to start experimenting with Tetragon is to run it via Docker | |
using the released container images. | ||
|
||
```shell | ||
docker run --name tetragon-container --rm --pull always \ | ||
docker run -d --name tetragon --rm --pull always \ | ||
--pid=host --cgroupns=host --privileged \ | ||
-v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ | ||
quay.io/cilium/tetragon-ci:latest | ||
quay.io/cilium/tetragon:latest | ||
``` | ||
|
||
This will start Tetragon in a privileged container. Priviliges are required | ||
to load and attach BPF programs. See Installation section for more details. | ||
This will start Tetragon in a privileged container running in the background. | ||
Running Tetragon as a privileged container is required to load and attach BPF | ||
programs. See the [Installation and Configuration]({{< ref "/docs/installation" >}}) | ||
section for more details. | ||
|
||
## What's Next | ||
## Run demo application | ||
|
||
To explore Tetragon it is helpful to have a sample workload. You can use Cilium’s | ||
demo application with [this Docker Compose file](https://github.com/cilium/tetragon/blob/main/examples/quickstart/docker-compose.yaml), | ||
but any workload would work equally well: | ||
|
||
```shell | ||
curl -LO https://github.com/cilium/tetragon/raw/main/examples/quickstart/docker-compose.yaml | ||
docker compose -f docker-compose.yaml up -d | ||
``` | ||
|
||
You can use `docker container ls` to verify that the containers are up and | ||
running. It might take a short amount of time for the container images to | ||
download. | ||
|
||
```shell | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. forgot to add to remove shell There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So you want no language designator here, just the backticks? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
cace79752d94 quay.io/cilium/json-mock:v1.3.8 "bash /run.sh" 34 seconds ago Up 33 seconds starwars-xwing-1 | ||
4f8422b43b5b quay.io/cilium/json-mock:v1.3.8 "bash /run.sh" 34 seconds ago Up 33 seconds starwars-tiefighter-1 | ||
7b60618ca8bd quay.io/cilium/starwars:v2.1 "/starwars-docker --…" 34 seconds ago Up 33 seconds 0.0.0.0:8080->80/tcp, :::8080->80/tcp starwars-deathstar-1 | ||
``` | ||
|
||
## What's next | ||
|
||
Check for [execution events]({{< ref "/docs/getting-started/execution" >}}). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: starwars | ||
networks: | ||
galaxyfaraway: | ||
services: | ||
deathstar: | ||
hostname: deathstar | ||
image: quay.io/cilium/starwars:v2.1 | ||
networks: | ||
- galaxyfaraway | ||
ports: | ||
- 8080:80 | ||
restart: always | ||
tiefighter: | ||
hostname: tiefighter | ||
image: quay.io/cilium/json-mock:v1.3.8 | ||
networks: | ||
- galaxyfaraway | ||
restart: always | ||
xwing: | ||
hostname: xwing | ||
image: quay.io/cilium/json-mock:v1.3.8 | ||
networks: | ||
- galaxyfaraway | ||
restart: always |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
btw why did we change that? I think running interactively was fine to get the logs and everything.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This made things a bit more similar between Docker and Kubernetes.