Skip to content

Commit

Permalink
Add alternative for independent ClusterBundle API
Browse files Browse the repository at this point in the history
Signed-off-by: Erik Godding Boye <[email protected]>
  • Loading branch information
erikgb committed Nov 25, 2024
1 parent bd60647 commit 5a570ee
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions design/20241124-rename-bunde-to-clusterbundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,27 @@ multiple controller references) from `Bundle` to target resources, in addition t

## Alternatives

### Introduce `ClusterBundle` as a new and Independent API

Since a `Bundle` and a `ClusterBundle` could then address the same target resources (by name), we would have to
take this into account in controllers. In addition, we would have a **lot** more code to maintain and test.
This could be partly mitigated by creating reusable abstractions that work for both resources.
But if we want to allow `ClusterBundle` to provide new features, this would become complex.

The migration path from `Bundle` to `ClusterBundle` would also be unclear and complex.
Use case: As a user, I would like to use `ClusterBundle` instead of `Bundle` **without interrupting the target resources**.

```
Bundle -> ClusterBundle -> target resources
```

seems a lot simpler to manage than

```
Bundle -> target resources AND
ClusterBundle -> target resources
```

### Just rename resource between releases

Since the `Bundle` API version is `v1alpha1`, we could justify just doing the simplest thing and rename.
Expand Down

0 comments on commit 5a570ee

Please sign in to comment.