terraform-pritunl-provider

README

Terraform Provider for Pritunl VPN Server

• Website: https://www.terraform.io
• Pritunl VPN Server: https://pritunl.com/
• Provider: matthisholleville/pritunl

Requirements

• Terraform >=0.13.x
• Go 1.18.x (to build the provider plugin)

Building The Provider

$ git clone git@github.com:matthisholleville/terraform-provider-pritunl
$ make build

Example usage

Take a look at the examples in the documentation of the registry or use the following example:

# Set the required provider and versions
terraform {
  required_providers {
    pritunl = {
      source  = "matthisholleville/pritunl"
      version = "0.0.1"
    }
  }
}

# Configure the pritunl provider
provider "pritunl" {
  url    = "https://vpn.server.com"
  token  = "api-token"
  secret = "api-secret"
  insecure = false
}

# Create a pritunl organization resource
resource "pritunl_organization" "developers" {
  name = "Developers"
}

# Create a pritunl server resource
resource "pritunl_server" "example" {
  name      = "example"
  port      = 15500
  protocol  = "udp"
  network   = "192.168.1.0/24"
  groups    = [
    "admins",
    "developers",
  ]
  
  # Attach the organization to the server
  organization_ids = [
    pritunl_organization.developers.id,
  ]
}

# Create a pritunl server route
resource "pritunl_route" "example" {
  server_id = pritunl_server.example.id
  nat       = true
  comment   = "my custom route"
  network   = "34.56.43.32/32"
}

Importing exist resources

Describe exist resource in the terraform file first and then import them:

Import an organization:

# Describe a pritunl organization resource
resource "pritunl_organization" "developers" {
  name = "Developers"
}

Execute the shell command:

terraform import pritunl_organization.developers ${ORGANIZATION_ID}
terraform import pritunl_organization.developers 610e42d2a0ed366f41dfe6e8

The organization ID (as well as other resource IDs) can be found in the Pritunl API responses or in the HTML document response.

Import a server:

# Describe a pritunl server resource
resource "pritunl_server" "example" {
  name      = "example"
  port      = 15500
  protocol  = "udp"
  network   = "192.168.1.0/24"
  groups    = [
    "developers",
  ]

  # Attach the organization to the server
  organization_ids = [
    pritunl_organization.developers.id,
  ]
}

Execute the shell command:

terraform import pritunl_server.example ${SERVER_ID}
terraform import pritunl_server.example 60cd0bfa7723cf3c911468a8

Import a route:

# Describe a pritunl route resource
resource "pritunl_route" "example" {
  server_id = pritunl_server.example.id
  nat       = true
  comment   = "my custom route"
  network   = "34.56.43.32/32"
}

Execute the shell command:

terraform import pritunl_route.example server/${SERVER_ID}/route/${ROUTE_ID}
terraform import pritunl_route.example server/631898aacc02a7b9c17c4d4c/route/33342e32332e34332e34322f3332

License

The Terraform Pritunl Provider is available to everyone under the terms of the Mozilla Public License Version 2.0. Take a look the LICENSE file.