Civo VPC

Deploys an isolated private network (VPC) on Civo Cloud within a specified region. The network can use a custom IPv4 CIDR range or let Civo auto-allocate one, and it exposes connection details that other components such as databases and Kubernetes clusters can reference.

What Gets Created

When you deploy a CivoVpc resource, OpenMCF provisions:

• Civo Network -- a civo_network resource in the target region with the specified label and optional CIDR block
• Resource Labels -- standard OpenMCF labels applied to track the resource name, kind, organization, and environment

Prerequisites

• Civo credentials configured via environment variables or OpenMCF provider config (the civoCredentialId field in the spec must reference a valid credential)
• A target Civo region -- the region must exist and be available on the Civo account (e.g., lon1, fra1, nyc1)

Quick Start

Create a file civo-vpc.yaml:

apiVersion: civo.openmcf.org/v1
kind: CivoVpc
metadata:
  name: my-network
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.CivoVpc.my-network
spec:
  civoCredentialId: my-civo-cred
  networkName: my-network
  region: lon1

Deploy:

openmcf apply -f civo-vpc.yaml

This creates a private network named my-network in the London region with an auto-allocated CIDR block.

Configuration Reference

Required Fields

Optional Fields

Examples

Basic Network with Auto-Allocated CIDR

A minimal private network with Civo handling address allocation:

apiVersion: civo.openmcf.org/v1
kind: CivoVpc
metadata:
  name: dev-network
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.CivoVpc.dev-network
spec:
  civoCredentialId: my-civo-cred
  networkName: dev-network
  region: fra1

Custom CIDR Range

A network with an explicit address range for predictable IP planning:

apiVersion: civo.openmcf.org/v1
kind: CivoVpc
metadata:
  name: staging-network
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: staging.CivoVpc.staging-network
spec:
  civoCredentialId: my-civo-cred
  networkName: staging-network
  region: nyc1
  ipRangeCidr: 10.0.0.0/24
  description: Staging environment private network

Production Network with All Options

A fully specified network intended for production workloads:

apiVersion: civo.openmcf.org/v1
kind: CivoVpc
metadata:
  name: prod-network
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: acme-corp
    pulumi.openmcf.org/project: infra
    pulumi.openmcf.org/stack.name: prod.CivoVpc.prod-network
spec:
  civoCredentialId: prod-civo-cred
  networkName: prod-network
  region: lon1
  ipRangeCidr: 10.10.0.0/24
  isDefaultForRegion: true
  description: Production private network for lon1

Note: isDefaultForRegion is accepted in the manifest but is not applied during provisioning due to a limitation in the Pulumi Civo provider. After deployment, run civo network default <network-id> to set the network as default.

Stack Outputs

After deployment, the following outputs are available in status.outputs:

Note: The createdAtRfc3339 field is defined in the output schema but is not currently populated by the Pulumi Civo provider.

Related Components

• CivoFirewall -- defines firewall rules for controlling network traffic
• CivoKubernetesCluster -- deploys a Kubernetes cluster that can be attached to this network
• CivoDatabase -- provisions a managed database instance connected to this network
• CivoComputeInstance -- launches compute instances within this network