Enhance documentation with Docusaurus features and fix inaccuracies
Verified against source code and enhanced with Docusaurus markdown features: Documentation Accuracy Fixes: - Fixed acme.md: Added "letsencrypt" as valid AUTOCONFIG value (was incorrectly shown as "-") - Added reference to ACME docs from environment-variable.md - Verified all features against actual implementation in /src Docusaurus Enhancements Added: - Admonitions (:::note, :::tip, :::warning, :::danger, :::info) for important callouts - Code block titles for all bash/yaml examples (e.g., title="Install EasyHAProxy") - Better structured warnings and notes for limitations - Improved formatting and readability throughout Files Enhanced: - kubernetes.md: Added info boxes, warnings, code titles - docker.md: Added limitation warnings, code titles - swarm.md: Added advantage tips, limitation warnings - acme.md: Fixed Let's Encrypt autoconfig, enhanced requirements with admonitions - ssl.md: Added code block titles for all examples - static.md: Added live reload tip, SSL certificate note - container-labels.md: Added definition explanation, code titles - limitations.md: Restructured with clear warnings and explanations - helm.md: Added warnings, code titles - microk8s.md: Added ingress controller warning, code titles - volumes.md: Added info box about volume purposes - other.md: Added code block titles - environment-variable.md: Added ACME reference note All changes verified against actual Python source code implementation.
This commit is contained in:
parent
96120d4554
commit
aee9645b43
13 changed files with 140 additions and 105 deletions
|
|
@ -6,9 +6,11 @@ sidebar_position: 1
|
|||
|
||||
## Setup Kubernetes EasyHAProxy
|
||||
|
||||
EasyHAProxy for Kubernetes operates by querying all ingress definitions with the annotation
|
||||
`kubernetes.io/ingress.class: easyhaproxy-ingress`. Upon finding this annotation,
|
||||
:::info How it works
|
||||
EasyHAProxy for Kubernetes operates by querying all ingress definitions with the annotation
|
||||
`kubernetes.io/ingress.class: easyhaproxy-ingress`. Upon finding this annotation,
|
||||
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.
|
||||
|
|
@ -21,9 +23,11 @@ To install EasyHAProxy in your Kubernetes cluster, follow these steps:
|
|||
|
||||
### 1) Identify the node where your EasyHAProxy container will run
|
||||
|
||||
EasyHAProxy will be limited to a single node. To understand that see [limitations](limitations.md) page.
|
||||
:::warning Single Node Deployment
|
||||
EasyHAProxy will be limited to a single node. To understand why, see the [limitations](limitations.md) page.
|
||||
:::
|
||||
|
||||
```bash
|
||||
```bash title="List available nodes"
|
||||
$ kubectl get nodes
|
||||
|
||||
NAME STATUS ROLES AGE VERSION
|
||||
|
|
@ -33,13 +37,13 @@ node-02 Ready <none> 561d v1.21.13-3
|
|||
|
||||
Add the EasyHAProxy label to the node.
|
||||
|
||||
```bash
|
||||
```bash title="Label the node for EasyHAProxy"
|
||||
kubectl label nodes node-01 "easyhaproxy/node=master"
|
||||
```
|
||||
|
||||
### 2) Install EasyHAProxy with Kubernetes Manifest
|
||||
|
||||
```bash
|
||||
```bash title="Install EasyHAProxy"
|
||||
kubectl create namespace easyhaproxy
|
||||
|
||||
kubectl apply -f \
|
||||
|
|
@ -78,11 +82,11 @@ Once the container is running, EasyHAProxy will detect automatically and start t
|
|||
|
||||
You don't need to expose any port in your container.
|
||||
|
||||
Notes:
|
||||
|
||||
- At this point, the implementation doesn't support all ingress properties or wildcard domains.
|
||||
- The ingress will publish the ports 80 and 443, plus 1936 if stats are enabled.
|
||||
- EasyHAProxy will read all `spec.rules[].host` spec, however it will parse only the first path `spec.rules[].http.paths[0].port.number` for each rule, and ignore the other paths.
|
||||
:::note Important Limitations
|
||||
- The implementation doesn't support all ingress properties or wildcard domains at this time.
|
||||
- The ingress will publish ports 80 and 443, plus 1936 if stats are enabled.
|
||||
- EasyHAProxy will read all `spec.rules[].host` specifications, however it will parse only the **first path** `spec.rules[].http.paths[0].port.number` for each rule, and ignore the other paths.
|
||||
:::
|
||||
|
||||
## Kubernetes annotations
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue