Skip to content

docs: add Quality Criteria self-assessment to README #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maximiliantech merged 12 commits into from
Jun 9, 2026
Merged

docs: add Quality Criteria self-assessment to README #64

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e24b45a
docs: add Quality Criteria self-assessment to README
maximiliantech Jun 4, 2026
d88f164
docs: mark ownership and maintenance as met
maximiliantech Jun 4, 2026
81a1ddb
docs: add notes column explaining gaps for non-met criteria
maximiliantech Jun 4, 2026
0de39f6
chore: format document
maximiliantech Jun 4, 2026
bd84546
docs(readme): rephrasing deletion behaviour note
maximiliantech Jun 8, 2026
dab1511
Merge branch 'main' into docs/quality-criteria
maximiliantech Jun 8, 2026
c0f8872
fix: typo
maximiliantech Jun 8, 2026
392f75b
chore: fix quality criteria
maximiliantech Jun 9, 2026
f29f67d
docs(readme): remove link
maximiliantech Jun 9, 2026
3fcd181
docs(readme): formatting
maximiliantech Jun 9, 2026
26f4831
docs(readme): add link to opencontrolplane-runtime
maximiliantech Jun 9, 2026
dae98c8
docs(readme): move quality criteria to the end
maximiliantech Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 36 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ spec:
version: "2.8.3"
```

| Field | Type | Description |
|-------|------|-------------|
| Field | Type | Description |
| -------------- | ------ | ------------------------------ |
| `spec.version` | string | The version of Flux to install |

Note that any version that should be available to users have to be defined in the `ProviderConfig`.
Expand Down Expand Up @@ -170,35 +170,52 @@ spec:
tag: v1.8.1
```

| Field | Type | Description |
|-------|------|-------------|
| Field | Type | Description |
| ------------------- | -------- | ---------------------------------------------- |
| `spec.pollInterval` | duration | How often to reconcile resources (default: 1m) |
| `spec.versions` | array | The versions of Flux that can be installed |
| `spec.versions` | array | The versions of Flux that can be installed |

A version item is defined as follows:

| Field | Type | Description |
|-------|------|-------------|
| `version` | string | The Flux version that this item defines |
| `chartVersion` | string | The Flux Helm chart version to install |
| `chartUrl` | string | OCI registry URL for the Flux Helm chart |
| Field | Type | Description |
| ----------------- | ------ | --------------------------------------------- |
| `version` | string | The Flux version that this item defines |
| `chartVersion` | string | The Flux Helm chart version to install |
| `chartUrl` | string | OCI registry URL for the Flux Helm chart |
| `chartPullSecret` | string | Secret name for chart registry authentication |
| `values` | object | Custom Helm values for Flux deployment |
| `values` | object | Custom Helm values for Flux deployment |

## 🔐 Air-Gapped Environments

For air-gapped or enterprise environments, see the [Image Localization Guide](docs/configuration/image-localization.md).

## 🔧 Development Tasks

| Command | Description |
|---------|-------------|
| `task build` | Build the binary |
| `task build:img:build` | Build the container image |
| `task test` | Run unit tests |
| `task test-e2e` | Run end-to-end tests |
| `task generate` | Generate CRDs and code |
| `task validate` | Run linters and formatters |
| Command | Description |
| ---------------------- | -------------------------- |
| `task build` | Build the binary |
| `task build:img:build` | Build the container image |
| `task test` | Run unit tests |
| `task test-e2e` | Run end-to-end tests |
| `task generate` | Generate CRDs and code |
| `task validate` | Run linters and formatters |

## Quality Criteria

[![Quality: Incubating](https://img.shields.io/badge/Quality-Incubating-3d9970?style=flat-square&labelColor=555)](https://open-control-plane.io/developers/serviceprovider/quality-criteria)

| Criterion | Status | Notes |
| --------------------------------- | :----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deletion behaviour | ⚠️ | A finalizer ensures the Service Provider managed resources like Flux' `OCIRepository` and `HelmRelease` are cleaned-up. But there is no behaviour that ensures deletion is blocked if custom resources (e.g. Flux' `GitRepository` objects) in a `ControlPlane` still exist. |
| Status reporting & error messages | ✅ | |
| Operation annotations | ⚠️ | `openmcp.cloud/operation: ignore` is processed by [opencontrolplane-runtime](https://github.com/openmcp-project/opencontrolplane-runtime). `openmcp.cloud/operation: reconcile` is not processed. |
| API stability policy | ✅ | |
| Custom CA support | ⚠️ | Private-registry pull secrets supported; custom CA bundle propagation to Flux components is not implemented. |
| Release artifacts (image + OCM) | ✅ | |
| Testing | ✅ | |
| Ownership and maintenance docs | ✅ | |

See the [OpenControlPlane Quality Criteria](https://open-control-plane.io/developers/serviceprovider/quality-criteria) for definitions.

## 🤝 Support, Feedback, Contributing

Expand Down
Loading