Skip to content

Commit

Permalink
docs: reorganize the doc by creating new use cases section
Browse files Browse the repository at this point in the history
Signed-off-by: Mahe Tardy <[email protected]>
  • Loading branch information
mtardy authored and kkourt committed Jul 11, 2023
1 parent 40a0318 commit d4b50bc
Show file tree
Hide file tree
Showing 14 changed files with 37 additions and 46 deletions.
26 changes: 0 additions & 26 deletions docs/content/en/docs/concepts/generic-tracing/_index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/en/docs/contribution-guide/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Contribution Guide"
linkTitle: "Contribution Guide"
weight: 6
weight: 7
icon: "contribution"
description: >
How to contribute to the project
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/faq/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "FAQ"
weight: 7
weight: 8
icon: "faq"
description: "List of frequently asked questions"
---
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/try-tetragon-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Let's break down the previous command:
## Observe Tetragon base events

With this default configuration, Tetragon already loaded its base sensors to
perform [process lifecycle observability]({{< ref "docs/concepts/process-lifecycle" >}}).
perform [process lifecycle observability]({{< ref "docs/use-cases/process-lifecycle" >}}).

To quickly see the events, you can use the `tetra` CLI already shipped in the
Tetragon container that was just started, it will connect to the Tetragon gRPC
Expand Down Expand Up @@ -395,4 +395,4 @@ file using `cat ./tracing_policy.yaml` will bypass the policies presented here.

- Try Tetragon in [Kubernetes environments]({{< ref "docs/getting-started/kubernetes-quickstart-guide" >}}).
- Learn more about [TracingPolicy]({{< ref "docs/concepts/tracing-policy" >}}).
- See more use cases for observability in the [Concepts section]({{< ref "docs/concepts" >}}).
- See more use cases for observability in the [Use cases section]({{< ref "docs/use-cases" >}}).
2 changes: 1 addition & 1 deletion docs/content/en/docs/reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Reference"
linkTitle: "Reference"
weight: 4
weight: 6
icon: "reference"
description: >
Low level reference documentation for Tetragon
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/resources/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Resources"
weight: 8
weight: 9
icon: "resources"
description: "Additional resources to learn about Tetragon"
---
Expand Down
17 changes: 17 additions & 0 deletions docs/content/en/docs/use-cases/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Use Cases"
icon: "resources"
weight: 4
description: >
This section presents various use cases on process, files, network and
security monitoring and enforcement.
---

By default, Tetragon monitors process lifecycle, learn more about that in the
[dedicated use cases]({{< ref "/docs/use-cases/process-lifecycle/" >}}).

For more advanced use cases, Tetragon can observe tracepoints and arbitrary
kernel calls via kprobes. For that, Tetragon must be extended and configured
with custom resources objects named [TracingPolicy]({{< ref "/docs/concepts/tracing-policy" >}}).
It can then generates `process_tracepoint` and `process_kprobes` events.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Use case: file access"
weight: 1
title: "File access"
weight: 2
icon: "overview"
description: "Monitor file access using kprobe hooks"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Linux Process Credentials"
weight: 3
icon: "reference"
description: "Monitor Linux Process Credentials"
title: "Linux process credentials"
weight: 4
icon: "overview"
description: "Monitor Linux process credentials"
---

On Linux each process has various associated user, group IDs, capabilities,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Use case: Monitor change Credentials system calls"
title: "Credentials change system calls"
weight: 2
icon: "reference"
description: "Monitor change Credentials System calls"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Use case: network observability"
weight: 2
icon: "reference"
title: "Network observability"
weight: 3
icon: "overview"
description: "Monitor TCP connect using kprobe hooks"
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Process lifecycle"
linkTitle: "Process lifecyle"
weight: 1
icon: "reference"
icon: "overview"
description: "Tetragon observes by default the process lifecycle via exec and exit"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Use case: privileged execution"
title: "Privileged execution"
weight: 2
icon: "reference"
icon: "overview"
description: "Monitor process capabilities and kernel namespace access"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Use case: monitoring process execution"
title: "Process execution"
weight: 1
icon: "overview"
description: "Monitor process lifecycle with `process_exec` and `process_exit`"
Expand Down

0 comments on commit d4b50bc

Please sign in to comment.