Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.49 KB

README.md

File metadata and controls

39 lines (30 loc) · 1.49 KB

configuration-template

A template for writing a Configuration.

To use this template:

  1. Replace the name, metadata in crossplane.yaml to reflect your Configuration.
  2. Add dependencies in crossplane.yaml.
  3. Update the sample CompositeResourceDefinition and Composition in the apis/ directory to reflect the API you're designing for your platform, and optionally add more if needed.
  4. Add/Update examples in the examples/ directory.
  5. Update this file, README.md, to be about your Configuration!

To build a Configuration package, use the Crossplane CLI:

# Just builds the package. It will go through the repo and collect yaml files.
# Furthermore it will by default check for examples in `./examples` and add them to the package.
crossplane xpkg build

# You can specify various options for the build command, if needed
crossplane xpkg build --package-root=. --package-file=test-package.xpkg --examples-root=./examples

(Optionally) Login to the default xpkg.upbound.io registry:

crossplane xpkg login

Push the package to a registry:

crossplane xpkg push -f test-package.xpkg your-org/your-repo:v1.0.0

More info on the Crossplane CLI can be found here.

Check out the Crossplane docs for more information on creating Configurations.