WireGuard gateway operator¶
A Juju charm deploying a highly available, high-performance site-to-site VPN based on WireGuard.
Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For the Charmed WireGuard gateway, this includes:
Automatic WireGuard key exchange and interface management
Automatic route management and fault tolerance using OSPF on BIRD
Virtual redundant routing using VRRP on Keepalived
This charm will make operating highly available, high-performance site-to-site VPN simple and straightforward for DevOps or SRE teams through Juju’s clean interface.
In this documentation¶
Get started |
|
Operations |
|
Observability |
|
Design |
|
Security |
How this documentation is organized¶
This documentation uses the Diátaxis documentation structure.
The Tutorial takes you step-by-step through deploying and peering two WireGuard gateway charms.
The How-to guides cover practical tasks for integrating, maintaining, and upgrading your WireGuard gateway deployment.
Reference provides technical details on the charm’s actions, configurations, integrations, metrics, and architecture.
Explanation includes context and discussion of key topics, such as security.
Contributing to this documentation¶
Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions, and constructive feedback on our documentation. See How to contribute for more information.
If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.
Project and community¶
The WireGuard gateway operator is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.
Thinking about using the WireGuard gateway operator for your next project? Get in touch!