Crossplane Typescript Models

This repository generates Typescript models generated from the Kubernetes Custom Resource Definitions used by Crossplane and the Provider ecosystem.

Installation

Install with npm. The core Crossplane models are located at:

npm install @crossplane-models/crossplane

Provider models are also generated from this repository. See [Models](# Models) for supported providers.

npm install @crossplane-models/provider-upjet-aws

Usage

import { dumpYaml } from "@kubernetes/client-node";
import { Composition } from "@crossplane-models/crossplane/apiextensions.crossplane.io/v1";

const composition = new Composition({
    metadata: {
        name: "my-composition",
        labels: {
            "purpose": "example",
        },
    },
    spec: {
        compositeTypeRef: {
            apiVersion: "example.com/v1alpha1",
            kind: "XDatabase",
        },
        mode: "Pipeline",
    },
});

composition.validate();
console.log(dumpYaml(composition));

Models

CRD Source	NPM link	Local Source
crossplane	@crossplane-models/crossplane	models/crossplane/crossplane
provider-upjet-aws	@crossplane-models/provider-upjet-aws	models/crossplane-contrib/provider-upjet-aws
provider-upjet-azure	@crossplane-models/provider-upjet-azure	models/crossplane-contrib/provider-upjet-azure
provider-upjet-azuread	@crossplane-models/provider-upjet-azuread	models/crossplane-contrib/provider-upjet-azuread
provider-upjet-gcp	@crossplane-models/provider-upjet-gcp	models/crossplane-contrib/provider-upjet-gcp
provider-kubernetes	@crossplane-models/provider-kubernetes	models/crossplane-contrib/provider-kubernetes
provider-helm	@crossplane-models/provider-helm	models/crossplane-contrib/provider-helm

License

Generation tools forked from Upstream are released under MIT.

The Models are released under Apache-2.0 to match the Crossplane project.