Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a quickstart for composing Kubernetes resources (apps) with Crossplane #864

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cwilhit
Copy link
Contributor

@cwilhit cwilhit commented Jan 31, 2025

This PR adds a guide to the main branch of the docs for how to compose Kubernetes objects (for app scenarios) using provider-kubernetes. There's an implementation with both patch-and-transform and KCL.

This guide assumes the user completes the prior AWS/Azure/GCP quickstart first, so it glosses over explanations of core Crossplane concepts.

…plane

Signed-off-by: Craig Wilhite <craig@upbound.io>
@cwilhit cwilhit force-pushed the app-composition-quickstart branch from cbc55f5 to e1323fa Compare January 31, 2025 05:59
Copy link

netlify bot commented Jan 31, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit e1323fa
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/679c66a905169c00084ad2b1
😎 Deploy Preview https://deploy-preview-864--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 89 (🟢 up 15 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@negz negz left a comment

Choose a reason for hiding this comment

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

Two nits but overall LGTM. Thank you!

metadata:
namespace: default
annotations:
krm.kcl.dev/composition-resource-name: "deployment"
Copy link
Member

Choose a reason for hiding this comment

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

This isn't needed in P&T.

@@ -0,0 +1,545 @@
---
title: App Compositions Quickstart
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
title: App Compositions Quickstart
title: App Quickstart

Nit: The other titles are e.g. "AWS Quickstart", "GCP Quickstart" - without "Composition".

"App Model Quickstart" might be good too.

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.

2 participants