Files
cozystack/packages/apps/vpc/README.md
T
Roshan Ramani 1779df2fb3 docs(vpc): generate README parameters from values.yaml
The vpc Makefile never passed -r README.md to cozyvalues-gen, unlike
every other app, so its Parameters table was never regenerated. It
still described subnets as a map after the switch to a list, and the
README example, which also feeds the website reference page, fails
values.schema.json.

Assisted-by: LLM
Signed-off-by: Roshan Ramani <roshanramani.dev@gmail.com>
2026-10-18 20:26:50 +05:30

3.6 KiB

VPC

VPC offers a subset of dedicated subnets with networking services related to it. As the service evolves, it will provide more ways to isolate your workloads.

Service details

To function, the service requires kube-ovn and multus CNI to be present, so by default it will only work on paas-full bundle. Kube-ovn provides VPC and Subnet resources and performs isolation and networking maintenance such as DHCP. Under the hood it uses ovn virtual routers and virtual switches. Multus enables a multi-nic capability, so a pod or a VM could have two or more network interfaces.

Currently every workload will have a connection to a default management network which will also have a default gateway, and the majority of traffic will go through it. VPC subnets are for now an additional dedicated networking spaces.

Deployment notes

VPC name must be unique within a tenant. Subnet name and ip address range must be unique within a VPC. Subnet ip address space must not overlap with the default management network ip address range, subsets of 172.16.0.0/12 are recommended. Currently there are no fail-safe checks, however they are planned for the future.

Different VPCs may have subnets with overlapping ip address ranges.

A VM or a pod may be connected to multiple secondary Subnets at once. Each secondary connection will be represented as an additional network interface.

Parameters

Common parameters

Name Description Type Value
subnets Subnets of a VPC []object []
subnets[i].name Subnet name string ""
subnets[i].cidr IP address range string ""
subnets[i].allowSubnets Additional source CIDRs admitted into this private subnet, such as remote networks routed in through a gateway VM []string []
peers VPC peering connections (bidirectional declaration required) []object []
peers[i].vpcName Logical name of the remote VPC (without "virtualprivatecloud-" prefix) string ""
peers[i].tenantNamespace Namespace of the remote tenant string ""
routes Static routes for the VPC []object []
routes[i].cidr Destination CIDR string ""
routes[i].nextHopIP Next hop IP address string ""

Examples

apiVersion: apps.cozystack.io/v1alpha1
kind: VirtualPrivateCloud
metadata:
  name: vpc00
spec:
  subnets:
    - name: sub00
      cidr: 172.16.0.0/24
    - name: sub01
      cidr: 172.16.1.0/24
    - name: sub02
      cidr: 172.16.2.0/24