This document is describing an outdated version (v4.2.0). Please consider switching to the latest version (v5.8.0).
openvpn-clients job
The openvpn-clients job runs OpenVPN clients, connecting to a remote server.
Use this to establish multiple connections or for more advanced configurations which are unsupported by the openvpn-client job.
Usage
releases:
- name: "openvpn"
version: "4.2.0"
instance_groups:
- name: "openvpn-clients"
jobs:
- name: "openvpn-clients"
release: "openvpn"
properties: {}Properties
The following properties can be configured for the job.
clients
An array of Client Configuration connections
This value is an array of client connections. Each connection must have a
name and config property.
The client name must be a simple string of a-z, 0-9, or dashes.Default
[]
Example
- config: |
remote vpn.aws-us-east-1.staging-snowstorm.internal.example.com 1194 tcp
...snip...
<cert>
...
</cert>
<key>
...
</key>
name: aws-us-east-1
- config: |
remote vpn.google-a1.staging-snowstorm.internal.example.com 1194 tcp
...snip...
<cert>
...
</cert>
<key>
...
</key>
name: google-a1
Runtime
Templates
The following templates are rendered and installed in /var/vcap/jobs/openvpn-clients.
Packages
The job depends on the following packages installed in /var/vcap/packages.