https://github.com/crossplane/configuration-template
A template for building @crossplane configurations.
https://github.com/crossplane/configuration-template
Last synced: 4 months ago
JSON representation
A template for building @crossplane configurations.
- Host: GitHub
- URL: https://github.com/crossplane/configuration-template
- Owner: crossplane
- Created: 2024-02-02T16:24:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T08:56:24.000Z (about 2 years ago)
- Last Synced: 2025-06-29T10:01:59.182Z (12 months ago)
- Size: 15.6 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```shell
# 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:
```shell
crossplane xpkg login
```
Push the package to a registry:
```shell
crossplane xpkg push -f test-package.xpkg your-org/your-repo:v1.0.0
```
More info on the Crossplane CLI can be found [here][xp-cli].
Check out the Crossplane docs for more information on [creating] Configurations.
[Configuration]: https://docs.crossplane.io/latest/concepts/packages
[creating]: https://docs.crossplane.io/latest/concepts/packages/#create-a-configuration
[xp-cli]: https://docs.crossplane.io/latest/cli/command-reference/