Skip to content
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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 22, 2024
Merged

fix(docs): update getting started instructions #2681

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2e03e6
fix(docs): update getting started instructions
scottslowe Jul 16, 2024
ce2009d
fix: update execution monitoring section of docs
scottslowe Jul 18, 2024
bc4204e
fix: update execution events section
scottslowe Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 42 additions & 8 deletions docs/content/en/docs/getting-started/execution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,46 @@ can then observe all executions in the system.

The following command can be used to observe exec events.

{{< tabpane lang=shell >}}
{{< tab Kubernetes >}}
{{< tabpane text=true >}}
{{% tab Kubernetes %}}

For a single node Kubernetes cluster, you can target the Tetragon DaemonSet with a `kubectl exec` command:

```shell
kubectl exec -ti -n kube-system ds/tetragon -c tetragon -- tetra getevents -o compact --pods xwing
{{< /tab >}}
{{< tab Docker >}}
```

In a cluster with multiple nodes, you will first need to find the node where
the workload is running. For example, when using Cilium's [demo application](https://docs.cilium.io/en/stable/gettingstarted/demo/),
this command will show on which node the "xwing" Pod is running.

```shell
kubectl get pod xwing -o jsonpath='{.spec.nodeName}'
```

You would then find the Tetragon Pod on the same node; this command returns a
list of Tetragon Pods and the name of the Kubernetes node on which they are
running.

```shell
kubectl -n kube-system get pods -o custom-columns=NAME:.metadata.name,NODE:.spec.nodeName | grep <name-of-node-with-workload>
```

Once you have the identified the matching Pod, then target it with a `kubectl
exec` to run the `tetra getevents` command.

```shell
kubectl exec -ti -n kube-system po/<pod-name> -c tetragon -- tetra getevents -o compact --pods xwing
```

{{% /tab %}}
{{% tab Docker %}}

```shell
docker exec tetragon-container tetra getevents -o compact
{{< /tab >}}
```

{{% /tab %}}
{{< /tabpane >}}

This will print a compact form of the exec logs. For an example we do the following
Expand All @@ -47,9 +80,10 @@ following output.
💥 exit default/xwing /usr/bin/curl https://ebpf.io/applications/#tetragon 60
```

The compact exec event contains the event type, the pod name, the binary and the args. The exit event will include the return code, in the case of curl `60` above.
The compact exec event contains the event type, the pod name, the binary and the
args. The exit event will include the return code, in the case of curl `60` above.

For the complete exec event in JSON format remove the compact option.
For the complete exec event in JSON format remove the `-o compact` option.

{{< tabpane lang=shel-session >}}
{{< tab Kubernetes >}}
Expand All @@ -60,7 +94,7 @@ docker exec tetragon-container tetra getevents
{{< /tab >}}
{{< /tabpane >}}

This will include a lot more details related the binary and event. A full example of the above curl is hown here,
This will include a lot more details related to the binary and event. A full example of the above curl is shown here.
In a Kubernetes environment this will include the Kubernetes metadata include the Pod, Container, Namespaces, and
Labels among other useful metadata.

Expand Down
9 changes: 7 additions & 2 deletions docs/content/en/docs/getting-started/install-k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ az aks get-credentials --resource-group "${AZURE_RESOURCE_GROUP}" --name "${NAME
{{% /tab %}}
{{% tab EKS %}}

The following commands create a Kubernetes cluster with `eksctl` using [Amazon Elastic
The following commands create a single node Kubernetes cluster with `eksctl` using [Amazon Elastic
Kubernetes Service](https://aws.amazon.com/eks/). See [eksctl installation](https://github.com/eksctl-io/eksctl#installation)
for instructions on how to install `eksctl` and prepare your account.

Expand All @@ -54,7 +54,7 @@ eksctl create cluster --name "${NAME}"
{{% tab "Kind" %}}

Tetragon's correct operation depends on access to the host `/proc` filesystem. The following steps
configure kind and Tetragon accordingly when using a Linux system.
configure kind and Tetragon accordingly when using a Linux system. The following commands create a single node Kubernetes cluster using `kind` that is properly configured for Tetragon.

```shell
cat <<EOF > kind-config.yaml
Expand All @@ -73,6 +73,11 @@ EXTRA_HELM_FLAGS=(--set tetragon.hostProcPath=/procHost) # flags for helm instal

{{< /tabpane >}}

The commands in this Getting Started guide assume you use a single-node
Kubernetes cluster. If you use a cluster with multiple nodes, be aware that
some of the commands shown need to be modified. We call out these changes where
they are necessary.

### Deploy Tetragon

To install and deploy Tetragon, run the following commands:
Expand Down
Loading