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: export KUBECONFIG for cilium-cli with k3s #18697

Merged
merged 1 commit into from Feb 3, 2022

Conversation

tklauser
Copy link
Member

@tklauser tklauser commented Feb 2, 2022

Previously, commit 606b5fe ("docs: KUBECONFIG for cilium-cli with
k3s") and commit 606b5fe ("docs: KUBECONFIG for cilium-cli with
k3s") changed cilium install commands to set KUBECONFIG explicitly.

However, successive cilium-cli commands (e.g. cilium status or
cilium connectivity test in the getting started guide) will need the
corresponding kubeconfig as well. Thus, suggest to export KUBECONFIG
at the top of the k3s specific guides.

For cilium/cilium-cli#696

@tklauser tklauser added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.10 labels Feb 2, 2022
@tklauser tklauser requested a review from a team as a code owner February 2, 2022 16:47
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.11.2 Feb 2, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.10.8 Feb 2, 2022
Previously, commit 606b5fe ("docs: KUBECONFIG for cilium-cli with
k3s") and commit 606b5fe ("docs: KUBECONFIG for cilium-cli with
k3s") changed `cilium install` commands to set KUBECONFIG explicitly.

However, successive cilium-cli commands (e.g. `cilium status` or
`cilium connectivity test` in the getting started guide) will need the
corresponding kubeconfig as well. Thus, suggest to `export KUBECONFIG`
at the top of the k3s specific guides.

For cilium/cilium-cli#696

Signed-off-by: Tobias Klauser <tobias@cilium.io>
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

LGTM. I'm looking at the dedicated k3s doc and wondering if we even need a dedicated k3s page if k3s is one of the supported tabs under the main "k8s-install-default" page... but that's unrelated to the goal of this PR.

@tklauser tklauser added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Feb 3, 2022
@tklauser
Copy link
Member Author

tklauser commented Feb 3, 2022

LGTM. I'm looking at the dedicated k3s doc and wondering if we even need a dedicated k3s page if k3s is one of the supported tabs under the main "k8s-install-default" page... but that's unrelated to the goal of this PR.

Good point about the dedicated k3s doc. It looks like most of it is already covered in the k3s-specific part of the quick start guide. It looks like the only part missing is the step to install additional k3s nodes which don't looks specific to Cilium, so one could argue this is already covered by the k3s upstream docs.

@joamaki joamaki merged commit b4c9ba1 into master Feb 3, 2022
@joamaki joamaki deleted the pr/docs-k3s-set-kubeconfig branch February 3, 2022 13:36
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.10 in 1.10.8 Feb 7, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.10 in 1.11.2 Feb 7, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.10 to Backport done to v1.10 in 1.10.8 Feb 8, 2022
@joamaki joamaki added backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.11 labels Feb 8, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.10 to Backport done to v1.11 in 1.11.2 Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.10.8
Backport done to v1.10
1.11.2
Backport done to v1.11
Development

Successfully merging this pull request may close these issues.

None yet

3 participants