From 8b5ee796b038a0504e1e79cfaa7eef0b136cfc1b Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Fri, 23 Jan 2026 15:42:06 +0100 Subject: [PATCH 1/3] finish running docs On-behalf-of: @SAP christoph.mewes@sap.com --- docs/content/setup.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/content/setup.md b/docs/content/setup.md index 022ebef..84e7c99 100644 --- a/docs/content/setup.md +++ b/docs/content/setup.md @@ -152,4 +152,45 @@ spec: ## Running the Agent +For regular use, the init-agent should be installed using its [Helm chart][helmchart], but for +debugging purposes it's also possible to run the agent locally. + +### Helm Chart + +To use the Helm chart, first add the repository to your local system: + +```bash +helm repo add kcp https://kcp-dev.github.io/helm-charts +helm repo update +``` + +At the very least you will have to provide + +* a kubeconfig to access kcp +* the name of the workspace/cluster where the `InitTargets` and other resources + reside + +Put both in your `myvalues.yaml` (check the `values.yaml` for more examples). + +You can now install the chart: + +```bash +helm upgrade --install my-init-agent kcp/init-agent --values ./myvalues.yaml +``` + +### Locally + +For development purposes you can run the agent directly. You can build your own from +source or download one of the [ready-made releases][releases]. To run it, you need +to provide the kcp kubeconfig and the workspace/cluster where the `InitTargets` +reside: + +```bash +./init-agent \ + --kubeconfig /path/to/kcp.kubeconfig \ + --config-workspace root:my-org:init-agent +``` + [kcp]: https://kcp.io +[helmchart]: https://github.com/kcp-dev/helm-charts/tree/main/charts/init-agent +[releases]: https://github.com/kcp-dev/init-agent/releases From 6ccbf63b3573be49e181338db23a9ccf51a98102 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Fri, 23 Jan 2026 15:47:33 +0100 Subject: [PATCH 2/3] add FAQ On-behalf-of: @SAP christoph.mewes@sap.com --- docs/content/faq.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/content/faq.md b/docs/content/faq.md index 3f0a6d6..abfa6d3 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -1,3 +1,21 @@ # Frequently Asked Questions -TBD +## Can I add/update objects to already initialized clusters? + +No. Once the initialization is completed (and the initializer removed from the +`LogicalCluster`), the init-agent has no way to access the newly created cluster +anymore, so it also cannot reconcile after that point. + +Reconciling behaviour is planned for future releases, but the exact approach is +not yet decided. + +## Can `InitTargets` generate random data, like passwords? + +Yes! `InitTemplates` can make use of the entire [sprig][sprig] library, which +includes functions to generate passwords, UUIDs etc. + +However, the init-agent has no memory, so if one initialization round fails +and then agent re-tries, it will re-render all templates and so generate new, +different random data. + +[sprig]: https://masterminds.github.io/sprig/ From 02e7b38567f15a145594fe0da1f07a29f04b1261 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Fri, 23 Jan 2026 15:48:20 +0100 Subject: [PATCH 3/3] extend PR template On-behalf-of: @SAP christoph.mewes@sap.com --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d1d1441..a3165af 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,6 +13,7 @@ If this is your first time, please make sure to review CONTRIBUTING.MD. Add one of the following kinds: /kind bug +/kind chore /kind cleanup /kind documentation /kind feature