https://github.com/crossplane/conformance
A Sonobuoy plugin to assess @crossplane conformance.
https://github.com/crossplane/conformance
Last synced: 5 months ago
JSON representation
A Sonobuoy plugin to assess @crossplane conformance.
- Host: GitHub
- URL: https://github.com/crossplane/conformance
- Owner: crossplane
- License: apache-2.0
- Created: 2021-04-28T03:34:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-15T22:20:14.000Z (9 months ago)
- Last Synced: 2025-09-16T00:16:13.186Z (9 months ago)
- Language: Go
- Homepage:
- Size: 356 KB
- Stars: 8
- Watchers: 2
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crossplane Conformance Suite
A [Sonobuoy] plugin to assess [Crossplane] conformance. To try it, first
download the `sonobuoy` CLI, then:
```console
# The version of Crossplane you wish to conform with.
CROSSPLANE_VERSION=1.2
# To determine whether a Crossplane distribution is conformant. The distribution
# must be pre-installed on the cluster where Sonobuoy will run.
sonobuoy run --wait --plugin https://raw.githubusercontent.com/crossplane/conformance/release-${CROSSPLANE_VERSION}/plugin-crossplane.yaml
sonobuoy results $(sonobuoy retrieve) -m dump
```
This repository maintains a branch for each version of Crossplane that the
conformance test suite supports. For example branch `release-1.2` will test
conformance with Crossplane 1.2.x. The docker image that powers the conformance
suite also derives its version from the version of Crossplane it corresponds to.
Tags are of the form `1.2.0-cf.1`, where `1.2.x` is the target version of
Crossplane, and `cf.1` is the version of the conformance test.
Note that the conformance tests are _not_ typically sensitive to Crossplane
patch releases. That is, in most cases when Crossplane `1.2.1` is released the
conformance test suite's version will not be bumped accordingly, and will remain
at `1.2.0-cf.X`. In the unlikely event that a Crossplane patch release
necessitates a conformance test suite update the patch version of the test suite
will be updated to match the Crossplane patch version. The `image` referenced by
the [distribution] plugin in any particular release branch is always the
authoritative conformance test for that major and minor version of Crossplane.
[sonobuoy]: https://sonobuoy.io/
[crossplane]: https://crossplane.io/
[distribution]: ./plugin-crossplane.yaml