Skip to content

📖 docs: add initial developer documentation#243

Merged
mjudeikis merged 9 commits into
kbind-dev:mainfrom
dakraus:docs/add-backend-developer-docs
Mar 3, 2025
Merged

📖 docs: add initial developer documentation#243
mjudeikis merged 9 commits into
kbind-dev:mainfrom
dakraus:docs/add-backend-developer-docs

Conversation

@dakraus

@dakraus dakraus commented Feb 7, 2025

Copy link
Copy Markdown
Contributor

Summary

The purpose of this PR is to add some initial developer documentation to provide insight into how the konnector works and how a kube-bind client interacts with the provider backend. At the moment, the pages mainly contain diagrams that show

  • the interaction between a kube-bind client and the provider backend during cluster and API binding
  • the set of controllers implemented in the konnector

I tried to describe the interaction between a kube-bind client and the provider backend in a general way - e.g. some actions like installing the konnector, which is currently implemented in the kubectl plugin, are not shown in the diagrams. Also, not all of the konnector controllers are documented yet.

Overall I would love to hear your feedback, if this is something that adds value to the kube-bind docs and could be a starting point for kube-bind backend implementors.

Release Notes

NONE

Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
Signed-off-by: Daniel Kraus <daniel.kraus@kubermatic.com>
On-behalf-of: @SAP daniel.kraus01@sap.com
@dakraus
dakraus requested a review from a team as a code owner February 7, 2025 11:07

@cnvergence cnvergence left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@mjudeikis

Copy link
Copy Markdown
Contributor

I think it has enough details just to merge and there is some factual mismatches we identify later, we fix after.

@mjudeikis
mjudeikis merged commit 58c71e9 into kbind-dev:main Mar 3, 2025
@dakraus
dakraus deleted the docs/add-backend-developer-docs branch March 6, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants