Skip to content

Commit 4610697

Browse files
committed
update docu
1 parent 4212d6f commit 4610697

File tree

1 file changed

+44
-4
lines changed

1 file changed

+44
-4
lines changed

README.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To set the image pull secret, you need to create a custom values.yaml file that
1616
1. **Direct Image Pull Secrets**: If you have a direct image pull secret (a base64 encoded JSON containing Docker auth config), you can set it directly in the values.yaml file under either of these keys
1717
* `global.secret.dockerconfigjson`
1818
* `global.secret.imagePullSecret`
19-
* `global.imagePullSecret`
19+
* `imagePullSecret`
2020

2121
```yaml
2222
global:
@@ -107,10 +107,16 @@ minikube start --cpus="6" --memory="8g" --addons ingress
107107
export CLIENT_ID=vaas # default client id for self-hosted vaas
108108
export CLIENT_SECRET=$(kubectl get secret -n vaas vaas-client-secret -o jsonpath="{.data.secret}" | base64 -d) # extracts the client secret from the k8s secret
109109
export SCAN_PATH=./build.gradle # path to the file you want to scan
110-
export VAAS_URL=ws://vaas/ws # URL of the VaaS instance you set earlier in your /etc/hosts
110+
export VAAS_URL=http://vaas # URL of the VaaS instance you set earlier in your /etc/hosts
111111
export TOKEN_URL=http://vaas/auth/protocol/openid-connect/token # URL of the token endpoint you set earlier in your /etc/hosts
112112
```
113113

114+
Alternatively, if you are using an SDK version that still supports websockets, you have to set another host for the VAAS_URL:
115+
116+
```bash
117+
export VAAS_URL=ws://vaas/ws # URL of the VaaS instance you set earlier in your /etc/hosts
118+
```
119+
114120
* Execute FileScan example in Java SDK example folder
115121

116122
```bash
@@ -202,8 +208,10 @@ In addition, Sentry will always behave as follows:
202208

203209
| Parameter | Description | Value |
204210
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------ |
205-
| global.imagePullSecrets | List of image pull secrets | - name: registry |
206-
| global.secret.dockerconfigjson | Docker authentication configuration | "" |
211+
| imagePullSecret | Image pull secret | "e30K" |
212+
| global.imagePullSecrets | List of image pull secrets | [] |
213+
| global.secret.dockerconfigjson | Docker authentication configuration | "e30K" |
214+
| global.secret.imagePullSecret | Image pull secret | "e30K" |
207215
| cloud.hashLookup.enabled | Enable/Disable the cloud hash lookup | true |
208216
| cloud.allowlistLookup.enabled | Enable/Disable the cloud allowlist lookup | true |
209217
| gateway.ingress.enabled | Enable/Disable the Ingress resource | false |
@@ -293,6 +301,38 @@ gateway:
293301
uploadUrl: "http://vaas/upload"
294302
```
295303

304+
If you want to use only the HTTP API, it is sufficient to set the port to 8080 for the standard route:
305+
```yaml
306+
mini-identity-provider:
307+
issuer: "http://vaas/auth"
308+
ingress:
309+
className: ""
310+
hosts:
311+
- host: vaas
312+
paths:
313+
- path: /auth(/|$)(.*)
314+
pathType: ImplementationSpecific
315+
service:
316+
name: provider
317+
port: 8080
318+
tls: []
319+
320+
gateway:
321+
ingress:
322+
className: ""
323+
hosts:
324+
- host: vaas
325+
paths:
326+
- path: /
327+
pathType: ImplementationSpecific
328+
service:
329+
name: gateway
330+
port: 8080
331+
tls: []
332+
```
333+
334+
To check out, which of the SDKS supports the HTTP API, please check out this [table](https://github.com/GDATASoftwareAG/vaas?tab=readme-ov-file#sdks).
335+
296336
Replace the "vaas" with your hostname in the following values:
297337

298338
* mini-identity-provider.issuer

0 commit comments

Comments
 (0)