Skip to content

Commit ecf678e

Browse files
committed
docs: add helm chart installation instructions
1 parent c133b94 commit ecf678e

File tree

2 files changed

+42
-15
lines changed

2 files changed

+42
-15
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ Alternatively, if you have a Go environment, you can simply install `oasbinder`
3434
go install github.com/insightsengineering/oasbinder@latest
3535
```
3636

37+
A helm chart is also available. You can install the `oasbinder` helm chart with:
38+
39+
```bash
40+
helm install oasbinder -f helm/templates/values.yaml oasbinder --repo https://insightsengineering.github.io/oasbinder/ --version 0.0.3 --namespace <namespace-name>
41+
```
42+
43+
Example `values.yaml` file is available in [helm/templates/values.yaml](helm/templates/values.yaml).
44+
3745
## Usage
3846

3947
`oasbinder` is a command line utility, so after installing the binary in your `PATH`, simply run the following command to view its capabilities:

helm/templates/values.yaml

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ fullnameOverride: ""
1717
podAnnotations: {}
1818
podLabels: {}
1919

20-
podSecurityContext: {}
21-
22-
securityContext: {}
23-
2420
service:
2521
type: ClusterIP
2622
port: 8080
@@ -54,20 +50,43 @@ autoscaling:
5450
maxReplicas: 100
5551
targetCPUUtilizationPercentage: 80
5652

57-
# Additional volumes on the output Deployment definition.
58-
volumes: []
59-
60-
# Additional volumeMounts on the output Deployment definition.
61-
volumeMounts: []
62-
6353
nodeSelector: {}
6454

6555
tolerations: []
6656

6757
affinity: {}
6858

69-
oasbinderConfig:
70-
# oasbinder configuration should be added here, directly as YAML structure.
71-
# proxyAddress:
72-
# services:
73-
# headers:
59+
# args:
60+
# - "--config"
61+
# - "/oasbinder.yaml"
62+
# - "--logLevel"
63+
# - "debug"
64+
65+
# volumeMounts:
66+
# - name: config-volume
67+
# mountPath: /oasbinder.yaml
68+
# subPath: oasbinder.yaml
69+
70+
# volumes:
71+
# - name: config-volume
72+
# configMap:
73+
# name: oasbinder
74+
75+
# securityContext:
76+
# readOnlyRootFilesystem: false
77+
# runAsNonRoot: true
78+
# runAsUser: 999
79+
# runAsGroup: 999
80+
81+
# oasbinderConfig:
82+
# proxyAddress: http://localhost:10001
83+
# listenPort: 8080
84+
# listenAddress: 0.0.0.0
85+
86+
# services:
87+
# - endpoint: /hogwarts
88+
# url: http://localhost:8000/hogwarts/
89+
# swagger_url: http://localhost:8000/hogwarts/
90+
91+
# headers:
92+
# api-key: qwerty

0 commit comments

Comments
 (0)