Skip to content

Machine ID: Documentation for Bitbucket Pipelines joining#49172

Merged
timothyb89 merged 3 commits intomasterfrom
timothyb89/bitbucket-pipelines-joining-docs
Nov 23, 2024
Merged

Machine ID: Documentation for Bitbucket Pipelines joining#49172
timothyb89 merged 3 commits intomasterfrom
timothyb89/bitbucket-pipelines-joining-docs

Conversation

@timothyb89
Copy link
Copy Markdown
Contributor

This adds guides and other documentation for the bitbucket join method, which allows Machine ID bots to join from Bitbucket Pipelines runs without shared secrets.

Follow up to #48724

This adds guides and other documentation for the `bitbucket` join
method, which allows Machine ID bots to join from Bitbucket Pipelines
runs without shared secrets.

Follow up to #48724
@github-actions
Copy link
Copy Markdown
Contributor

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

Comment on lines +24 to +28
From this page, note the following values:
- Identity provider URL (<Var name="identity-provider-url" />)
- Audience (<Var name="audience" />)
- Workspace UUID (<Var name="workspace-uuid" />)
- Repository UUID (<Var name="repository-uuid" />)
Copy link
Copy Markdown
Contributor Author

@timothyb89 timothyb89 Nov 19, 2024

Choose a reason for hiding this comment

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

I'm hoping to have a good variable UX here but the inline values used in some other docs pages don't make a lot of sense once a value is entered since the variable name gets hidden. I'm not sure if this is a reasonable compromise - any thoughts from the docs team?

@timothyb89 timothyb89 marked this pull request as ready for review November 19, 2024 03:52
@timothyb89 timothyb89 added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v16 backport/branch/v17 labels Nov 19, 2024

The `bitbucket` join method is a secure way for Machine ID bots to authenticate
with the Teleport Auth Service without using any shared secrets. Instead, it
makes use of an OpenID Connect token that Bitbucket Pipelines injects into the
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.

Suggested change
makes use of an OpenID Connect token that Bitbucket Pipelines injects into the
makes use of an OpenID Connect token that Bitbucket Pipelines inject into the

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.

Hmm, I think it's correct as written? "Bitbucket Pipelines" is a singular product so I think "injects" is correct here. If we said "Bitbucket pipelines" referring to individual workflows then we'd want the singular form, but I've tried to refer to them as "Bitbucket Pipelines workflows" or similar.

Amusingly, even Bitbucket frequently calls them workflows instead of pipelines.

- wget https://cdn.teleport.dev/teleport-v(=teleport.version=)-linux-amd64-bin.tar.gz
- tar -xvf teleport-v(=teleport.version=)-linux-amd64-bin.tar.gz

# Run `tbot` in identity mode for SSH access
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.

We will have to change this if we backport bitbucket to v16, right?

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.

Good call, I'll tweak this in the backport to borrow step 5 from the other guides.

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@timothyb89 timothyb89 added this pull request to the merge queue Nov 23, 2024
Merged via the queue into master with commit 112001f Nov 23, 2024
@timothyb89 timothyb89 deleted the timothyb89/bitbucket-pipelines-joining-docs branch November 23, 2024 00:31
@public-teleport-github-review-bot
Copy link
Copy Markdown

@timothyb89 See the table below for backport results.

Branch Result
branch/v16 Create PR
branch/v17 Create PR

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

Labels

backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants