Skip to content

Commit 8b5ee79

Browse files
committed
finish running docs
On-behalf-of: @SAP christoph.mewes@sap.com
1 parent 9489c01 commit 8b5ee79

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/content/setup.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,45 @@ spec:
152152

153153
## Running the Agent
154154

155+
For regular use, the init-agent should be installed using its [Helm chart][helmchart], but for
156+
debugging purposes it's also possible to run the agent locally.
157+
158+
### Helm Chart
159+
160+
To use the Helm chart, first add the repository to your local system:
161+
162+
```bash
163+
helm repo add kcp https://kcp-dev.github.io/helm-charts
164+
helm repo update
165+
```
166+
167+
At the very least you will have to provide
168+
169+
* a kubeconfig to access kcp
170+
* the name of the workspace/cluster where the `InitTargets` and other resources
171+
reside
172+
173+
Put both in your `myvalues.yaml` (check the `values.yaml` for more examples).
174+
175+
You can now install the chart:
176+
177+
```bash
178+
helm upgrade --install my-init-agent kcp/init-agent --values ./myvalues.yaml
179+
```
180+
181+
### Locally
182+
183+
For development purposes you can run the agent directly. You can build your own from
184+
source or download one of the [ready-made releases][releases]. To run it, you need
185+
to provide the kcp kubeconfig and the workspace/cluster where the `InitTargets`
186+
reside:
187+
188+
```bash
189+
./init-agent \
190+
--kubeconfig /path/to/kcp.kubeconfig \
191+
--config-workspace root:my-org:init-agent
192+
```
193+
155194
[kcp]: https://kcp.io
195+
[helmchart]: https://github.com/kcp-dev/helm-charts/tree/main/charts/init-agent
196+
[releases]: https://github.com/kcp-dev/init-agent/releases

0 commit comments

Comments
 (0)