diff --git a/README.md b/README.md index 7af3856..f337c25 100644 --- a/README.md +++ b/README.md @@ -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`. @@ -170,20 +170,20 @@ 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 @@ -191,14 +191,31 @@ For air-gapped or enterprise environments, see the [Image Localization Guide](do ## 🔧 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