# HAProxy operator

The HAProxy operator is an open-source software operator that deploys and operates HAProxy 3.2 on Juju 3.6 and above.
HAProxy is an open-source reverse proxy that provides fast, efficient, and reliable proxying for TCP
and HTTP-based applications.

The charm provides a managed ingress entry point for backend applications, handling secure traffic routing and load balancing. It also offers advanced features such as TLS, monitoring and high-availability.

This operator is built for **IaaS/VM** and is not supported in **Kubernetes** environments.

## In this documentation

|                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Get started**               | [Deploy the HAProxy charm](https://canonical.com/juju/docs/haproxy-charm/latest/tutorial/getting-started/index.html.md#tutorial-getting-started)                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **Deployment**                | [Configure high availability](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/configure-high-availability/index.html.md#how-to-configure-high-availability) | [Control backend routing](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/control-haproxy-route-relation-data/index.html.md#how-to-control-haproxy-route-relation-data) | [Add to existing Terraform project](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/deploy-with-terraform/index.html.md#how-to-deploy-with-terraform)                                                                                                                                                                                      |
| **Integrations**              | [Relation endpoints](https://canonical.com/juju/docs/haproxy-charm/latest/reference/relation-endpoints/index.html.md#reference-relation-endpoints) | [Integrate with non-charmed workloads](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/integrate-with-non-charm-workload/index.html.md#how-to-integrate-with-non-charm-workload) | [Configure ingress requirers](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/provide-extra-configurations-for-ingress-requirer-charms/index.html.md#how-to-provide-extra-configurations-for-ingress-requirer-charms)                                                                                                                                                             |
| **Other supported protocols** | [FTP](https://canonical.com/juju/docs/haproxy-charm/latest/reference/ftp-support/index.html.md#reference-ftp-support) | [gRPC](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/loadbalancing-for-a-grpc-server/index.html.md#how-to-loadbalancing-for-a-grpc-server) | [HTTP/2](https://canonical.com/juju/docs/haproxy-charm/latest/reference/http2-support/index.html.md#reference-http2-support)                                                                                                                                                                                                                                                                                  |
| **Security**                  | [Overview](https://canonical.com/juju/docs/haproxy-charm/latest/explanation/security/index.html.md#explanation-security) | [Enable DDoS protection](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/enable-ddos-protection/index.html.md#how-to-enable-ddos-protection) | [Protect a hostname](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/protect-hostname-spoe-auth/index.html.md#how-to-protect-hostname-spoe-auth) | [Configure HTTPS backend protocol](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/configure-backend-protocol/index.html.md#how-to-configure-backend-protocol) | [Hash client IP addresses in logs](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/hash-client-ip-addresses-in-logs/index.html.md#how-to-hash-client-ip-addresses-in-logs) |

## How this documentation is organized

This documentation uses the
[Diátaxis documentation structure](https://diataxis.fr/).

* The [Tutorial](https://canonical.com/juju/docs/haproxy-charm/latest/tutorial/index.html.md#tutorial-index) takes you step-by-step through a basic deployment of the HAProxy charm.
* The [How-to guides](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/index.html.md#how-to-index) cover practical tasks for configuring, integrating, and maintaining your HAProxy deployment.
* [Reference](https://canonical.com/juju/docs/haproxy-charm/latest/reference/index.html.md#reference-index) provides technical details on supported server protocols and authentication.
* [Explanation](https://canonical.com/juju/docs/haproxy-charm/latest/explanation/index.html.md#explanation-index) includes context and overviews on security and high availability.

## Project and community

The HAProxy 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.

- [Code of conduct](https://ubuntu.com/community/docs/ethos/code-of-conduct)
- [File a bug](https://github.com/canonical/haproxy-operator/issues)
- Get support through the [Discourse forum](https://discourse.charmhub.io/)
- Join our [online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
- [Contribute](https://canonical.com/juju/docs/haproxy-charm/latest/how-to/contribute/index.html.md#how-to-contribute)

Thinking about using the HAProxy operator for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!
