Skip to content

docs: kubernetes joining guide + reference#20298

Merged
hugoShaka merged 6 commits intomasterfrom
hugo/docs-kuebrnetes-provision-token
Apr 13, 2023
Merged

docs: kubernetes joining guide + reference#20298
hugoShaka merged 6 commits intomasterfrom
hugo/docs-kuebrnetes-provision-token

Conversation

@hugoShaka
Copy link
Copy Markdown
Contributor

@hugoShaka hugoShaka commented Jan 17, 2023

A few months ago we added a new Kubernetes join method, this PR contains the related documentation updates.

The feature was mainly designed for our own usage in the teleport-cluster proxy deployment, but some setups and users could definitely benefit from it, hence the guide.

We might be able to revisit and simplify some guides, such as the kubernetes local lab, to use this new join method. However, I suggest we wait a bit as the teleport-cluster chart might evolve a bit to ease such deployments (ability to deploy the teleport-kube-agent as a dependency).

@zmb3
Copy link
Copy Markdown
Collaborator

zmb3 commented Jan 17, 2023

Does this work with Machine ID too? (cc @strideynet)

@hugoShaka
Copy link
Copy Markdown
Contributor Author

hugoShaka commented Jan 17, 2023

Does this work with Machine ID too? (cc @strideynet)

Not yet, MachineID support was removed from the PR because it was broken, and I did not realize it because I had no MachineID tests. We left the feature out for now and will add MachineID support once we'll have a bit more time and ways to guarantee this works. This will be definitely useful to move the operator out of the Teleport auth pods and when tbot will support a Kubernetes secret destination.

Comment thread docs/config.json Outdated
"forScopes": ["oss", "enterprise"]
},
{
"title": "Joining Nodes via Kubernetes ServiceAccount Tokens",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does this apply to all Teleport Services? If so, we might want to say "Registering Resources...", "Joining Agents...", or something similar instead. The "Core Concepts" page (https://goteleport.com/docs/core-concepts/) doesn't include the "Node" concept.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We discussed on slack

Joining applies to all non-auth services. I'll use the term "Service" everywhere. We might want to align the other guides which are using the term "Node".

Comment thread docs/pages/management/guides.mdx Outdated
Comment thread docs/pages/management/guides.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-nodes-kubernetes-serviceaccount.mdx Outdated
@alexfornuto
Copy link
Copy Markdown
Contributor

Checking in with @hugoShaka on this.

@hugoShaka hugoShaka force-pushed the hugo/docs-kuebrnetes-provision-token branch from 970b416 to 778dffe Compare April 4, 2023 20:56
@hugoShaka hugoShaka force-pushed the hugo/docs-kuebrnetes-provision-token branch from 778dffe to 6ad1626 Compare April 4, 2023 21:08
@hugoShaka hugoShaka requested a review from ptgott April 4, 2023 21:08
@ptgott ptgott self-assigned this Apr 11, 2023
Copy link
Copy Markdown
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

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

Looks good! Left small suggestions

Comment thread docs/config.json
"slug": "/management/guides/joining-nodes-azure/"
},
{
"title": "Joining Services via Kubernetes ServiceAccount",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have a PR to create a dedicated section re: joining services (#23869). No big deal which one we merge first, but I thought I'd let you know in case we need to rebase this PR over #23869.

Comment thread docs/pages/management/guides.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
Comment thread docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx Outdated
hugoShaka and others added 3 commits April 11, 2023 13:32
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
…ceaccount.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
@hugoShaka hugoShaka requested a review from ptgott April 11, 2023 20:01
@public-teleport-github-review-bot public-teleport-github-review-bot Bot removed the request for review from xinding33 April 13, 2023 14:53
@ptgott
Copy link
Copy Markdown
Contributor

ptgott commented Apr 13, 2023

@hugoShaka Double-checking whether this needs backport labels

@hugoShaka hugoShaka added this pull request to the merge queue Apr 13, 2023
Merged via the queue into master with commit aff81fe Apr 13, 2023
@hugoShaka hugoShaka deleted the hugo/docs-kuebrnetes-provision-token branch April 13, 2023 15:59
@public-teleport-github-review-bot
Copy link
Copy Markdown

@hugoShaka See the table below for backport results.

Branch Result
branch/v12 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants