📖 docs: add initial developer documentation#243
Merged
mjudeikis merged 9 commits intoMar 3, 2025
Conversation
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
Contributor
|
I think it has enough details just to merge and there is some factual mismatches we identify later, we fix after. |
mjudeikis
approved these changes
Feb 12, 2025
mjudeikis
enabled auto-merge (rebase)
March 3, 2025 16:07
sttts
approved these changes
Mar 3, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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