Kvindo™ Cloud Docs
A VPC Peering External Peer is the non-Kvindo side of a VPC Peering — a network outside Kvindo Cloud (another provider, or on-premises). Kvindo establishes an encrypted tunnel to the peer's router over SSH and advertises the given CIDRs across it.
• VPC Peering — the peering this external side joins (spec.vpcPeeringId)
• SSH access — how Kvindo reaches the remote router: user, IP, port, and an optional SSH Private Key
• Advertised CIDRs — the remote networks made reachable from the Kvindo side (spec.ipV4Cidrs)
• Private IPv4 — the tunnel address of the remote endpoint (spec.privateIpV4)
28079, exposing a
/metrics endpoint with peer ids/IPs and per-direction tunnel health. It is
reachable only from the private network (not from the public internet).
spec.addons is optional and empty by default, and this
is the one place an addon installs software on a machine you own — so it is an explicit
per-host choice and never something a peering-wide setting can reach. Today the catalog offers
node_exporter 1.12.1, serving /metrics on spec.privateIpV4
at port 9100, reported back as status.nodeExporterEndpoint. The bind
address must be a private (RFC1918) IPv4 whenever an addon is declared — the exporter does not
authenticate, so a public or wildcard address would publish this machine's host metrics. Removing
an entry is a real instruction: the next reconcile stops the unit and deletes the binary.
| UI Name | API / kc name | Terraform name | Optional | Format | Default | Is read only | Description |
|---|---|---|---|---|---|---|---|
| VPC Peering | spec.vpcPeeringId |
spec.vpc_peering_id |
No | ULID — references a VPC Peering | — | No | The peering this external side joins |
| SSH Private Key | spec.sshPrivateKeyId |
spec.ssh_private_key_id |
No | ULID — references an SSH Private Key | — | No | Key used to reach the remote router |
| SSH User | spec.sshUser |
spec.ssh_user |
No | string | — | No | SSH user on the remote router — no server-side default, set it explicitly (typically root) |
| SSH Port | spec.sshPort |
spec.ssh_port |
Yes | integer (0–65535) | — | No | SSH port on the remote router — no server-side default, set it explicitly (typically 22) |
| SSH IPv4 | spec.sshIpV4 |
spec.ssh_ipv4 |
No | string — IPv4 | — | No | Address Kvindo connects to over SSH |
| Private IPv4 | spec.privateIpV4 |
spec.private_ipv4 |
No | string — IPv4 | — | No | Tunnel address of the remote endpoint |
| Advertised CIDRs | spec.ipV4Cidrs |
spec.ipv4_cidrs |
No | list of string — CIDR | — | No | Remote networks advertised to the Kvindo side |
| Addons | spec.addons |
spec.addons |
No | list of {name, version} | [] | Yes | Optional metrics sidecars installed on THIS machine (yours). Empty = none. Requires a private spec.privateIpV4 |
• SSH IPv4 and Private IPv4 must be a bare IPv4 address (no CIDR suffix)
• Every entry in Advertised CIDRs must parse as a valid CIDR
• 0.0.0.0/0 is refused as an advertised CIDR
• When Addons is non-empty, Private IPv4 must be an RFC1918 address (10/8, 172.16/12, 192.168/16) — a public or wildcard bind is refused
A peering plus an external peer reachable over SSH, advertising a remote 10.20.0.0/16 network. This standalone example exists because external peering requires a real remote SSH endpoint rather than something the shared Networking guide's mock-mode walkthrough can safely create — external peering is also covered in each guide's own External peers section.
Terraform
Python SDK
kc CLI
Resource docs
Examples
More in this section