Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.63 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.63 KB
Raw

Example App Configuration

This repository contains a Crossplane configuration, tailored for users establishing their initial control plane with Upbound. This configuration deploys fully managed Ghost blog as an example of how to deploy apps.

Overview

The core components of a custom API in Crossplane include:

  • CompositeResourceDefinition (XRD): Defines the API's structure.
  • Composition(s): Implements the API by orchestrating a set of Crossplane managed resources.

In this specific configuration, the App API contains:

  • an App definition custom resource type.
  • Composition of the [app] resources: Configured in /apis/composition.yaml, it provisions a Ghost blog deployment with helm and resources in the upbound-system namespace.

This repository contains an Composite Resource (XR) file.

Deployment

apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
  name: configuration-app
spec:
  package: xpkg.upbound.io/upbound/configuration-app:v0.2.0

Next steps

This repository serves as a foundational step. To enhance your control plane, consider:

  1. create new API definitions in this same repo
  2. editing the existing API definition to your needs

Upbound will automatically detect the commits you make in your repo and build the configuration package for you. To learn more about how to build APIs for your managed control planes in Upbound, read the guide on Upbound's docs.