firezone-gateway

Ansible role to install and configure a Firezone gateway.

Sponsor

Building and improving this Ansible role have been sponsored by my current and previous employers like Cloudpunks GmbH and Proact Deutschland GmbH.

Table of contents

• Requirements
• Default Variables
  • firezone_gateway_caps
  • firezone_gateway_devices
  • firezone_gateway_ident
  • firezone_gateway_image
  • firezone_gateway_log_level
  • firezone_gateway_name
  • firezone_gateway_network
  • firezone_gateway_no_telemetry
  • firezone_gateway_num_tun_threads
  • firezone_gateway_pull_image
  • firezone_gateway_sysctls
  • firezone_gateway_token
  • firezone_gateway_version
• Discovered Tags
• Dependencies
• License
• Author

---

Requirements

• Minimum Ansible version: 2.10

Default Variables

firezone_gateway_caps

List of capability settings

Default value

firezone_gateway_caps:
  - NET_ADMIN

firezone_gateway_devices

List of required devices

Default value

firezone_gateway_devices:
  - /dev/net/tun:/dev/net/tun

firezone_gateway_ident

Identifier of the firezone gateway

Default value

firezone_gateway_ident:

firezone_gateway_image

Docker image to use and run

Default value

firezone_gateway_image: ghcr.io/firezone/gateway:{{ firezone_gateway_version }}

firezone_gateway_log_level

Log level of the forezone gateway

Default value

firezone_gateway_log_level: info

firezone_gateway_name

Name of the firezone gateway

Default value

firezone_gateway_name: '{{ inventory_hostname }}'

firezone_gateway_network

A Docker network to assign the container

Default value

firezone_gateway_network:

firezone_gateway_no_telemetry

Disable telemtry collection

Default value

firezone_gateway_no_telemetry: false

firezone_gateway_num_tun_threads

Number of TUN threads

Default value

firezone_gateway_num_tun_threads: 1

firezone_gateway_pull_image

Pull image as part of the tasks

Default value

firezone_gateway_pull_image: true

firezone_gateway_sysctls

List of sysctl settings

Default value

firezone_gateway_sysctls:
  - net.ipv4.ip_forward=1
  - net.ipv4.conf.all.src_valid_mark=1
  - net.ipv6.conf.all.disable_ipv6=0
  - net.ipv6.conf.all.forwarding=1
  - net.ipv6.conf.default.forwarding=1

firezone_gateway_token

Token of the firezone gateway

Default value

firezone_gateway_token:

firezone_gateway_version

Version of the Docker image

Default value

firezone_gateway_version: 1.5.0

Discovered Tags

firezone-gateway

Dependencies

• rolehippie.docker
• community.docker

License

Apache-2.0

Author

Thomas Boerger