DevOps/truecharts
2
0
Fork 0
Code Issues Pull Requests Actions 33 Packages Projects Releases 1 Wiki Activity

chore(docs,tests): remove references to fixedMiddlewares and allowCors(middlewares)

Browse Source
This commit is contained in:
Stavros Kois
2025-02-02 10:51:07 +02:00
parent 76f9e390a4
commit 53ca726d21
7 changed files with 103 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/src/content/docs/common/global.md
+19 -173
View File
@@ -28,12 +28,6 @@ global:
addServiceAnnotations: true
traefik:
addServiceAnnotations: true
fixedMiddlewares:
- name: chain-basic
namespace: ""
allowCorsMiddlewares:
- name: tc-opencors-chain
namespace: ""
```
---
@@ -42,13 +36,13 @@ global:
Additional Labels that apply to all objects
| | |
| ---------- | ------------------ |
| Key | `global.labels` |
| Type | `map` |
| | |
| ---------- | ----------------- |
| Key | `global.labels` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Default | `{}` |
| Default | `{}` |
Example
@@ -68,8 +62,8 @@ Additional Annotations that apply to all objects
| ---------- | -------------------- |
| Key | `global.annotations` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Default | `{}` |
Example
@@ -90,8 +84,8 @@ Namespace to apply to all objects, also applies to chart deps
| ---------- | ------------------ |
| Key | `global.namespace` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -111,8 +105,8 @@ Minimum Node Port Allowed
| ---------- | -------------------- |
| Key | `global.minNodePort` |
| Type | `int` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `9000` |
Example
@@ -132,8 +126,8 @@ Applies different techniques to stop all objects in the chart and its dependenci
| ---------- | ---------------- |
| Key | `global.stopAll` |
| Type | `bool` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `false` |
Example
@@ -151,8 +145,8 @@ Settings for metallb integration
| ---------- | ---------------- |
| Key | `global.metallb` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
Default
@@ -180,8 +174,8 @@ Settings for traefik integration
| ---------- | ---------------- |
| Key | `global.traefik` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
Default
@@ -189,12 +183,6 @@ Default
global:
traefik:
addServiceAnnotations: true
fixedMiddlewares:
- name: chain-basic
namespace: ""
allowCorsMiddlewares:
- name: tc-opencors-chain
namespace: ""
```
Example
@@ -203,8 +191,6 @@ Example
global:
traefik:
addServiceAnnotations: false
fixedMiddlewares: []
allowCorsMiddlewares: []
```
---
@@ -217,8 +203,8 @@ Add annotations to services for traefik
| ---------- | -------------------------------------- |
| Key | `global.traefik.addServiceAnnotations` |
| Type | `bool` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `true` |
Example
@@ -231,140 +217,6 @@ global:
---
### `traefik.fixedMiddlewares`
See documentation [here](/common/ingress/traefik#fixedmiddlewares)
Default
```yaml
global:
traefik:
fixedMiddlewares:
- name: chain-basic
namespace: ""
```
---
#### `traefik.fixedMiddlewares[].name`
See documentation [here](/common/ingress/traefik#fixedmiddlewaresname)
Example
```yaml
global:
traefik:
fixedMiddlewares:
- name: my-custom-middleware
```
---
#### `traefik.fixedMiddlewares[].namespace`
See documentation [here](/common/ingress/traefik#fixedmiddlewaresnamespace)
Example
```yaml
global:
traefik:
fixedMiddlewares:
- name: my-custom-middleware
namespace: my-namespace
```
---
### `traefik.allowCorsMiddlewares`
Middlewares for traefik to apply when allowCors is enabled in the ingress
| | |
| ---------- | ------------------------------------- |
| Key | `global.traefik.allowCorsMiddlewares` |
| Type | `list` of `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
Default
```yaml
global:
traefik:
allowCorsMiddlewares:
- name: tc-opencors-chain
namespace: ""
```
Example
```yaml
global:
traefik:
allowCorsMiddlewares:
- name: my-custom-middleware
namespace: my-namespace
```
---
#### `traefik.allowCorsMiddlewares[].name`
Name of the middleware
| | |
| ---------- | -------------------------------------------- |
| Key | `global.traefik.allowCorsMiddlewares[].name` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `""` |
Example
```yaml
global:
traefik:
allowCorsMiddlewares:
- name: my-custom-middleware
```
---
#### `traefik.allowCorsMiddlewares[].namespace`
Namespace of the middleware
:::tip
If not defined, helm will do a lookup and try to find the namespace of the middleware.
If more than one namespaces are found, it will throw an error.
:::
| | |
| ---------- | ------------------------------------------------- |
| Key | `global.traefik.allowCorsMiddlewares[].namespace` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `""` |
Example
```yaml
global:
traefik:
allowCorsMiddlewares:
- name: my-custom-middleware
namespace: my-namespace
```
---
## Full Examples
```yaml
@@ -380,10 +232,4 @@ global:
addServiceAnnotations: true
traefik:
addServiceAnnotations: true
fixedMiddlewares:
- name: chain-basic
namespace: ""
allowCorsMiddlewares:
- name: tc-opencors-chain
namespace: ""
```
website/src/content/docs/common/ingress/index.md
+58 -63
View File
@@ -41,8 +41,8 @@ Create Ingress objects
| ---------- | --------- |
| Key | `ingress` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -61,8 +61,8 @@ Define Ingress
| ---------- | --------------- |
| Key | `ingress.$name` |
| Type | `map` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -82,8 +82,8 @@ Enables or Disables the Ingress
| ---------- | ----------------------- |
| Key | `ingress.$name.enabled` |
| Type | `bool` |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Default | `false` |
Example
@@ -104,8 +104,8 @@ Define the primary ingress
| ---------- | ----------------------- |
| Key | `ingress.$name.primary` |
| Type | `bool` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `false` |
Example
@@ -126,8 +126,8 @@ Define if the object name should be expanded
| ---------- | -------------------------------- |
| Key | `ingress.$name.expandObjectName` |
| Type | `bool` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `false` |
Example
@@ -148,8 +148,8 @@ Define if the ingress is required
| ---------- | ------------------------ |
| Key | `ingress.$name.required` |
| Type | `bool` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `false` |
Example
@@ -170,8 +170,8 @@ Define the namespace for this object
| ---------- | ------------------------- |
| Key | `ingress.$name.namespace` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -192,8 +192,8 @@ Additional labels for ingress
| ---------- | ---------------------- |
| Key | `ingress.$name.labels` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Default | `{}` |
Example
@@ -215,8 +215,8 @@ Additional annotations for ingress
| ---------- | --------------------------- |
| Key | `ingress.$name.annotations` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Required | ❌ |
| Helm `tpl` | ✅ (On value only) |
| Default | `{}` |
Example
@@ -238,8 +238,8 @@ Define the ingress class name for this object
| ---------- | -------------------------------- |
| Key | `ingress.$name.ingressClassName` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `nil` |
Example
@@ -260,8 +260,8 @@ Define the `service: port` to assign the ingress
| ---------- | ------------------------------ |
| Key | `ingress.$name.targetSelector` |
| Type | `dict` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -283,8 +283,8 @@ Define the hosts for this ingress
| ---------- | --------------------- |
| Key | `ingress.$name.hosts` |
| Type | `list` of `map` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `[]` |
Example
@@ -305,8 +305,8 @@ Define the host for this ingress
| ---------- | ---------------------------- |
| Key | `ingress.$name.hosts[].host` |
| Type | `string` |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -328,8 +328,8 @@ Define the paths for this ingress
| ---------- | ----------------------------- |
| Key | `ingress.$name.hosts[].paths` |
| Type | `list` of `map` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `[]` |
Example
@@ -352,8 +352,8 @@ Define the path for this ingress
| ---------- | ------------------------------------ |
| Key | `ingress.$name.hosts[].paths[].path` |
| Type | `string` |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Required | ✅ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -377,8 +377,8 @@ Define the path type for this ingress
| ---------- | ---------------------------------------- |
| Key | `ingress.$name.hosts[].paths[].pathType` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `Prefix` |
Example
@@ -403,8 +403,8 @@ Overrides the "selected" service for this path
| ---------- | ----------------------------------------------- |
| Key | `ingress.$name.hosts[].paths[].overrideService` |
| Type | `dict` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -430,8 +430,8 @@ Define the service name for this path
| ---------- | ---------------------------------------------------- |
| Key | `ingress.$name.hosts[].paths[].overrideService.name` |
| Type | `string` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `""` |
Example
@@ -458,8 +458,8 @@ Define if the override service object name should be expanded
| ---------- | ---------------------------------------------------------------- |
| Key | `ingress.$name.hosts[].paths[].overrideService.expandObjectName` |
| Type | `bool` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `true` |
Example
@@ -487,8 +487,8 @@ Define the service port for this path
| ---------- | ---------------------------------------------------- |
| Key | `ingress.$name.hosts[].paths[].overrideService.port` |
| Type | `int` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | unset |
Example
@@ -515,8 +515,8 @@ Define the TLS for this ingress
| ---------- | ------------------- |
| Key | `ingress.$name.tls` |
| Type | `list` of `map` |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Required | ✅ |
| Helm `tpl` | ❌ |
| Default | `[]` |
Example
@@ -537,8 +537,8 @@ Define the hosts for this TLS
| ---------- | -------------------------- |
| Key | `ingress.$name.tls[].host` |
| Type | `list` of `string` |
| Required | ✅ |
| Helm `tpl` | ✅ (On each entry) |
| Required | ✅ |
| Helm `tpl` | ✅ (On each entry) |
| Default | `[]` |
Example
@@ -561,8 +561,8 @@ Define the secret name for this TLS
| ---------- | -------------------------------- |
| Key | `ingress.$name.tls[].secretName` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -586,8 +586,8 @@ Define the certificate issuer for this TLS
| ---------- | --------------------------------------- |
| Key | `ingress.$name.tls[].certificateIssuer` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `""` |
Example
@@ -611,8 +611,8 @@ Define the cluster issuer for this TLS
| ---------- | ----------------------------------- |
| Key | `ingress.$name.tls[].clusterIssuer` |
| Type | `string` |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Required | ❌ |
| Helm `tpl` | ✅ |
| Default | `""` |
Example
@@ -636,8 +636,8 @@ Define the integrations for this ingress
| ---------- | ---------------------------- |
| Key | `ingress.$name.integrations` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -660,8 +660,8 @@ See more details in [Cert Manager Integration](/common/ingress/certmanager)
| ---------- | ---------------------------------------- |
| Key | `ingress.$name.integrations.certManager` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -685,8 +685,8 @@ See more details in [Traefik Integration](/common/ingress/traefik)
| ---------- | ------------------------------------ |
| Key | `ingress.$name.integrations.traefik` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -710,8 +710,8 @@ See more details in [Homepage Integration](/common/ingress/homepage)
| ---------- | ------------------------------------- |
| Key | `ingress.$name.integrations.homepage` |
| Type | `map` |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Required | ❌ |
| Helm `tpl` | ❌ |
| Default | `{}` |
Example
@@ -763,12 +763,7 @@ ingress:
enabled: true
entrypoints:
- websecure
enableFixedMiddlewares: true
forceTLS: true
allowCors: false
fixedMiddlewares:
- name: chain-basic
namespace: ""
middlewares:
- name: my-middleware
namespace: ""