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
14
docs/helm.md
14
docs/helm.md
|
|
@ -10,9 +10,11 @@ Helm is a package manager for Kubernetes. It allows you to install and manage ap
|
|||
|
||||
### 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
|
||||
|
|
@ -22,15 +24,15 @@ 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
|
||||
|
||||
Minimal configuration
|
||||
Minimal configuration:
|
||||
|
||||
```bash
|
||||
```bash title="Install with Helm (minimal)"
|
||||
helm repo add byjg https://opensource.byjg.com/helm
|
||||
helm repo update byjg
|
||||
kubectl create namespace easyhaproxy
|
||||
|
|
@ -43,7 +45,7 @@ helm upgrade --install ingress byjg/easyhaproxy \
|
|||
|
||||
Customizing Helm Values:
|
||||
|
||||
```yaml
|
||||
```yaml title="values.yaml"
|
||||
easyhaproxy:
|
||||
stats:
|
||||
username: admin
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue