fix ingress example in values.yaml file (#317)

* fix ingress example in values.yaml file * fix * generate README with helm-docs --------- Co-authored-by: Pierre Besson <[email protected]>
paritytech · Jan 3, 2024 · 57e4e23 · 57e4e23
1 parent 29c4859
commit 57e4e23
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/charts/common/Chart.yaml b/charts/common/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: common
 description: A generic helm chart for Kubernetes
 type: application
-version: 0.7.1
+version: 0.7.2
 maintainers:
   - name: Parity
     url: https://github.com/paritytech/helm-charts
diff --git a/charts/common/README.md b/charts/common/README.md
@@ -45,11 +45,11 @@ This is intended behaviour. Make sure to run `git add -A` once again to stage ch
 | image.repository | string | `"nginx"` | Image repository |
 | image.tag | string | `"latest"` | Image tag |
 | imagePullSecrets | list | `[]` | Reference to one or more secrets to be used when pulling images ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ |
-| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[{"hosts":["chart-example.local"],"secretName":"chart-example-tls"}]}` | Creates an ingress resource |
+| ingress | object | `{"annotations":{},"className":"","enabled":false,"rules":[{"host":"chart-example.local","http":{"paths":[{"path":"/","pathType":"ImplementationSpecific"}]}}],"tls":[{"hosts":["chart-example.local"],"secretName":"chart-example-tls"}]}` | Creates an ingress resource |
 | ingress.annotations | object | `{}` | Annotations to add to the Ingress |
 | ingress.className | string | `""` | Ingress class name |
 | ingress.enabled | bool | `false` | Enable creation of Ingress |
-| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | A list of hosts for the Ingress |
+| ingress.rules | list | `[{"host":"chart-example.local","http":{"paths":[{"path":"/","pathType":"ImplementationSpecific"}]}}]` | A list of hosts for the Ingress |
 | ingress.tls | list | `[{"hosts":["chart-example.local"],"secretName":"chart-example-tls"}]` | Ingress TLS configuration |
 | ingress.tls[0] | object | `{"hosts":["chart-example.local"],"secretName":"chart-example-tls"}` | Secrets to use for TLS configuration |
 | ingress.tls[0].hosts | list | `["chart-example.local"]` | A list of hosts for the Ingress with TLS enabled |

diff --git a/charts/common/values.yaml b/charts/common/values.yaml
@@ -136,11 +136,17 @@ ingress:
     # kubernetes.io/ingress.class: nginx
     # kubernetes.io/tls-acme: "true"
   # -- A list of hosts for the Ingress
-  hosts:
+  rules:
     - host: chart-example.local
-      paths:
-        - path: /
-          pathType: ImplementationSpecific
+      http:
+        paths:
+          - path: /
+            pathType: ImplementationSpecific
+            # backend:
+            #   service:
+            #     name: signet-frontend
+            #     port:
+            #       name: http
   # -- Ingress TLS configuration
   tls:
   # -- Secrets to use for TLS configuration