Skip to content

DOC-1716 Azure BYOC cluster creation is missing registering 1 provider#426

Merged
micheleRP merged 2 commits intomainfrom
DOC-1716-Azure-BYOC-cluster-creation-is-missing-registering-1-provider
Oct 3, 2025
Merged

DOC-1716 Azure BYOC cluster creation is missing registering 1 provider#426
micheleRP merged 2 commits intomainfrom
DOC-1716-Azure-BYOC-cluster-creation-is-missing-registering-1-provider

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented Oct 2, 2025

Description

This PR updates the doc for creating BYOC clusters on Azure, clarifying the required resource providers and improving instructions for registering and verifying provider status.

  • Clarified that the subscription must be registered for AKS and common dependencies, and explicitly added Microsoft.ContainerService to the required resource providers list.
  • Improved instructions for checking, registering, and verifying the status of resource providers and features using Azure CLI commands, including examples for both registration and status queries.

Resolves https://redpandadata.atlassian.net/browse/DOC-1716
Review deadline:

Page previews

Create a BYOC Cluster on Azure

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@micheleRP micheleRP requested a review from a team as a code owner October 2, 2025 19:58
@netlify
Copy link
Copy Markdown

netlify bot commented Oct 2, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 8fe86e1
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68dedc79f22d4d0008878e87
😎 Deploy Preview https://deploy-preview-426--rp-cloud.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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 2, 2025

📝 Walkthrough

Walkthrough

The Azure BYOC cluster creation doc adds Microsoft.ContainerService to required providers, details az provider register/show commands for provider registration, introduces steps to enable and verify EncryptionAtHost, adds instructions to enable Network Watcher, extends the cluster creation flow with an optional Advanced settings section for custom tags, and expands post-creation guidance to include Azure IAM policies and tag management.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant CLI as Azure CLI
  participant ARM as Azure Resource Manager
  participant RP as Redpanda Cloud

  User->>CLI: az provider register/show for required providers<br/>(Compute, ManagedIdentity, Storage, KeyVault, Network, ContainerService)
  CLI->>ARM: Register providers / query registration state
  ARM-->>CLI: Registration status per provider

  User->>CLI: az feature register --namespace Microsoft.Compute --name EncryptionAtHost
  CLI->>ARM: Register feature
  ARM-->>CLI: Feature state (Registered/NotRegistered)
  Note over CLI,ARM: Provider refresh if needed

  User->>CLI: Enable Network Watcher in target region/resource group
  CLI->>ARM: Create/enable Network Watcher
  ARM-->>CLI: Confirmation

  User->>RP: Create BYOC cluster (Azure) via UI/flow
  RP->>ARM: Provision resources in subscription
  Note over RP,ARM: Optional Advanced: apply custom tags
  ARM-->>RP: Provisioning status
  RP-->>User: Cluster created

  User->>ARM: (Optional) Apply/adjust custom tags post-creation
  User->>ARM: (Post-creation) Configure IAM policies for agents
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • david-yu
  • deniscoady
  • kbatuigas

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning The PR also introduces unrelated additions such as enabling Network Watcher, advanced custom tag settings, and expanded post‐creation guidance, which go beyond the linked issue’s focus on provider registration and feature commands. Remove or relocate the sections on Network Watcher, custom tagging, and post‐creation guidance into a separate PR so that this changeset remains focused on provider registration instructions.
Description Check ⚠️ Warning The pull request description follows the general template structure but fails to use the required GitHub issue URL under “Resolves” and leaves the Review deadline field blank, both of which are explicitly specified in the repository’s description template. Please update the “Resolves” line to reference the GitHub issue URL in the form https://github.com/redpanda-data/documentation-private/issues/&lt;issue-number> and fill in the Review deadline field with an appropriate date.
✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title clearly summarizes the primary change by stating that Azure BYOC cluster creation was missing the registration of one provider and references the relevant issue, making it specific and directly reflective of the changeset.
Linked Issues Check ✅ Passed The changes include adding Microsoft.ContainerService to the prerequisites and provide Azure CLI commands for registering all required resource providers and the EncryptionAtHost feature, fully addressing DOC-1716’s objectives.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1716-Azure-BYOC-cluster-creation-is-missing-registering-1-provider

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5d5deed and 2a7a730.

📒 Files selected for processing (1)
  • modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - rp-cloud
  • GitHub Check: Header rules - rp-cloud
  • GitHub Check: Pages changed - rp-cloud

@micheleRP micheleRP merged commit 8c05eb0 into main Oct 3, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1716-Azure-BYOC-cluster-creation-is-missing-registering-1-provider branch October 3, 2025 15:18
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