From 0052cc320aecf0e70ea9c508b077eb45265f8e8b Mon Sep 17 00:00:00 2001 From: Joao Gilberto Magalhaes Date: Fri, 15 Nov 2024 20:16:14 -0600 Subject: [PATCH] Minor text adjustments --- docs/docker.md | 12 ++++++++---- docs/kubernetes.md | 3 ++- docs/swarm.md | 2 +- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/docker.md b/docs/docker.md index b35ae23..ffa139c 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -2,15 +2,19 @@ ## Setup Docker EasyHAProxy -This method involves using a standalone Docker installation to discover containers and configure HAProxy. +This method involves using a standalone Docker installation to discover containers +and configure HAProxy. -EasyHAProxy inspects Docker containers and retrieves labels to configure HAProxy. Once it identifies a container with at least the label 'easyhaproxy.http.host,' it configures HAProxy to redirect traffic to that container. To accomplish this, EasyHAProxy may need to attach the same network to its container. +EasyHAProxy inspects Docker containers and retrieves labels to configure HAProxy. +Once it identifies a container with at least the label 'easyhaproxy.http.host,' +it configures HAProxy to redirect traffic to that container. +To accomplish this, EasyHAProxy may need to attach the same network to its container. -It's recommended to create a network external to EasyHAProxy. +It's recommended to create a network external to EasyHAProxy, although it's not mandatory. Limitations: - You cannot mix Docker containers with Swarm containers. - - This method does not work with containers that use the '--network=host' option. + - This method does not work with containers that use the '--network=host' option. (see [limitations](limitations.md)) e.g.: diff --git a/docs/kubernetes.md b/docs/kubernetes.md index bd2526a..72471fb 100644 --- a/docs/kubernetes.md +++ b/docs/kubernetes.md @@ -9,7 +9,8 @@ EasyHAProxy immediately sets up HAProxy and begins serving traffic. For Kubernetes installations, there are three available installation modes: - DaemonSet: This mode exposes ports 80, 443, and 1936. - NodePort: Ports 31080, 31443, and 31936 are exposed. -- ClusterIP: In this mode, no ports are exposed externally, and HAProxy is accessible only within the cluster. +- ClusterIP: In this mode, no ports are exposed externally, and HAProxy is accessible only + within the cluster. To install EasyHAProxy in your Kubernetes cluster, follow these steps: diff --git a/docs/swarm.md b/docs/swarm.md index 30bf810..5c0b8c2 100644 --- a/docs/swarm.md +++ b/docs/swarm.md @@ -16,7 +16,7 @@ It's recommended to create a network external to EasyHAProxy. Limitations: - You cannot mix Docker containers with Swarm containers. - - This method does not work with containers that use the '--network=host' option." + - This method does not work with containers that use the '--network=host' option. (see [limitations](limitations.md)) e.g.: