From 658d6ed286c49f60c3bd0b74e5ddfcd333ece08b Mon Sep 17 00:00:00 2001 From: filipiakj Date: Fri, 19 May 2023 12:46:42 +0200 Subject: [PATCH 1/2] Add ingressClassName --- Chart.yaml | 2 +- templates/ingress.yaml | 5 ++++- values.yaml | 1 + 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/Chart.yaml b/Chart.yaml index 4ceb659..09994c5 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -1,7 +1,7 @@ --- apiVersion: v2 name: swaggerui -version: 0.3.6 +version: 0.3.7 appVersion: 3.24.3 description: Swagger is an open-source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services. keywords: diff --git a/templates/ingress.yaml b/templates/ingress.yaml index 41a8ec2..d75c962 100644 --- a/templates/ingress.yaml +++ b/templates/ingress.yaml @@ -22,7 +22,10 @@ metadata: {{ toYaml . | indent 4 }} {{- end }} spec: -{{- if .Values.ingress.tls }} + {{- if .Values.ingress.className }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} tls: {{- range .Values.ingress.tls }} - hosts: diff --git a/values.yaml b/values.yaml index ee429e1..8046e34 100644 --- a/values.yaml +++ b/values.yaml @@ -56,6 +56,7 @@ service: ## ingress: enabled: false + className: ' ' annotations: {} path: / hosts: [] From 45cbcf97ba7c771ac5c78b73ccde1e9b1674abd4 Mon Sep 17 00:00:00 2001 From: filipiakj Date: Fri, 19 May 2023 13:07:18 +0200 Subject: [PATCH 2/2] Updated README.md --- README.md | 63 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c2c2619..b160a29 100644 --- a/README.md +++ b/README.md @@ -53,46 +53,47 @@ helm delete my-release The following table lists the configurable parameters of the swagger-ui chart and the default values. -| Parameter | Description | Default | -| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------| ------------------------------- | +| Parameter | Description | Default | +| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------|----------------------------------------------| | **Image** | -| `image.repository` | swagger-ui Image name | `swaggerapi/swagger-ui` | -| `image.tag` | swagger-ui Image tag | `v3.24.3` | -| `image.pullPolicy` | swagger-ui Image pull policy | `IfNotPresent` | -| `imagePullSecrets` | list of names of secrets containing docker registry credentials | `[]` | +| `image.repository` | swagger-ui Image name | `swaggerapi/swagger-ui` | +| `image.tag` | swagger-ui Image tag | `v3.24.3` | +| `image.pullPolicy` | swagger-ui Image pull policy | `IfNotPresent` | +| `imagePullSecrets` | list of names of secrets containing docker registry credentials | `[]` | | **Swagger-UI** | -| `swaggerui.jsonPath` | location of the configuration json file file | `""` | +| `swaggerui.jsonPath` | location of the configuration json file file | `""` | | `swaggerui.jsonUrl` | location of the configuration json file file | `http://petstore.swagger.io/v2/swagger.json` | -| `swaggerui.server.url` | Url of a custom server | `"http://www.google.be"` | -| `swaggerui.server.description` | description of a custom server | `"helm-online"` | +| `swaggerui.server.url` | Url of a custom server | `"http://www.google.be"` | +| `swaggerui.server.description` | description of a custom server | `"helm-online"` | | **Deployment** | -| `deployment.replicas` | Number of replicas | `1` | -| `deployment.extraEnv` | Additional environment variable | `` | -| `deployment.jsonNoCheckCertificate` | Enable/Disable certificate check | `false` | +| `deployment.replicas` | Number of replicas | `1` | +| `deployment.extraEnv` | Additional environment variable | `` | +| `deployment.jsonNoCheckCertificate` | Enable/Disable certificate check | `false` | | **Service** | -| `service.type` | Type of service for swagger-ui frontend | `NodePort` | -| `service.port` | Port to expose service | `8080` | -| `service.nodePort` | Port where the service is reachable | `30245` | -| `service.clusterIP` | internal cluster service IP (set to "-" to pass an empty value) | `nil` | -| `service.loadBalancerIP` | LoadBalancerIP if service type is `LoadBalancer` | `nil` | -| `service.loadBalancerSourceRanges` | Address that are allowed when svc is `LoadBalancer` | `[]` | -| `service.annotations` | Service annotations | `{}` | +| `service.type` | Type of service for swagger-ui frontend | `NodePort` | +| `service.port` | Port to expose service | `8080` | +| `service.nodePort` | Port where the service is reachable | `30245` | +| `service.clusterIP` | internal cluster service IP (set to "-" to pass an empty value) | `nil` | +| `service.loadBalancerIP` | LoadBalancerIP if service type is `LoadBalancer` | `nil` | +| `service.loadBalancerSourceRanges` | Address that are allowed when svc is `LoadBalancer` | `[]` | +| `service.annotations` | Service annotations | `{}` | | **Ingress** | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.path` | Path to access frontend | `/` | -| `ingress.hosts` | Ingress hosts | `[]` | -| `ingress.tls` | Ingress TLS configuration | `[]` | +| `ingress.className` | Sets ingressClassName | `false` | +| `ingress.enabled` | Enables Ingress | `' '` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.path` | Path to access frontend | `/` | +| `ingress.hosts` | Ingress hosts | `[]` | +| `ingress.tls` | Ingress TLS configuration | `[]` | | **ReadinessProbe** | -| `readinessProbe` | Rediness Probe settings | `nil` | +| `readinessProbe` | Rediness Probe settings | `nil` | | **LivenessProbe** | -| `livenessProbe.httpGet.path` | Liveness Probe settings | `/` | -| `livenessProbe.httpGet.port` | Liveness Probe settings | `http` | -| `livenessProbe.initialDelaySeconds` | Liveness Probe settings | `60` | -| `livenessProbe.periodSeconds` | Liveness Probe settings | `30` | -| `livenessProbe.timeoutSeconds` | Liveness Probe settings | `10` | +| `livenessProbe.httpGet.path` | Liveness Probe settings | `/` | +| `livenessProbe.httpGet.port` | Liveness Probe settings | `http` | +| `livenessProbe.initialDelaySeconds` | Liveness Probe settings | `60` | +| `livenessProbe.periodSeconds` | Liveness Probe settings | `30` | +| `livenessProbe.timeoutSeconds` | Liveness Probe settings | `10` | | **Resources** | -| `resources` | CPU/Memory resource requests/limits | `{}` | +| `resources` | CPU/Memory resource requests/limits | `{}` | ## Contributing