Skip to content

Commit

Permalink
docs: Split FAQ into installation and contribution sections
Browse files Browse the repository at this point in the history
The FAQ page included some installation and some CI questions. They have
different audiences, so let's split them:
* Installation questions are under "Installation and Configuration" section
* CI questions are a part of "Submitting a pull request" page

Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
  • Loading branch information
lambdanis committed May 10, 2024
1 parent c2f1ef1 commit 048b164
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request_template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
value: |
Thanks for taking the time to request a new feature!
If you have usage questions, please join the [Cilium Slack](https://slack.cilium.io/) and ask questions in the [Tetragon channel](https://cilium.slack.com/archives/C03EV7KJPJ9). Please also consult the [FAQ](https://tetragon.cilium.io/docs/faq/) first.
If you have usage questions, please join the [Cilium Slack](https://slack.cilium.io/) and ask questions in the [Tetragon channel](https://cilium.slack.com/archives/C03EV7KJPJ9). Please also consult the [FAQ](https://tetragon.cilium.io/docs/installation/faq/) first.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ and generates events enriched with Linux and Kubernetes metadata:

See further resources:
- [Conference Talks, Books, Blog Posts, and Labs](https://tetragon.io/docs/resources/)
- [Frequently Asked Question](https://tetragon.io/docs/faq/)
- [Frequently Asked Question](https://tetragon.io/docs/installation/faq/)
- [References](https://tetragon.io/docs/reference/)

## Join the community
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Notes:
exist"`, then make sure that your kernel support [BTF](#btf-requirement),
otherwise place a BTF file where Tetragon can read it and specify its path
with the `--btf` flag. See more about that
[in the FAQ]({{< ref "/docs/faq/#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}}).
[in the FAQ]({{< ref "/docs/installation/faq#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}}).

## Running code generation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,14 @@ requirements have been met:

6. All important steps in [Making changes]({{< ref "/docs/contribution-guide/making-changes" >}}) have been followed.

### Frequently Asked Questions

#### 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?

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.
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/install-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ This guide has been tested on Ubuntu 22.04 and 22.10 with respectively kernel
`5.15.0` and `5.19.0` on amd64 and arm64 but
[any recent distribution](https://github.com/libbpf/libbpf#bpf-co-re-compile-once--run-everywhere)
shipping with a relatively recent kernel should work. See the FAQ for further details on
the [recommended kernel versions]({{< ref "/docs/faq#what-is-the-minimum-linux-kernel-version-to-run-tetragon" >}}).
the [recommended kernel versions]({{< ref "/docs/installation/faq#what-is-the-minimum-linux-kernel-version-to-run-tetragon" >}}).

Note that you cannot run Tetragon using Docker Desktop on macOS because of a
limitation of the Docker Desktop Linux virtual machine. Learn more about this issue
and how to run Tetragon on a Mac computer in [this section of the FAQ page](/docs/faq/#can-i-run-tetragon-on-mac-computers).
and how to run Tetragon on a Mac computer in [this section of the FAQ page](/docs/installation/faq#can-i-run-tetragon-on-mac-computers).
{{< /note >}}

## Start Tetragon
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/installation/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ docker run --name tetragon --rm -d \

{{< note >}}
If Tetragon does not start due to BTF issues, please refer to the
[corresponding question in the FAQ]({{< ref "/docs/faq/#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
[corresponding question in the FAQ]({{< ref "/docs/installation/faq#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
for details and solutions.
{{< /note >}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "FAQ"
weight: 10
weight: 99
description: "List of frequently asked questions"
aliases: ["/docs/faq"]
---

### What is the minimum Linux kernel version to run Tetragon?
Expand All @@ -14,7 +15,7 @@ for up to date information. Not all Tetragon features work with older kernel
versions. BPF evolves rapidly and we recommend you use the most recent stable
kernel possible to get the most out of Tetragon's features.

Note that Tetragon needs [BTF support]({{< ref "/docs/faq/_index.md#tetragon-failed-to-start-complaining-about-a-missing-btf-file">}})
Note that Tetragon needs [BTF support]({{< ref "/docs/installation/faq#tetragon-failed-to-start-complaining-about-a-missing-btf-file">}})
which might take some work on older kernels.

### What are the Linux kernel configuration options needed to run Tetragon?
Expand Down Expand Up @@ -132,24 +133,15 @@ to [can I run Tetragon on Mac computers](#can-i-run-tetragon-on-mac-computers).

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

Yes! TBD docs
Yes! Refer to the [Container]({{< ref "/docs/installation/container">}}) or
[Package]({{< ref "/docs/installation/package">}}) installation guides.

Otherwise you can build Tetragon from source by running `make` to generate standalone
binaries.
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?

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?

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?

Yes! You can run Tetragon locally by running a Linux virtual machine on your
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/installation/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ By default, pods in the kube-system namespace are filtered-out.

{{< note >}}
If Tetragon does not to start due to BTF issues, please refer to the
[corresponding question in the FAQ]({{< ref "/docs/faq/#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
[corresponding question in the FAQ]({{< ref "/docs/installation/faq#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
for details and solutions.
{{< /note >}}

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/installation/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Tetragon as of version 1.0 supports amd64 and arm64 architectures.

{{< note >}}
If Tetragon does not to start due to BTF issues, please refer to the
[corresponding question in the FAQ]({{< ref "/docs/faq/#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
[corresponding question in the FAQ]({{< ref "/docs/installation/faq#tetragon-failed-to-start-complaining-about-a-missing-btf-file" >}})
for details and solutions.
{{< /note >}}

Expand Down

0 comments on commit 048b164

Please sign in to comment.