Skip to content

docs: Add on-prem Cloud claim URL guidance to claim README - #23379

Draft
nedi-app[bot] wants to merge 1 commit into
masterfrom
docs/netdata-parent-cloud-onprem-communication
Draft

docs: Add on-prem Cloud claim URL guidance to claim README#23379
nedi-app[bot] wants to merge 1 commit into
masterfrom
docs/netdata-parent-cloud-onprem-communication

Conversation

@nedi-app

@nedi-app nedi-app Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Add on-prem Cloud claim URL guidance to claim README. Files changed: src/aclk/README.md, src/claim/README.md.

User Request

how does netdata parent node communicate with netdata cloud on-prem cluster? no Netdata SaaS is expected

Prompt (English)

How a Netdata Parent node communicates with a self-hosted Netdata Cloud installation in an on-prem Kubernetes cluster (no SaaS)

Reason for Change

This change applies the specific user request using repository-truth evidence from the audit execution workspace.


Summary by cubic

Add clear instructions for connecting Agents and Parent nodes to a self-hosted Netdata Cloud On-Prem by setting the claim URL to the on‑prem base URL and allowlisting only on‑prem endpoints. Clarifies that ACLK connects outbound to your on‑prem Cloud over WSS/MQTT on port 443 and never uses SaaS domains, with links to on‑prem deployment docs.

Updates: src/claim/README.md, src/aclk/README.md.

Written for commit 9666eb4. Summary will update on new commits.

Review in cubic

…odes to a self-hosted Netdata Cloud On-Prem deployment (no SaaS). In src/claim/README.md, a new 'Connecting to Netdata Cloud On-Prem (self-hosted)' section documents that claiming uses the same ACLK mechanism with only the target URL changed (claim.conf url / NETDATA_CLAIM_URL set to the on-prem Cloud base URL), and that the ACLK then connects outbound (WSS / MQTT-over-WebSocket, port 443) to the on-prem installation, not the SaaS domains. In src/aclk/README.md, a new 'Allowlisting for Netdata Cloud On-Prem' subsection clarifies that on-prem allowlisting uses the customer's own installation domains, not app.netdata.cloud/api.netdata.cloud/mqtt.netdata.cloud. The on-prem-specific Helm chart setting and infrastructure component names (Traefik/EMQX) from the plan guidance were not verifiable from this checkout (netdata-cloud-onprem repo is not present and its public docs URL returns 404), so per the docs-writing policy those are described at the behavioral level and deferred to the linked on-prem deployment docs.
@nedi-app nedi-app Bot added the nedi-audit PRs created by the nedi-audit pipeline label Aug 3, 2026
@sonarqubecloud

sonarqubecloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

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

Labels

area/aclk area/claim area/docs nedi-audit PRs created by the nedi-audit pipeline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants