- Introduced multiple detailed plugin examples for Cloudflare IP restoration, IP whitelisting, JWT validation, and combined usage. - Added configurations for `docker-compose`, `Kubernetes`, and `Swarm` showcasing individual and multi-plugin use cases. - Included clear prerequisites, setup steps, and testing procedures for each example. - Documented advanced scenarios like path blocking, custom IP lists, and JWT validation for production environments. |
||
|---|---|---|
| .. | ||
| cloudflare.yml | ||
| ip-whitelist.yml | ||
| jwt-validator.yml | ||
| plugins-combined.yml | ||
| README.md | ||
| service.yml | ||
| service_tls.yml | ||
Kubernetes Examples
This directory contains Kubernetes manifest examples demonstrating EasyHAProxy ingress configurations.
Prerequisites
-
EasyHAProxy installed in your cluster:
kubectl create namespace easyhaproxy kubectl apply -f https://raw.githubusercontent.com/byjg/docker-easy-haproxy/4.6.0/deploy/kubernetes/easyhaproxy-daemonset.yml -
Label the node where EasyHAProxy will run:
kubectl label nodes <node-name> "easyhaproxy/node=master"
See the Kubernetes Guide for complete installation instructions.
Examples Overview
1. Basic Ingress (service.yml)
What it demonstrates:
- Basic ingress configuration
- Multiple domains pointing to same service
- Complete deployment + service + ingress setup
Components:
- Deployment:
byjg/static-httpservercontainer - Service: ClusterIP exposing port 8080
- Ingress: Routes for
example.organdwww.example.org
Apply:
kubectl apply -f service.yml
Test:
# If using NodePort or port-forward:
curl -H "Host: example.org" http://<node-ip>:31080
# Or port-forward for testing:
kubectl port-forward -n easyhaproxy deployment/easyhaproxy 8080:80
curl -H "Host: example.org" http://localhost:8080
Manifest breakdown:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress # Required!
name: container-example
spec:
rules:
- host: example.org # First domain
http:
paths:
- backend:
service:
name: container-example
port:
number: 8080
- host: www.example.org # Second domain (same service)
...
2. TLS/SSL Ingress (service_tls.yml)
What it demonstrates:
- HTTPS/TLS configuration
- Custom SSL certificates via Kubernetes secrets
- SSL redirect (HTTP → HTTPS)
- Certbot/Let's Encrypt integration
Components:
- Secret: Custom SSL certificate for
host2.local - Ingress: TLS configuration + certbot annotation
Apply:
kubectl apply -f service_tls.yml
Features:
-
Custom SSL Certificate:
apiVersion: v1 kind: Secret metadata: name: host2-tls data: tls.crt: <base64-encoded-certificate> tls.key: <base64-encoded-private-key> type: kubernetes.io/tls -
Ingress TLS Configuration:
spec: tls: - hosts: - host2.local secretName: host2-tls # References the secret above -
Certbot/Let's Encrypt:
metadata: annotations: easyhaproxy.certbot: 'true' easyhaproxy.redirect_ssl: 'true'
Test:
# Test HTTPS (if host2.local in /etc/hosts)
curl -k https://host2.local
# Test HTTP redirect
curl -I http://host2.local
# Should return: HTTP/1.1 301 Moved Permanently
Kubernetes Annotations Reference
All annotations are applied at the Ingress level and affect all hosts in that ingress.
Required Annotation
| Annotation | Description | Example |
|---|---|---|
kubernetes.io/ingress.class |
Activates EasyHAProxy | easyhaproxy-ingress |
Optional Annotations
| Annotation | Description | Default | Example |
|---|---|---|---|
easyhaproxy.redirect_ssl |
Force HTTPS redirect | false |
'true' |
easyhaproxy.certbot |
Enable Let's Encrypt | false |
'true' |
easyhaproxy.mode |
Protocol mode | http |
http or tcp |
easyhaproxy.listen_port |
Override listen port | 80 |
8080 |
easyhaproxy.plugins |
Enable plugins | - | cloudflare,deny_pages |
See Kubernetes Guide for complete reference.
Common Use Cases
Use Case 1: Simple HTTP Application
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
name: my-app
spec:
rules:
- host: myapp.example.com
http:
paths:
- backend:
service:
name: my-app-service
port:
number: 8080
pathType: ImplementationSpecific
Use Case 2: HTTPS with Let's Encrypt
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
easyhaproxy.certbot: 'true'
easyhaproxy.redirect_ssl: 'true'
name: secure-app
spec:
rules:
- host: secure.example.com
http:
paths:
- backend:
service:
name: secure-app-service
port:
number: 8080
pathType: ImplementationSpecific
Requirements for Let's Encrypt:
- Cluster must be publicly accessible on ports 80 and 443
- DNS must point to cluster IP
- Configure certbot email:
# Via Helm: helm upgrade ingress byjg/easyhaproxy \ --set easyhaproxy.certbot.email=your-email@example.com # Or via environment variable in manifest
Use Case 3: Custom SSL Certificate
---
apiVersion: v1
kind: Secret
metadata:
name: my-tls-secret
type: kubernetes.io/tls
data:
tls.crt: LS0tLS1CRUdJTi... # base64 encoded certificate
tls.key: LS0tLS1CRUdJTi... # base64 encoded private key
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
name: custom-ssl-app
spec:
tls:
- hosts:
- myapp.example.com
secretName: my-tls-secret
rules:
- host: myapp.example.com
http:
paths:
- backend:
service:
name: my-app-service
port:
number: 8080
pathType: ImplementationSpecific
Use Case 4: Using Plugins (JWT, IP Whitelist, etc.)
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
# Enable plugins
easyhaproxy.plugins: "jwt_validator,deny_pages"
# Configure JWT validator
easyhaproxy.plugin.jwt_validator.algorithm: "RS256"
easyhaproxy.plugin.jwt_validator.issuer: "https://auth.example.com/"
easyhaproxy.plugin.jwt_validator.audience: "https://api.example.com"
easyhaproxy.plugin.jwt_validator.pubkey_path: "/etc/haproxy/jwt_keys/api_pubkey.pem"
# Configure deny_pages
easyhaproxy.plugin.deny_pages.paths: "/admin,/private"
name: secure-api
spec:
rules:
- host: api.example.com
http:
paths:
- backend:
service:
name: api-service
port:
number: 8080
pathType: ImplementationSpecific
See Using Plugins with Kubernetes for more examples.
Plugin Examples
JWT Validator Plugin
Complete example with JWT validation for API protection:
---
# Create ConfigMap with public key
apiVersion: v1
kind: ConfigMap
metadata:
name: jwt-keys
namespace: default
data:
api_pubkey.pem: |
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...
-----END PUBLIC KEY-----
---
# Mount public key into EasyHAProxy pod
# Add this to your EasyHAProxy deployment:
# volumeMounts:
# - name: jwt-keys
# mountPath: /etc/haproxy/jwt_keys
# volumes:
# - name: jwt-keys
# configMap:
# name: jwt-keys
---
apiVersion: v1
kind: Service
metadata:
name: api-service
namespace: default
spec:
ports:
- port: 8080
selector:
app: api
type: ClusterIP
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: api
namespace: default
spec:
replicas: 3
selector:
matchLabels:
app: api
template:
metadata:
labels:
app: api
spec:
containers:
- name: api
image: my-api:latest
ports:
- containerPort: 8080
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
# Enable JWT validator
easyhaproxy.plugins: "jwt_validator"
easyhaproxy.plugin.jwt_validator.algorithm: "RS256"
easyhaproxy.plugin.jwt_validator.issuer: "https://auth.example.com/"
easyhaproxy.plugin.jwt_validator.audience: "https://api.example.com"
easyhaproxy.plugin.jwt_validator.pubkey_path: "/etc/haproxy/jwt_keys/api_pubkey.pem"
name: api-ingress
namespace: default
spec:
rules:
- host: api.example.com
http:
paths:
- backend:
service:
name: api-service
port:
number: 8080
pathType: ImplementationSpecific
Test:
# Without JWT token - should fail
curl http://api.example.com/users
# Response: Missing Authorization HTTP header
# With valid JWT token
TOKEN="eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
curl -H "Authorization: Bearer $TOKEN" http://api.example.com/users
# Response: Success
Cloudflare IP Restoration Plugin
Restore original visitor IPs when behind Cloudflare:
---
# Create ConfigMap with Cloudflare IP ranges
apiVersion: v1
kind: ConfigMap
metadata:
name: cloudflare-ips
namespace: easyhaproxy
data:
cloudflare_ips.lst: |
173.245.48.0/20
103.21.244.0/22
103.22.200.0/22
103.31.4.0/22
141.101.64.0/18
108.162.192.0/18
190.93.240.0/20
188.114.96.0/20
197.234.240.0/22
198.41.128.0/17
162.158.0.0/15
104.16.0.0/13
104.24.0.0/14
172.64.0.0/13
131.0.72.0/22
---
# Mount ConfigMap into EasyHAProxy pod
# Add this to your EasyHAProxy deployment:
# volumeMounts:
# - name: cloudflare-ips
# mountPath: /etc/haproxy/cloudflare_ips.lst
# subPath: cloudflare_ips.lst
# volumes:
# - name: cloudflare-ips
# configMap:
# name: cloudflare-ips
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
# Enable Cloudflare plugin
easyhaproxy.plugins: "cloudflare"
name: webapp-ingress
namespace: default
spec:
rules:
- host: myapp.example.com
http:
paths:
- backend:
service:
name: webapp-service
port:
number: 8080
pathType: ImplementationSpecific
Download latest Cloudflare IPs:
curl https://www.cloudflare.com/ips-v4
curl https://www.cloudflare.com/ips-v6
IP Whitelist Plugin
Restrict admin panel to office IPs only:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
# Enable IP whitelist
easyhaproxy.plugins: "ip_whitelist"
easyhaproxy.plugin.ip_whitelist.allowed_ips: "203.0.113.0/24,198.51.100.42"
easyhaproxy.plugin.ip_whitelist.status_code: "403"
name: admin-ingress
namespace: default
spec:
rules:
- host: admin.example.com
http:
paths:
- backend:
service:
name: admin-service
port:
number: 8080
pathType: ImplementationSpecific
Test:
# From allowed IP (203.0.113.50)
curl http://admin.example.com
# Response: Success
# From blocked IP
curl http://admin.example.com
# Response: HTTP 403 Forbidden
Multiple Plugins Combined
Combine Cloudflare + JWT + Path Blocking for maximum security:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
kubernetes.io/ingress.class: easyhaproxy-ingress
# Enable multiple plugins
easyhaproxy.plugins: "cloudflare,jwt_validator,deny_pages"
# Cloudflare - restore real IPs
# (no config needed if using default path)
# JWT Validator - validate tokens
easyhaproxy.plugin.jwt_validator.algorithm: "RS256"
easyhaproxy.plugin.jwt_validator.issuer: "https://auth.example.com/"
easyhaproxy.plugin.jwt_validator.audience: "https://api.example.com"
easyhaproxy.plugin.jwt_validator.pubkey_path: "/etc/haproxy/jwt_keys/api_pubkey.pem"
# Deny Pages - block sensitive paths
easyhaproxy.plugin.deny_pages.paths: "/internal,/debug,/admin"
easyhaproxy.plugin.deny_pages.status_code: "404"
name: secure-api-ingress
namespace: production
spec:
rules:
- host: api.example.com
http:
paths:
- backend:
service:
name: api-service
port:
number: 8080
pathType: ImplementationSpecific
Plugin execution order:
- Cloudflare IP restoration (sets correct visitor IP)
- Deny Pages (blocks blacklisted paths)
- JWT Validator (validates authentication)
Creating SSL Secrets
From Certificate Files
kubectl create secret tls my-tls-secret \
--cert=path/to/cert.crt \
--key=path/to/cert.key \
-n default
From PEM File
# Extract certificate and key
openssl x509 -in cert.pem -out cert.crt
openssl rsa -in cert.pem -out cert.key
# Create secret
kubectl create secret tls my-tls-secret \
--cert=cert.crt \
--key=cert.key \
-n default
Generate Self-Signed Certificate for Testing
openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
-keyout tls.key -out tls.crt \
-subj "/CN=myapp.example.com"
kubectl create secret tls my-tls-secret \
--cert=tls.crt \
--key=tls.key
Troubleshooting
Ingress Not Detected
Check annotation:
kubectl get ingress <name> -o yaml | grep annotations -A 5
Ensure kubernetes.io/ingress.class: easyhaproxy-ingress is present.
Check EasyHAProxy logs:
kubectl logs -n easyhaproxy deployment/easyhaproxy -f
SSL Certificate Not Loading
Verify secret exists:
kubectl get secret <secret-name> -o yaml
Check secret has correct fields:
tls.crt: base64-encoded certificatetls.key: base64-encoded private key
Check EasyHAProxy logs for certificate loading errors.
Let's Encrypt Fails
Requirements:
- Ports 80 and 443 must be publicly accessible
- DNS must resolve to cluster IP
- Certbot email must be configured
Check certbot logs:
kubectl logs -n easyhaproxy deployment/easyhaproxy | grep certbot
Changes Not Applied
EasyHAProxy watches ingress changes automatically. If changes aren't applied:
-
Check discovery interval:
# Default is 10 seconds, increase if needed EASYHAPROXY_REFRESH: "30" -
Force reload:
kubectl rollout restart -n easyhaproxy deployment/easyhaproxy
Tips
-
Local Testing: Add entries to
/etc/hosts:<node-ip> example.org www.example.org host2.local -
View HAProxy Config:
kubectl exec -n easyhaproxy deployment/easyhaproxy -- cat /etc/haproxy/haproxy.cfg -
Access Stats Interface:
kubectl port-forward -n easyhaproxy deployment/easyhaproxy 1936:1936 # Open: http://localhost:1936 -
Debug Mode: Enable debug logging:
env: - name: EASYHAPROXY_LOG_LEVEL value: DEBUG