Skip to content

Add Azure BYOC instructions for granting permissions#23110

Open
jhlodin wants to merge 6 commits intomainfrom
jl/doc-16141
Open

Add Azure BYOC instructions for granting permissions#23110
jhlodin wants to merge 6 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 502c5bf
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69de78104db5780008410bcf

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 16, 2026

Deploy Preview for cockroachdb-api-docs canceled.

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

@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 502c5bf
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69de78104db5780008410bcb
😎 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
@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.

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

## 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 to grant Cockroach Labs engineers admin access to the Kubernetes cluster to assist in the event of an escalation.
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 in the event of an escalation.
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.

  • to act on the cluster and to run our automation that initializes infra

## Step 3. Set up the reader App Registration

In addition to the admin application, Cockroach Labs provisions the CockroachDB {{ site.data.products.cloud }} BYOC Reader App Registration. This App Registration is used to grant Cockroach Labs engineers the default read-only access to Azure cloud resources.
In addition to the admin application, Cockroach Labs provisions the CockroachDB {{ site.data.products.cloud }} BYOC Reader App Registration. This App Registration is used to grant reader permissions to Cockroach {{ site.data.products.cloud }} automation.
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.

  • is only used by support for read access on the kubernetes infra

3. Review the requested permissions and click **Accept**.

## Step 4. Grant permissions to the reader service principle with Azure Lighthouse
## Step 4. Grant persmissions to auth principals with Azure Lighthouse
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.

Grant permissions to Entra groups (static)

## Step 4. Grant persmissions to auth principals with Azure Lighthouse

The CockroachDB {{ site.data.products.cloud }} BYOC Reader application creates a read-only service principle. Use [Azure Lighthouse](https://learn.microsoft.com/azure/lighthouse/overview) to enable cross-tenant management to the service principle with least-privilege access and full customer visibility. You can review or remove this access at any time from the Azure portal.
Use [Azure Lighthouse](https://learn.microsoft.com/azure/lighthouse/overview) to enable cross-tenant management that grants individual Cockroach Labs engineers persmissions on the service principle as needed for support purposes. Permissions are applied to the service principle with least-privilege access and full visibility, allowing you to review or remove this access at any time from the Azure portal.
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 establishes support infrastructure allowing us to jump in as needed

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.

3 participants