add crossplane integration example#413
Conversation
|
To be clarified, should we just keep all these files inlined in the doc, or are we fine with having some directory for these resources? |
Seeing the examples currently being in the dev-only |
e830d0a to
6f04d1f
Compare
|
moved it to https://github.com/cnvergence/crossplane-kube-bind-setup for now |
|
@coderabbitai review please |
|
@mjudeikis I will review the changes in this PR. 🧠 Learnings used✅ Actions performedReview triggered.
|
mjudeikis
left a comment
There was a problem hiding this comment.
in general can we just create a folder examples in root and add all yamls in there? Your repo has newer things than this document already.
Lets not add yet-another-repo to manage until we get things stable. Just add |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive Crossplane integration documentation and example files demonstrating how to use kube-bind with Crossplane for managed database provisioning. The example showcases a MySQL database service provisioned using Crossplane's provider-sql in a provider cluster, which is then exported and consumed via kube-bind. The PR also includes minor improvements to the cert-manager integration documentation.
Key changes:
- Complete Crossplane integration walkthrough with MySQL database example using XRD, Composition, and provider-sql
- Example YAML manifests for all components needed to run the integration
- Addition of self-signed issuer setup instructions in the cert-manager documentation
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
docs/content/usage/integrations/crossplane.md |
New comprehensive guide for integrating kube-bind with Crossplane, including step-by-step MySQL database provisioning example |
docs/content/usage/integrations/cert-manager.md |
Updated with self-signed issuer setup step and fixed trailing whitespace |
docs/content/usage/integrations/.pages |
Added crossplane.md to navigation |
examples/crossplane/xrd/xrd-db.yaml |
Defines the MySQLDatabase CompositeResourceDefinition (XRD) with kube-bind export label |
examples/crossplane/xrd/composition.yaml |
Comprehensive Composition using Go templating to orchestrate MySQL database, user, and secret resources |
examples/crossplane/xrd/function-go-templating.yaml |
Crossplane Function definition for Go templating support |
examples/crossplane/mysql.yaml |
Kubernetes manifests for deploying MySQL server (Deployment, PV, PVC, Service) |
examples/crossplane/db-provider/provider.yaml |
Crossplane provider-sql installation manifest |
examples/crossplane/db-provider/config.yaml |
ProviderConfig for connecting to MySQL instance |
examples/crossplane/db-apiserviceexporttemplate.yaml |
APIServiceExportTemplate to export MySQLDatabase API with secret permission claims |
examples/crossplane/consumer-db.yaml |
Example consumer database request manifest |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
52f07f2 to
f45c4f5
Compare
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com> On-behalf-of: @SAP karol.szwaj@sap.com
|
/lgtm |
Summary
This PR add a Crossplane external integration document with a walkthrough.
The example provisions a MySQL database in the provider cluster using provider-sql and showcases kube-bind providing a simple way to request a database service from service catalog.
Kudos to colleagues for the presentation that helped to get some visible Crossplane resources that could be used in kube-bind as well.
Also, adds self signed issuer step in the cert manager example.
What Type of PR Is This?
/kind documentation
Related Issue(s)
Fixes #400
Release Notes