Update Getting Started guide #2721
Conversation
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks, that's an amazing change! This time you could have separated the patches by commits but it's completely fine like that.
There's one thing I don't get:
Remove language specifier for fenced codeblock.
In many places you removed the shell specifier, it's only supposed to be removed when you put output of commands, the commands themselves need this to appear correctly. I'm not sure why you removed them in some places, I didn't node all of them.
Once we have some things fixed I'll be happy to merge this :) thanks again!
| --pid=host --cgroupns=host --privileged \ | ||
| -v ${PWD}/file_monitoring_enforce.yaml:/etc/tetragon/tetragon.tp.d/file_monitoring_enforce.yaml \ | ||
| -v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ | ||
| quay.io/cilium/tetragon-ci:latest | ||
| quay.io/cilium/tetragon:latest |
There was a problem hiding this comment.
you could make use of {{< latest-version >}} if you want here that will inject the latest released version of Tetragon
| quay.io/cilium/tetragon:latest | |
| quay.io/cilium/tetragon:{{< latest-version >}} |
| @@ -24,7 +24,7 @@ in your environment. | |||
| For a single node Kubernetes cluster, you can target the Tetragon DaemonSet with | |||
| a `kubectl exec` command: | |||
|
|
|||
| ```shell | |||
| ``` | |||
| -v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ | ||
| quay.io/cilium/tetragon-ci:latest | ||
| -v /sys/kernel/btf/vmlinux:/var/lib/tetragon/btf \ | ||
| quay.io/cilium/tetragon:latest |
There was a problem hiding this comment.
same
| quay.io/cilium/tetragon:latest | |
| quay.io/cilium/tetragon:{{< latest-version >}} |
| monitoring network access. In this section, you will see how to monitor network | ||
| traffic to "external" destinations (destinations that are outside the | ||
| Kubernetes cluster or external to the Docker host where Tetragon is running). | ||
| These instructions assume you already have Tetragon running in either Kubernetes or Docker, and that you have deployed the Cilium demo application. |
There was a problem hiding this comment.
that's a nit but if you can wrap here
|
|
||
| ```shell | ||
| ``` |
mtardy
added
area/documentation
|
@mtardy I think I've incorporated all your requested changes. I did not switch to using |
There was a problem hiding this comment.
Thanks a lot that's great! Could you squash your commits https://tetragon.io/docs/contribution-guide/submitting-a-pull-request/#commit-changes ? With merge rebase so we squash commits related to feedback.
This commit brings greater consistency to the Getting Started guide. execution.md: Remove language specifier for codeblocks showing output. file-events.md: Add instructions for single-node and multi-node K8s clusters. Clean up Docker instructions. Ensure consistent header levels. Minor fixes in spelling and grammar. Remove language specifier for codeblocks showing output. network.md: Add EKS, AKS instructions for getting service CIDR. Add instructions for single-node and multi-node K8s clusters. Ensure consistent header levels. Minor fixes in spelling and grammar. Remove language specifier for codeblocks showing output. enforcement.md: Reorganize content to improve flow. Add EKS, AKS instructions for getting service CIDR. Add instructions for single-node and multi-node K8s clusters. Ensure consistent header levels. Minor fixes in spelling and grammar. Remove language specifier for codeblocks showing output. Signed-off-by: Scott Lowe <[email protected]>
scottslowe
force-pushed
the
pr/scottslowe/docs-gsg-updates
branch
from
08ed75e to
16f29a6
Compare
Description
This PR updates the Getting Started guide for consistency throughout all sections.
Here is the full changeset:
execution.md:Remove language specifier for fenced codeblock.
file-events.md:Add instructions for single-node and multi-node K8s clusters. Clean up Docker instructions.
Ensure consistent header levels.
Minor fixes in spelling and grammar.
network.md:Add EKS, AKS instructions for getting service CIDR. Add instructions for single-node and multi-node K8s clusters. Ensure consistent header levels.
Minor fixes in spelling and grammar.
enforcement.md:Reorganize content to improve flow.
Add EKS, AKS instructions for getting service CIDR. Add instructions for single-node and multi-node K8s clusters. Ensure consistent header levels.
Minor fixes in spelling and grammar.
No release notes/changelog entries necessary.