Skip to content

Commit ae215f7

Browse files
committed
chore(doc): document backend overrides capabilities.
1 parent 56408b5 commit ae215f7

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/user-guide/common-operations.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ In order to run, KubeHound needs some docker containers to be running. Every com
2020

2121
### Starting the backend
2222

23+
#### Starting the backend with default images
24+
2325
The backend stack can be started by using:
2426

2527
```bash
@@ -28,6 +30,40 @@ kubehound backend up
2830

2931
It will use the latest [kubehound images releases](https://github.com/orgs/DataDog/packages?repo_name=KubeHound)
3032

33+
#### Starting the backend with overrides
34+
35+
For various reasons, you might want to use a specific version or pull the image from a specific registry. You can override the [default behaviour](https://github.com/DataDog/KubeHound/blob/main/deployments/kubehound/docker-compose.yaml) by using the following `docker-compose.overrides.yaml` file:
36+
37+
```yaml
38+
name: kubehound-release
39+
services:
40+
mongodb:
41+
image: your.registry.tld/mongo/mongo:6.0.6
42+
ports:
43+
- "127.0.0.1:27017:27017"
44+
45+
kubegraph:
46+
image: your.registry.tld/datadog/kubehound-graph:my-specific-tag
47+
ports:
48+
- "127.0.0.1:8182:8182"
49+
- "127.0.0.1:8099:8099"
50+
51+
ui-jupyter:
52+
image: your.registry.tld/datadog/kubehound-ui:my-specific-tag
53+
54+
ui-invana-engine:
55+
image: your.registry.tld/invanalabs/invana-engine:latest
56+
57+
ui-invana-studio:
58+
image: your.registry.tld/invanalabs/invana-studio:latest
59+
```
60+
61+
Then you can start the backend with the following command:
62+
63+
```bash
64+
kubehound backend up -f docker-compose.overrides.yml
65+
```
66+
3167
### Restarting/stopping the backend
3268

3369
The backend stack can be restarted by using:

0 commit comments

Comments
 (0)