Skip to content

docs: Reduce the use of capitalized trusted clusters and a few other fixes#32432

Merged
lsgunn-teleport merged 7 commits intomasterfrom
LG/trusted-cluster-lower-case
Oct 4, 2023
Merged

docs: Reduce the use of capitalized trusted clusters and a few other fixes#32432
lsgunn-teleport merged 7 commits intomasterfrom
LG/trusted-cluster-lower-case

Conversation

@lsgunn-teleport
Copy link
Copy Markdown
Contributor

No description provided.

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-4ju3r95w5-goteleport.vercel.app/docs/ver/14.x

Comment thread docs/pages/core-concepts.mdx Outdated
Trusted Clusters.
### Trusted clusters

A **trusted cluster** consists of a **root cluster** and one or more **leaf clusters**
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Technically "trusted cluster" is singular and doesn't "consist of" multiple clusters.

We often use the term "trusted clusters" to mean "any setup where you have multiple clusters that have some sort of trust relationship between them."

In the singular form though, "trusted cluster" typically refers to a root cluster. For example, if cluster A is a root and cluster B is a leaf, then cluster B has one "trusted cluster" resource pointing at cluster A.

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.

"trusted cluster" typically refers to a root cluster.
Your explanation makes sense to me in the sense that the leaf trusts the CA of the root. However, I don't think I would say that is the "typical" usage. I've seen it used generically and used to mean the leaf cluster. It seems to be what this paragraph originally said: the "remote cluster" (the leaf) joins "your cluster" (the root).

Treating "Trusted Cluster" and "Trusted Clusters" as proper nouns encourages ambiguity.

I didn't go through and try to make all of the contextual changes. Still, I think it makes a lot more sense to talk about in terms of a trust relationship between a root cluster and a leaf cluster and do away with the generic references to Trusted Clusters or a trusted cluster that sometimes means the root and sometimes means the leaf.

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel September 27, 2023 18:53 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-j0hu4kz6b-goteleport.vercel.app/docs/ver/14.x

<TabItem scope={["cloud","team"]} label="Cloud-Hosted">

When multiple Trusted Clusters are present behind the Teleport Proxy Service, the
When multiple trusted Clusters are present behind the Teleport Proxy Service, the
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.

Suggested change
When multiple trusted Clusters are present behind the Teleport Proxy Service, the
When multiple trusted clusters are present behind the Teleport Proxy Service, the

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 4, 2023 18:42 — with GitHub Actions Inactive
@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 4, 2023 18:46 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 4, 2023

🤖 Vercel preview here: https://docs-pb9sq4ob8-goteleport.vercel.app/docs/ver/14.x

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 4, 2023

🤖 Vercel preview here: https://docs-inw2s3at1-goteleport.vercel.app/docs/ver/14.x

@lsgunn-teleport lsgunn-teleport added this pull request to the merge queue Oct 4, 2023
Merged via the queue into master with commit c33b848 Oct 4, 2023
@lsgunn-teleport lsgunn-teleport deleted the LG/trusted-cluster-lower-case branch October 4, 2023 19:53
@public-teleport-github-review-bot
Copy link
Copy Markdown

@lsgunn-teleport See the table below for backport results.

Branch Result
branch/v14 Failed

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.

3 participants