Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 724d52c

Browse files
alexnuttinckalexnuttinck
committed
add ingress, modify default values
1 parent b92b4e6 commit 724d52c

File tree

4 files changed

+71
-481
lines changed

4 files changed

+71
-481
lines changed

‎README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The following items can be set via `--set` flag during installation or configure
3232
- **NodePort**: Exposes the service on each Node’s IP at a static port (the NodePort). You’ll be able to contact the NodePort service, from outside the cluster, by requesting `NodeIP:NodePort`.
3333
- **LoadBalancer**: Exposes the service externally using a cloud provider’s load balancer.
3434

35-
3635
### Install the chart
3736

3837
Install the swagger-ui helm chart with a release name `my-release`:
@@ -56,33 +55,38 @@ The following table lists the configurable parameters of the swagger-ui chart an
5655
| Parameter | Description | Default |
5756
| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------| ------------------------------- |
5857
| **Image** |
59-
| `image.repository` | swagger-ui Image name | `swaggerapi/swagger-ui` |
60-
| `image.tag` | swagger-ui Image tag | `v3.23.10` |
61-
| `image.pullPolicy` | swagger-ui Image pull policy | `IfNotPresent` |
62-
| **swagger-ui** |
63-
| `swagger-ui.jsonPath` | location of the configuration json file file | `""` |
64-
| `swagger-ui.jsonUrl` | location of the configuration json file file | `https://raw.githubusercontent.com/cetic/helm-swagger-ui/develop/openapi.json` |
65-
| `swagger-ui.server.url` | Url of a custom server | `""` |
66-
| `swagger-ui.server.description` | descripton of a custom server | `"helm-online"` |
58+
| `image.repository` | swagger-ui Image name | `swaggerapi/swagger-ui` |
59+
| `image.tag` | swagger-ui Image tag | `v3.23.10` |
60+
| `image.pullPolicy` | swagger-ui Image pull policy | `IfNotPresent` |
61+
| **swagger-ui** |
62+
| `swagger-ui.jsonPath` | location of the configuration json file file | `""` |
63+
| `swagger-ui.jsonUrl` | location of the configuration json file file | `http://petstore.swagger.io/v2/swagger.json` |
64+
| `swagger-ui.server.url` | Url of a custom server | `"http://www.google.be"` |
65+
| `swagger-ui.server.description` | descripton of a custom server | `"helm-online"` |
6766
| **Service** |
68-
| `service.type` | Type of service for swagger-ui frontend | `NodePort` |
69-
| `service.port` | Port to expose service | `8080` |
70-
| `service.nodePort` | Port where the service is reachable | `30245` |
67+
| `service.type` | Type of service for swagger-ui frontend | `NodePort` |
68+
| `service.port` | Port to expose service | `8080` |
69+
| `service.nodePort` | Port where the service is reachable | `30245` |
7170
| `service.loadBalancerIP` | LoadBalancerIP if service type is `LoadBalancer` | `nil` |
7271
| `service.loadBalancerSourceRanges` | Address that are allowed when svc is `LoadBalancer` | `[]` |
7372
| `service.annotations` | Service annotations | `{}` |
73+
| **Ingress** |
74+
| `ingress.enabled` | Enables Ingress | `false` |
75+
| `ingress.annotations` | Ingress annotations | `{}` |
76+
| `ingress.path` | Path to access frontend | `/` |
77+
| `ingress.hosts` | Ingress hosts | `[]` |
78+
| `ingress.tls` | Ingress TLS configuration | `[]` |
7479
| **ReadinessProbe** |
7580
| `readinessProbe` | Rediness Probe settings | `nil` |
76-
| **LivenessProbe** |
77-
| `livenessProbe.httpGet.path` | Liveness Probe settings | `/` |
78-
| `livenessProbe.httpGet.port` | Liveness Probe settings | `http` |
79-
| `livenessProbe.initialDelaySeconds` | Liveness Probe settings | `60` |
80-
| `livenessProbe.periodSeconds` | Liveness Probe settings | `30` |
81-
| `livenessProbe.timeoutSeconds` | Liveness Probe settings | `10` |
81+
| **LivenessProbe** |
82+
| `livenessProbe.httpGet.path` | Liveness Probe settings | `/` |
83+
| `livenessProbe.httpGet.port` | Liveness Probe settings | `http` |
84+
| `livenessProbe.initialDelaySeconds` | Liveness Probe settings | `60` |
85+
| `livenessProbe.periodSeconds` | Liveness Probe settings | `30` |
86+
| `livenessProbe.timeoutSeconds` | Liveness Probe settings | `10` |
8287
| **Resources** |
8388
| `resources` | CPU/Memory resource requests/limits | `{}` |
8489

85-
8690
## Contributing
8791

8892
Feel free to contribute by making a [pull request](https://github.com/cetic/helm-swagger-ui/pull/new/master).

0 commit comments

Comments
 (0)