Skip to content

Add Azure BYOC instructions for granting permissions#23110

Merged
jhlodin merged 9 commits intomainfrom
jl/doc-16141
Apr 16, 2026
Merged

Add Azure BYOC instructions for granting permissions#23110
jhlodin merged 9 commits intomainfrom
jl/doc-16141

Conversation

@jhlodin
Copy link
Copy Markdown
Contributor

@jhlodin jhlodin commented Mar 16, 2026

https://cockroachlabs.atlassian.net/browse/DOC-16396
https://cockroachlabs.atlassian.net/browse/DOC-16141

  • Adds a warning to dissuade account modifications on BYOC deployments
  • Adds instructions to grant admin consent to the Reader app
  • Adds instructions to grant permissions by deploying our Lighthouse template

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 16, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 7976632
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69e12c8f11331b0009f4e2d9

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 16, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 7976632
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69e12c8fcb27740008a809cd

@github-actions
Copy link
Copy Markdown

Files changed:

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 16, 2026

Netlify Preview

Name Link
🔨 Latest commit 7976632
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69e12c8f5a62ba00086c9691
😎 Deploy Preview https://deploy-preview-23110--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jhlodin jhlodin changed the title Add warning to dissuade account modifications on BYOC deployments Add Azure BYOC instructions for granting permissions Apr 6, 2026
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
@github-actions
Copy link
Copy Markdown

Diagram Anchor Check: Passed

All sql-grammar.html#anchor references in SQL diagram files resolve correctly against stmt_block.html.

Comment thread src/current/cockroachcloud/byoc-deployment.md
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Copy link
Copy Markdown
Contributor Author

@jhlodin jhlodin left a comment

Choose a reason for hiding this comment

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

some wordsmithing with Ryan

Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Comment thread src/current/cockroachcloud/byoc-deployment.md
Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated
Co-authored-by: Vishal Jaishankar <[email protected]>
@rmloveland rmloveland self-requested a review April 16, 2026 15:27
Copy link
Copy Markdown
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

LGTM just some small comments/suggestions/formatting things


## Step 2. Set up the admin App Registration

When BYOC is enabled for your account, Cockroach Labs dynamically provisions a multi-tenant admin App Registration associated with your CockroachDB {{ site.data.products.cloud }} organization and provides you with a URL to grant tenant-wide admin consent to the application. Granting admin consent creates an admin Service Principal in your tenant, which is used by Cockroach Labs support to act on the Kubernetes cluster, running automation that initializes support infrastructure.
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.

suggest bolding 'Service Principal', 'App Registration', etc. if they are proper names from the Azure UI

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.

I don't believe they're proper names specific to the UI. The actual UI term is Enterprise Application which is the tab in the UI that contains both App Registrations and Service Principals, but we're not (currently) documenting the specifics of a third party UI.

Bolding I think makes sense for the first mention of these terms to differentiate them, but not throughout this doc.


When BYOC is enabled for your account, Cockroach Labs dynamically provisions a multi-tenant admin App Registration associated with your CockroachDB {{ site.data.products.cloud }} organization and provides you with a URL to grant tenant-wide admin consent to the application. Granting admin consent creates an admin Service Principal in your tenant, which is used by Cockroach Labs support to act on the Kubernetes cluster, running automation that initializes support infrastructure.

Visit this URL with a user account that is [authorized to consent on behalf of your organization](https://learn.microsoft.com/entra/identity/enterprise-apps/grant-admin-consent?pivots=portal#prerequisites). Once the Cockroach Labs App Registration has been granted admin consent in the tenant, grant the following set of roles to the admin Service Principal:
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.

same here and elsewhere re: bolding proper names of Azure things

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.

See above, I think the first time on this page makes sense to bold but not the rest (they're entity types, not UI components)

Comment thread src/current/cockroachcloud/byoc-deployment.md Outdated

Use [Azure Lighthouse](https://learn.microsoft.com/azure/lighthouse/overview) to enable cross-tenant management that establishes the support infrastructure that allows Cockroach Labs to assist in the event of a support escalation. Permissions are granted least-privilege access and full visibility, allowing you to review and remove access at any time from the Azure portal.

This Azure Lighthouse deployment grants permissions to Cockroach Labs's managed tenant, which has a tenant ID of `a4611215-941c-4f86-b53b-348514e57b45`, by assigning the following roles to the reader and admin Entra groups within the tenant:
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 think this can be Cockroach Labs' managed tenant ?

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.

That's not the formal title of the tenant, just a descriptor. So plaintext should be correct.

Comment thread src/current/cockroachcloud/byoc-deployment.md
@jhlodin jhlodin enabled auto-merge (squash) April 16, 2026 18:38
@jhlodin jhlodin merged commit 4d5087a into main Apr 16, 2026
8 checks passed
@jhlodin jhlodin deleted the jl/doc-16141 branch April 16, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants