terraform-provider-openvswitch

Terraform OpenVSwitch Provider

A Terraform provider for managing local Open vSwitch bridges and ports.

✅ Compatible with both Terraform and OpenTofu

Features

• Manage OVS bridges with OpenFlow protocol configuration
• Create and configure ports on bridges
• Support for tap devices and port actions
• Input validation for OpenFlow versions and port actions
• Works with Terraform 1.6+ and OpenTofu 1.6+

Requirements

• Go 1.22 or later
• Open vSwitch installed and running
• Root/sudo access (required for ovs-vsctl, ovs-ofctl, and ip commands)

Quick Start

provider "openvswitch" {}

resource "openvswitch_bridge" "br0" {
  name      = "testbr0"
  ofversion = "OpenFlow13"  # Optional: OpenFlow10-15
}

resource "openvswitch_port" "port" {
  name      = "port0"
  bridge_id = openvswitch_bridge.br0.name
  ofversion = "OpenFlow13"
  action    = "up"  # Optional: up, down, flood, etc.
}

Resources

openvswitch_bridge

Creates and manages an Open vSwitch bridge.

Arguments:

• name (Required) - Bridge name
• ofversion (Optional) - OpenFlow version: OpenFlow10, OpenFlow11, OpenFlow12, OpenFlow13 (default), OpenFlow14, or OpenFlow15

openvswitch_port

Creates and manages a port on an OVS bridge.

Arguments:

• name (Required) - Port name
• bridge_id (Required) - Name of the bridge to attach to
• ofversion (Optional) - OpenFlow version (default: OpenFlow13)
• action (Optional) - Port action: up (default), down, stp, no-stp, receive, no-receive, no-receive-stp, forward, no-forward, flood, no-flood, packet-in, or no-packet-in

Installation

From Source

git clone https://github.com/trvon/terraform-provider-openvswitch.git
cd terraform-provider-openvswitch
make build

Binary will be created at bin/terraform-provider-openvswitch.

Development Setup

For local development and testing, see DEVELOPMENT.md.

Testing

Unit Tests

go test ./...

Acceptance Tests

Requires Open vSwitch and root access:

sudo -E TF_ACC=1 go test ./openvswitch -v

Or using Make:

sudo -E make testacc

Linting

# Install golangci-lint
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# Run linters
golangci-lint run ./...

CI/CD

GitHub Actions runs on every push and PR:

• ✅ Lint - golangci-lint with 20+ linters, go vet, gofmt
• ✅ Security - govulncheck, race detector
• ✅ Unit Tests - with coverage reporting
• ✅ Acceptance Tests - in OVS container
• ✅ Integration Tests - matrix testing with Terraform 1.6/1.10 and OpenTofu 1.6/1.8

OpenTofu Compatibility

This provider works seamlessly with both Terraform and OpenTofu using the same binary. The plugin protocol is identical, so no special configuration is needed.

Tested versions:

• Terraform: 1.6.0, 1.10.5
• OpenTofu: 1.6.0, 1.8.10

Important Notes

⚠️ Sudo Required: All OVS operations require root privileges. Ensure your user can run sudo commands.

⚠️ Tap Devices: Ports create tap devices that are not persistent across reboots.

Examples

See the examples directory for complete working examples:

• sample-bridge - Terraform example
• opentofu-sample - OpenTofu example

Contributing

Contributions welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Ensure tests pass: make build && go test ./...
5. Ensure linting passes: golangci-lint run ./...
6. Submit a pull request

License

Apache License 2.0 - see LICENSE for details.

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

Project Status

Active Development - The provider is functional and tested. Current focus:

• ✅ Code quality improvements (completed)
• ✅ Comprehensive linting and testing (completed)
• ✅ OpenTofu compatibility verification (completed)
• 🔄 SDK migration to terraform-plugin-sdk/v2 (planned)
• 🔄 Expanded test coverage (in progress)