This document is describing an outdated version (v4.2.0). Please consider switching to the latest version (v5.8.0).

openvpn-client job

The openvpn-client job runs an OpenVPN client, connecting to a remote server.

Usage

releases:
- name: "openvpn"
  version: "4.2.0"
instance_groups:
- name: "openvpn-client"
  jobs:
  - name: "openvpn-client"
    release: "openvpn"
    properties: {}

Properties

The following properties can be configured for the job.

device

Virtual network device to use
Default
tun1

extra_config

Custom OpenVPN configuration statements (see manual)
Default
null

extra_configs

A list of custom OpenVPN configuration statements (see manual)
Default
[]

tls_client

Certificate and Private Key for the server
Example
certificate: |
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----
private_key: |
  -----BEGIN RSA PRIVATE KEY-----
  ...
  -----END RSA PRIVATE KEY-----

Consumed Links

The job consumes the following links.

server (openvpn)

Runtime

Templates

The following templates are rendered and installed in /var/vcap/jobs/openvpn-client.

Packages

The job depends on the following packages installed in /var/vcap/packages.

Source

Based on jobs/openvpn-client/spec (source, YAML, JSON).