Fix build error
This commit is contained in:
parent
a410b34521
commit
4b7f42473a
7 changed files with 98 additions and 98 deletions
|
|
@ -44,9 +44,9 @@ Install using tools:
|
|||
|
||||
| Section | Description |
|
||||
|---------|-------------|
|
||||
| **[Getting Started](docs/getting-started/index.md)** | Choose your runtime and discovery mode, minimal working setup |
|
||||
| **[Getting Started](docs/getting-started/)** | Choose your runtime and discovery mode, minimal working setup |
|
||||
| **[Guides](docs/guides/ssl.md)** | SSL, ACME, plugins, Helm, MicroK8s, Dokku, DigitalOcean |
|
||||
| **[Concepts](docs/concepts/index.md)** | Service discovery, config pipeline, plugin model, TLS termination |
|
||||
| **[Concepts](docs/concepts/)** | Service discovery, config pipeline, plugin model, TLS termination |
|
||||
| **[Reference](docs/reference/environment-variables.md)** | Environment variables, container labels, CLI flags, volumes |
|
||||
|
||||
## Who is using?
|
||||
|
|
|
|||
|
|
@ -47,5 +47,5 @@ Pick the guide that matches your environment:
|
|||
After you have traffic flowing:
|
||||
|
||||
- **[Guides](../guides/ssl.md)** — SSL certificates, ACME/Let's Encrypt, plugins
|
||||
- **[Concepts](../concepts/index.md)** — how service discovery and the config pipeline work
|
||||
- **[Concepts](../concepts/)** — how service discovery and the config pipeline work
|
||||
- **[Reference](../reference/environment-variables.md)** — full environment variable and label tables
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ For ACME/Certbot configuration (Let's Encrypt, ZeroSSL, etc.), see the [ACME doc
|
|||
These variables apply only when `EASYHAPROXY_DISCOVER=kubernetes`. They control how EasyHAProxy updates Ingress resources with load-balancer IP information.
|
||||
|
||||
| Environment Variable | Description | Default |
|
||||
|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|---------|
|
||||
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
||||
| EASYHAPROXY_UPDATE_INGRESS_STATUS | Update Ingress resources with the load-balancer IP. Set to `false` to disable. | `true` |
|
||||
| EASYHAPROXY_DEPLOYMENT_MODE | How to detect and report Ingress IPs: `auto`, `daemonset`, `nodeport`, or `clusterip`. `auto` inspects pod owner references and service type automatically. | `auto` |
|
||||
| EASYHAPROXY_EXTERNAL_HOSTNAME | Hostname to report in Ingress status when using ClusterIP mode without a cloud LoadBalancer. | *(none)* |
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Complete reference for all configurable values in the `byjg/easyhaproxy` Helm ch
|
|||
## Image Configuration
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|--------------------|------------------------------------------------|---------------------|
|
||||
| `image.repository` | Container image repository | `byjg/easy-haproxy` |
|
||||
| `image.tag` | Image tag. Defaults to the chart `appVersion`. | `""` |
|
||||
| `image.pullPolicy` | Image pull policy | `Always` |
|
||||
|
|
@ -23,7 +23,7 @@ Complete reference for all configurable values in the `byjg/easyhaproxy` Helm ch
|
|||
Controls whether EasyHAProxy runs as a **Deployment** (with a Service) or a **DaemonSet** (binding to host ports).
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|-----------------------|---------------------------------------------------------------------------------------------|-------------|
|
||||
| `replicaCount` | Number of replicas (only used when `service.create: true`) | `1` |
|
||||
| `service.create` | `true` → Deployment + Service (NodePort or ClusterIP). `false` → DaemonSet with host ports. | `false` |
|
||||
| `service.type` | Service type when `service.create: true`: `NodePort` or `ClusterIP` | `ClusterIP` |
|
||||
|
|
@ -36,7 +36,7 @@ Set `service.create: true` and `service.type: NodePort` for most setups. DaemonS
|
|||
## Port Binding
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|---------------------------|------------------------------------|---------|
|
||||
| `binding.ports.http` | HTTP port | `80` |
|
||||
| `binding.ports.https` | HTTPS port | `443` |
|
||||
| `binding.ports.stats` | HAProxy stats port | `1936` |
|
||||
|
|
@ -45,7 +45,7 @@ Set `service.create: true` and `service.type: NodePort` for most setups. DaemonS
|
|||
## EasyHAProxy Settings
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|------------------------------------|-----------------------------------------------------|------------|
|
||||
| `easyhaproxy.stats.username` | HAProxy stats dashboard username | `admin` |
|
||||
| `easyhaproxy.stats.password` | HAProxy stats dashboard password | `password` |
|
||||
| `easyhaproxy.refresh` | Seconds between service discovery polls | `"10"` |
|
||||
|
|
@ -61,7 +61,7 @@ Set `service.create: true` and `service.type: NodePort` for most setups. DaemonS
|
|||
Controls how EasyHAProxy updates Kubernetes Ingress resources with load-balancer IPs.
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|----------------------------------|---------------------------------------------------------------------------------------------------|---------|
|
||||
| `ingressStatus.enabled` | Update Ingress resources with load-balancer IPs | `true` |
|
||||
| `ingressStatus.deploymentMode` | How to detect/report IPs: `auto`, `daemonset`, `nodeport`, or `clusterip`. `auto` is recommended. | `auto` |
|
||||
| `ingressStatus.externalHostname` | Hostname to report in Ingress status (for ClusterIP mode without a LoadBalancer) | `""` |
|
||||
|
|
@ -74,7 +74,7 @@ These values are ignored when running as a Deployment (`service.create: true`).
|
|||
:::
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|---------------------|----------------------------------------|--------------------|
|
||||
| `masterNode.label` | Node label key used for `nodeAffinity` | `easyhaproxy/node` |
|
||||
| `masterNode.values` | Accepted values for the node label | `["master"]` |
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ kubectl label nodes node-01 "easyhaproxy/node=master"
|
|||
## Standard Kubernetes Fields
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|----------------------|--------------------------------------------|---------|
|
||||
| `podAnnotations` | Annotations added to the EasyHAProxy pod | `{}` |
|
||||
| `resources` | CPU/memory requests and limits for the pod | `{}` |
|
||||
| `nodeSelector` | Node selector for pod scheduling | `{}` |
|
||||
|
|
@ -99,7 +99,7 @@ kubectl label nodes node-01 "easyhaproxy/node=master"
|
|||
## Service Account
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|------------------------------|------------------------------------------------------|---------|
|
||||
| `serviceAccount.create` | Create a dedicated ServiceAccount | `true` |
|
||||
| `serviceAccount.annotations` | Annotations to add to the ServiceAccount | `{}` |
|
||||
| `serviceAccount.name` | Name of the ServiceAccount. Auto-generated if empty. | `""` |
|
||||
|
|
@ -107,7 +107,7 @@ kubectl label nodes node-01 "easyhaproxy/node=master"
|
|||
## Ingress Class
|
||||
|
||||
| Value | Description | Default |
|
||||
|---|---|---|
|
||||
|----------------------------|-------------------------------------------------------|---------|
|
||||
| `ingressClass.create` | Create an `IngressClass` resource named `easyhaproxy` | `true` |
|
||||
| `ingressClass.annotations` | Annotations to add to the IngressClass | `{}` |
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ sidebar_label: "Other Configurations"
|
|||
EasyHAProxy automatically sets standard proxy-awareness headers for all HTTP requests:
|
||||
|
||||
| Header | Description | Example Value |
|
||||
|--------|-------------|---------------|
|
||||
|-------------------|----------------------------------|----------------------------------------|
|
||||
| X-Forwarded-For | Client IP address | `203.0.113.50` |
|
||||
| X-Forwarded-Port | Port HAProxy received request on | `443` |
|
||||
| X-Forwarded-Proto | Protocol (http or https) | `https` |
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ Protect APIs and services with JWT authentication without needing application-le
|
|||
## Configuration Options
|
||||
|
||||
| Option | Description | Default |
|
||||
|-------------------|----------------------------------------------------------------------------------------------|-------------|
|
||||
|---------------------|-----------------------------------------------------------------------------------------------|-------------|
|
||||
| `enabled` | Enable/disable plugin | `true` |
|
||||
| `algorithm` | JWT signing algorithm | `RS256` |
|
||||
| `issuer` | Expected JWT issuer (optional, set to `none`/`null` to skip validation) | (optional) |
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ All EasyHAProxy files are organized under `/etc/easyhaproxy/`. This can be custo
|
|||
The most commonly mapped volumes for persistence and customization:
|
||||
|
||||
| Volume | Purpose | Required |
|
||||
|-------------------------------------------|-------------------------------------------------------------------------------------------------------|----------|
|
||||
|-------------------------------------------|--------------------------------------------------------------------------------------------|----------|
|
||||
| `/etc/easyhaproxy/static/` | [Static configuration](../getting-started/static.md) - mount your `config.yml` here | Optional |
|
||||
| `/etc/easyhaproxy/certs/haproxy/` | [SSL certificates](../guides/ssl.md) - user-provided certificates in PEM format | Optional |
|
||||
| `/etc/easyhaproxy/certs/certbot/` | [ACME/Certbot certificates](../guides/acme.md) - auto-generated Let's Encrypt certificates | Optional |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue