Skip to content

add docs on how to use init-agent in an kcp-operator managed kcp#6

Merged
kcp-ci-bot merged 2 commits intokcp-dev:mainfrom
xrstf:helm-docs
Mar 2, 2026
Merged

add docs on how to use init-agent in an kcp-operator managed kcp#6
kcp-ci-bot merged 2 commits intokcp-dev:mainfrom
xrstf:helm-docs

Conversation

@xrstf
Copy link
Contributor

@xrstf xrstf commented Feb 11, 2026

Summary

This extends our documentation with a guide that more geared towards a production-like setup.

What Type of PR Is This?

/kind documentation

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 11, 2026
@xrstf
Copy link
Contributor Author

xrstf commented Feb 11, 2026

/retest

Copy link
Member

@SimonTheLeg SimonTheLeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small nits / questions from my side. Overall it looks pretty good :)

* `configcluster` – This cluster is a workspace inside kcp where the `InitTargets` and `InitTemplates`
reside. This is kind of the "home" workspace for the init-agent, here it also performs its leader
election.
* `wstcluster` – This is also a workspace in kcp, but this cluster name stands for any workspace that
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `wstcluster` – This is also a workspace in kcp, but this cluster name stands for any workspace that
* `wstcluster` – This is an additional workspace in kcp, but this cluster name stands for any workspace that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should call it "additional", since wstcluster and configcluster can be the same cluster, I do not want to give the impression that the wstcluster needs to be a second cluster.

namespace. For installing the init-agent, we now need to fetch the admin kubecofig (the first one):

```bash
kubectl --namespace my-kcp get secret my-admin-kubeconfig --output json |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: no need for jq :)

kubectl --namespace my-kcp get secret my-admin-kubeconfig -o jsonpath="{.data.kubeconfig}" | base64 -d > kcp-admin.kubeconfig

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I hate typing JSONPaths in kubectl. I can never for the life of me remember if I have to -- for no actual reason -- wrap the JSONPath in curly braces or not. And if paths have to begin with a dot or not. And if it's -ojsonpath ... or -o jsonpath... or -o jsonpath ... or -o jsonpath=... or -o=jsonpath=... or -o "jsonpath=...".

The earlier I can nope out of kubectl and use something real, like jq, the better.

xrstf added 2 commits March 2, 2026 11:53
On-behalf-of: @SAP christoph.mewes@sap.com
@SimonTheLeg
Copy link
Member

/approve
/lgtm

@kcp-ci-bot kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 2, 2026
@kcp-ci-bot
Copy link
Contributor

LGTM label has been added.

DetailsGit tree hash: 819f5ec9a8523d6ce6db1b2684aac113c716d3be

@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: SimonTheLeg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 2, 2026
@xrstf
Copy link
Contributor Author

xrstf commented Mar 2, 2026

/retest

I created #12 to track these surprisingly flaky e2e tests.

@xrstf
Copy link
Contributor Author

xrstf commented Mar 2, 2026

/retest

1 similar comment
@xrstf
Copy link
Contributor Author

xrstf commented Mar 2, 2026

/retest

@kcp-ci-bot kcp-ci-bot merged commit 9360253 into kcp-dev:main Mar 2, 2026
11 checks passed
@xrstf xrstf deleted the helm-docs branch March 2, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants