Skip to content

Commit

Permalink
docs: bump FAQ entry title size and fix tetra install instructions
Browse files Browse the repository at this point in the history
These are unrelated changes but bundled together because of their size.

Signed-off-by: Mahe Tardy <mahe.tardy@gmail.com>
  • Loading branch information
mtardy committed May 19, 2023
1 parent 23f1f71 commit d99c033
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
12 changes: 6 additions & 6 deletions docs/content/en/docs/faq/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@ weight: 7
description: "List of frequently asked questions"
---

#### Can I install and use Tetragon in standalone mode (outside of k8s)?
### Can I install and use Tetragon in standalone mode (outside of k8s)?

Yes! You can run `make` to generate standalone binaries and run them directly.
Make sure to take a look at the [Development Setup](/docs/contribution-guide/development-setup/)
guide for the build requirements. Then use `sudo ./tetragon --bpf-lib bpf/objs`
to run Tetragon.

#### CI is complaining about Go module vendoring, what do I do?
### CI is complaining about Go module vendoring, what do I do?

You can run `make vendor` then add and commit your changes.

#### CI is complaining about a missing "signed-off-by" line. What do I do?
### CI is complaining about a missing "signed-off-by" line. What do I do?

You need to add a signed-off-by line to your commit messages. The easiest way
to do this is with `git fetch origin/main && git rebase --signoff origin/main`.
Then push your changes.

#### Can I run Tetragon on Mac computers?
### Can I run Tetragon on Mac computers?

Yes! You can run Tetragon locally by running a Linux virtual machine on your
Mac.
Expand Down Expand Up @@ -52,7 +52,7 @@ and [linuxkit](https://github.com/linuxkit/linuxkit/issues/3755), the project
used to build the kernel used by Docker Desktop. If you would like Docker
Desktop to support BTF, feel free to support those issues.

#### Go compiler is complaining about missing symbols in `pkg/bpf`
### Go compiler is complaining about missing symbols in `pkg/bpf`

You might end up with the output of the Go compiler looking similar to this:
```
Expand Down Expand Up @@ -90,7 +90,7 @@ If you encounter the issue under Linux:
persistently change the value of the CC go environment variable you can use
`go env -w "CC=clang"`.

#### Tetragon failed to start complaining about a missing BTF file
### Tetragon failed to start complaining about a missing BTF file

You might have encountered the following issues:
```
Expand Down
18 changes: 10 additions & 8 deletions docs/content/en/docs/getting-started/install-tetra-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,32 +51,34 @@ referred to as aarch64 or Apple Silicon for Mac computers.

{{< tab header="Linux amd64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-linux-amd64.tar.gz | tar -xz
mv tetra /usr/local/bin
sudo mv tetra /usr/local/bin
{{< /tab >}}

{{< tab header="Linux arm64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-linux-arm64.tar.gz | tar -xz
mv tetra /usr/local/bin
sudo mv tetra /usr/local/bin
{{< /tab >}}

{{< tab header="macOS amd64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-darwin-amd64.tar.gz | tar -xz
mv tetra /usr/local/bin
sudo mv tetra /usr/local/bin
{{< /tab >}}

{{< tab header="macOS arm64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-darwin-arm64.tar.gz | tar -xz
mv tetra /usr/local/bin
sudo mv tetra /usr/local/bin
{{< /tab >}}

{{< tab header="Windows amd64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-windows-amd64.tar.gz | tar -xz
mv tetra /usr/local/bin
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-windows-amd64.tar.gz
tar -xz tetra-windows-amd64.tar.gz
# move the binary in a directory in your PATH
{{< /tab >}}

{{< tab header="Windows arm64" lang="shell" >}}
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-windows-arm64.tar.gz | tar -xz
mv tetra /usr/local/bin
curl -LO https://github.com/cilium/tetragon/releases/latest/download/tetra-windows-arm64.tar.gz
tar -xz tetra-windows-arm64.tar.gz
# move the binary in a directory in your PATH
{{< /tab >}}
{{< /tabpane >}}

Expand Down

0 comments on commit d99c033

Please sign in to comment.