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.

Sign up for GitHub

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

Jump to bottom

docs: simplify machine-id getting started #47552

Merged
merged 3 commits into from
Oct 15, 2024
Merged

docs: simplify machine-id getting started #47552

merged 3 commits into from
Oct 15, 2024

Conversation

stevenGravy
Copy link
Contributor

Removed separation of cloud vs self-hosted. As a getting started wasn't much value or diff. This was referring to parameters like --auth-server that weren't used that can cause confusion getting started.

@stevenGravy stevenGravy added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v15 backport/branch/v16 labels Oct 14, 2024
strideynet
strideynet reviewed Oct 14, 2024
View reviewed changes
docs/pages/enroll-resources/machine-id/getting-started.mdx
@@ -49,17 +49,8 @@ Before you create a bot user, you need to determine which role(s) you want to
assign to it. You can use the `tctl` command below to examine what roles exist
on your system.

<Tabs>
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Yeah - this is much simpler. I don't know why we ever had this split....

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-iay16j13z-goteleport.vercel.app/docs/ver/preview

strideynet
strideynet reviewed Oct 14, 2024
View reviewed changes
Copy link
Contributor

@strideynet strideynet 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 - thank you. Part of me is thinking we should do another PR to simplify this guide further by removing the references to iam joining - this made sense when we only had IAM joining, but now we have a full range of join methods, it doesn't make any sense to me to pick out AWS as the special case to include in this getting started guide.

@stevenGravy
Copy link
Contributor Author

Looks good - thank you. Part of me is thinking we should do another PR to simplify this guide further by removing the references to iam joining - this made sense when we only had IAM joining, but now we have a full range of join methods, it doesn't make any sense to me to pick out AWS as the special case to include in this getting started guide.

I did a brief to explain why you could want a non-token method. Probably worth keeping that then. pls take a look

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-ftrh4cljm-goteleport.vercel.app/docs/ver/preview

@strideynet
Copy link
Contributor

I did a brief to explain why you could want a non-token method. Probably worth keeping that then. pls take a look

Actually - if you drop that last commit - I figured it made sense for me to raise a PR with a few changes in regards to talking about joining in this guide: #47554

@stevenGravy
Revert "docs: update token joining desc for machine-id getting started"
6906023 
This reverts commit 1731a26.

this is being done in a separate pr on joining methods
@stevenGravy
Copy link
Contributor Author

I did a brief to explain why you could want a non-token method. Probably worth keeping that then. pls take a look

Actually - if you drop that last commit - I figured it made sense for me to raise a PR with a few changes in regards to talking about joining in this guide: #47554

Sure, dropped!

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-pohfvft7l-goteleport.vercel.app/docs/ver/preview

scottpgallagher
scottpgallagher approved these changes Oct 15, 2024
View reviewed changes
Copy link

@scottpgallagher scottpgallagher left a comment

Choose a reason for hiding this comment

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

Approved.

@stevenGravy stevenGravy added this pull request to the merge queue Oct 15, 2024
Merged via the queue into master with commit 39a86de Oct 15, 2024
40 checks passed
@stevenGravy stevenGravy deleted the stevenGravy/docs/machine-idgettingstarted branch October 15, 2024 13:11
@public-teleport-github-review-bot
Copy link

@stevenGravy See the table below for backport results.

Branch Result
branch/v15 Create PR
branch/v16 Create PR

This was referenced Oct 15, 2024
Merged
Merged
mvbrock pushed a commit that referenced this pull request Oct 16, 2024
@stevenGravy @mvbrock
docs: simplify machine-id getting started (#47552)
7741d08 
* docs: simplify machine-id getting started

* docs: update token joining desc for machine-id getting started

* Revert "docs: update token joining desc for machine-id getting started"

This reverts commit 1731a26.

this is being done in a separate pr on joining methods
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@strideynet strideynet strideynet approved these changes

@scottpgallagher scottpgallagher scottpgallagher approved these changes

@timothyb89 timothyb89 Awaiting requested review from timothyb89

@mmcallister mmcallister Awaiting requested review from mmcallister

@ptgott ptgott Awaiting requested review from ptgott

@r0mant r0mant Awaiting requested review from r0mant

@xinding33 xinding33 Awaiting requested review from xinding33

@zmb3 zmb3 Awaiting requested review from zmb3

Assignees
No one assigned
Labels
backport/branch/v15 backport/branch/v16 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevenGravy @strideynet @scottpgallagher