Joao Gilberto Magalhaes b9a9bee0b9 Revamp Swarm example documentation and streamline deployment instructions

- Consolidated and simplified Swarm example README to focus on YAML header comments for documentation.
- Removed redundant and extended sections, replacing with concise steps for getting started.
- Standardized YAML headers across `easyhaproxy.yml`, `services.yml`, and `portainer.yml` with a clearer and more readable format.
- Enhanced user guidance for deployment, setup requirements, verification, and cleanup.

2025-12-04 10:07:17 -05:00

2.1 KiB

Raw Blame History

Kubernetes Examples

Self-contained examples for EasyHAProxy ingress controller. All documentation is in the YAML files as header comments.

Quick Start

Pick an example below
Open the YAML file
Read the header comments for complete instructions
Run the commands step-by-step

Prerequisites

All examples require:

EasyHAProxy installed in your Kubernetes cluster
Node labeled for EasyHAProxy deployment

See header comments in each file for detailed setup instructions.

Basic Examples

File	Description
service.yml	Basic HTTP ingress with multiple domains
service_tls.yml	HTTPS/TLS ingress with custom certificates

Plugin Examples

File	Description
jwt-validator.yml	JWT token validation for API protection
ip-whitelist.yml	IP whitelist for admin panels or sensitive services
cloudflare.yml	Restore real client IPs when behind Cloudflare CDN
plugins-combined.yml	Multiple plugins combined for layered security

Documentation Structure

Each YAML file contains:

WHAT THIS DEMONSTRATES - Key features and concepts
REQUIREMENTS - Idempotent setup commands (safe to run multiple times)
HOW TO START - Command to apply the manifest
HOW TO VERIFY IT'S WORKING - Test commands with expected outputs
CLEAN UP - Commands to remove resources

2.1 KiB Raw Blame History