Skip to content

[Cloudflare One Appliance] Document self-serve virtual appliance registration in the dashboard#31860

Open
nikitacano wants to merge 5 commits into
productionfrom
ncano/appliance-virtual-self-serve-ui-docs
Open

[Cloudflare One Appliance] Document self-serve virtual appliance registration in the dashboard#31860
nikitacano wants to merge 5 commits into
productionfrom
ncano/appliance-virtual-self-serve-ui-docs

Conversation

@nikitacano

@nikitacano nikitacano commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What changed

A dashboard UI for registering Cloudflare One Virtual Appliance (vMCONN) connectors and generating/rotating their license keys. This complements the existing API/Terraform self-serve workflow documented in #30686.

  • Dev docs: Added a "Register a virtual appliance and generate a license key" section to Configure a Cloudflare One Virtual Appliance, with Dashboard + API tabs covering registration, authentication-key generation, and key rotation.
  • Changelog: Added an entry announcing the new dashboard flow.

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 9069a9a.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

Checks PR title, description, and redirect checklist.

No convention issues found.

Style Guide Review

No style-guide issues found.

Redirects

No missing redirect entries found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/assets/images/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/changelog/cloudflare-one/ @kennyj42, @asamborski, @ranbel, @cloudflare/pm-changelogs, @cloudflare/cf1-reviewers, @elithrar, @cloudflare/product-owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/cloudflare-wan/ @steve-cloudflare, @jeffh-cloudflare, @alpdot, @cloudflare/cf1-reviewers, @elithrar, @cloudflare/product-owners

@ask-bonk

ask-bonk Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Summary

PR #31860 adds documentation for self-serve virtual appliance registration via the dashboard. The changes consist of:

  • A new changelog entry announcing the dashboard UI for registering virtual appliances, generating authentication keys, and rotating keys
  • A new "Register a virtual appliance and generate a license key" section on the Configure Virtual Appliance page with Dashboard + API tabs

Suggested labels

  • documentation
  • cloudflare-wan
  • pm-changelogs

Issues found

Style guide / branding violations:

  1. "VMWare" should be "VMware" (lowercase w) — This is the official product spelling and appears in the page description and inside the <Render> component params (lines 6, 57, 58).

  2. Multi-step dashboard procedure should use <Steps> — The style guide mandates the Steps component for multi-step procedures. The dashboard tab currently uses a raw Markdown numbered list (lines 25-36). Please wrap the dashboard steps in <Steps> for visual consistency with other how-to pages.

Formatting:

  1. Mixed indentation in <Render> params — Lines 51-58 use tabs, while lines 59-78 use spaces. Please use consistent indentation (spaces preferred).

Inline review comments

src/content/docs/cloudflare-wan/configuration/appliance/configure-virtual-appliance.mdx

  • Line 6 (description frontmatter)

    description: Learn how to configure Cloudflare One Virtual Appliance on VMWare ESXi or Proxmox Virtual Environment
    Branding: Change VMWare to VMware.

  • Lines 23-46 (<Tabs> dashboard tab)
    The dashboard procedure is a multi-step flow. Style guide: wrap numbered steps in <Steps> instead of a raw Markdown ordered list.

  • Lines 51-78 (<Render> params)
    Indentation mixes tabs (lines 51-58) and spaces (lines 59-78). Please use consistent indentation.

  • Line 57 (wan param)

    wan: "needs to correspond to the virtual network interface on the Virtual Appliance instance you have set up in VMware. Following our example from the previous steps, you need to choose port ...
    Change VMWare to VMware inside the string.

src/content/changelog/cloudflare-wan/2026-07-02-virtual-appliance-self-serve-ui.mdx

No issues. The changelog entry is well-structured, uses valid frontmatter, references correct directory products (cloudflare-one-appliance, cloudflare-one), and links appropriately to the updated docs page.


Verdict

Approve with minor fixes. The content is accurate and clearly written. Please fix the VMware branding and consider wrapping the dashboard steps in <Steps> before merging.

github run

…stration in the dashboard

SHIP-8935 shipped a dashboard UI for registering Cloudflare One Virtual
Appliance (vMCONN) connectors and generating/rotating their license keys,
complementing the existing API/Terraform self-serve workflow
(#30686).

- Add a "Register a virtual appliance and generate a license key" section
  to the virtual appliance config page, with Dashboard + API tabs covering
  registration, key generation, and key rotation.
- Add a changelog entry announcing the dashboard flow.

Ref: gitlab.cfdata.org/cloudflare/fe/stratus/-/merge_requests/37281
@nikitacano nikitacano force-pushed the ncano/appliance-virtual-self-serve-ui-docs branch from ed9ed3b to d84e463 Compare July 2, 2026 16:30
2026-07-02-mesh-hostname-routing.mdx was only tagged cloudflare-one,
but the entry is specifically about Cloudflare Mesh. Add the mesh
product tag so it also surfaces on Mesh-scoped changelog views.
Hardware appliances require the serial number printed on the physical
device (obtained via account team); virtual appliances only need a
name, since Cloudflare generates the license key. Make that
distinction explicit instead of implying both paths converge on
'Generate authentication key'.
- Wrap the dashboard registration and key-rotation steps in <Steps>
  per the style guide, instead of raw Markdown ordered lists.
- Fix VMWare -> VMware branding in the page description and in the
  pre-existing noConnectorShows Render param (two instances).
- Normalize <Render> params to consistent 2-space indentation
  (previously mixed tabs and spaces).
- Embed a GIF showing the virtual appliance registration and
  authentication-key generation flow.
- Link 'Cloudflare One Virtual Appliance' to the appliance product
  landing page.
@nikitacano nikitacano enabled auto-merge (squash) July 2, 2026 17:16
@TownLake TownLake self-assigned this Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants