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.

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

docs: fix typos, fix k8s install guide for zsh and update Cilium SW demo #1965

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

ioandr
Copy link
Contributor

@ioandr ioandr commented Jan 12, 2024

This PR provides the following fixes for Tetragon's docs:

  1. Ensure that the URL with the manifest of the Cilium SW demo application is rendered in kubectl commands
  2. Ensure that the K8s installation guide works for both zsh and bash shells

Signed-off-by: Ioannis Androulidakis androulidakis.ioannis@gmail.com

Declare `demo_app_url` as a parameter in hugo.toml so that its value
becomes available in Hugo shortcodes [1]. In turn, this allows us to
format markdown templates.

See commit cca7655 that previously modified Hugo's configuration file.

Also fix some typos and perform nits.

[1] https://gohugo.io/content-management/shortcodes/#param

Signed-off-by: Ioannis Androulidakis <androulidakis.ioannis@gmail.com>
When running the K8s installation guide with zsh the following commands:

  EXTRA_HELM_FLAGS="--set tetragon.hostProcPath=/procHost"
  helm install tetragon ${EXTRA_HELM_FLAGS} cilium/tetragon -n kube-system

fail with:

  Error: unknown flag: --set tetragon.hostProcPath

The reason for this is that zsh does not split into words when it
expands parameters by default [2]. For example, in a zsh shell:

  EXTRA_FLAGS="--namespace kube-system"; strace -e trace=execve kubectl get pods ${EXTRA_FLAGS} 2>&1 | grep -m1 kubectl
  execve("/usr/bin/kubectl", ["kubectl", "get", "pods", "--namespace kube-system"], 0x7ffe5a984d38 /* 63 vars */) = 0

Fix this by using arrays to pass extra Helm flags which works in both
bash and zsh shells.

[1] https://linux.die.net/man/1/zshexpn

Signed-off-by: Ioannis Androulidakis <androulidakis.ioannis@gmail.com>
@ioandr ioandr requested review from mtardy and a team as code owners January 12, 2024 00:38
Copy link

netlify bot commented Jan 12, 2024

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit 768b350
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/65a08a03c462cd00087eaee6
😎 Deploy Preview https://deploy-preview-1965--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@kkourt kkourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for creating a separate PR! Just a small thing to understand before we merge this :)!

@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Jan 12, 2024
@mtardy mtardy changed the title Documentation improvements docs: fix typos, fix k8s install guide for zsh and update Cilium SW demo Jan 12, 2024
@mtardy mtardy merged commit 2a210dc into cilium:main Jan 12, 2024
10 of 11 checks passed
@ioandr ioandr deleted the feature-i-doc-fixes branch January 12, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants