Skip to content

Commit fc53259

Browse files
committedAug 17, 2020
Remove label dependency from bundle docs.
The user story for arbitrary bundle properties hasn't solidified yet. The label type should remain unadvertised for now, in order to avoid user confusion, while still available for use as an escape hatch.
1 parent 018a040 commit fc53259

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed
 

‎docs/design/operator-bundle.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ annotations:
6969

7070
The dependencies of an operator are listed as a list in `dependencies.yaml` file inside `/metadata` folder of a bundle. This file is optional and only used to specify explicit operator version dependencies at first. Eventually, operator authors can migrate the API-based dependencies into `dependencies.yaml` as well in the future. The ultimate goal is to have `dependencies.yaml` as a centralized metadata for operator dependencies and moving the dependency information away from CSV.
7171

72-
The dependency list will contain a `type` field for each item to specify what kind of dependency this is. There are two supported `type` of operator dependencies. It can be a package type (`olm.package`) meaning this is a dependency for a specific operator version. For `olm.package` type, the dependency information should include the `package` name and the `version` of the package in semver format. We use `blang/semver` library for semver parsing (https://github.com/blang/semver). For example, you can specify an exact version such as `0.5.2` or a range of version such as `>0.5.1` (https://github.com/blang/semver#ranges). In addition, the author can specify dependency that is similar to existing CRD/API-based using `olm.gvk` type and then specify GVK information as how it is done in CSV. The author can also specify CSV labels as dependency constraints using `olm.label` type. The value of `olm.label` type will be matched against labels in CSV with the key starting with the phrase `olm.label`. This is a path to enable operator authors to consolidate all dependencies (API or explicit version) to be in the same place.
72+
The dependency list will contain a `type` field for each item to specify what kind of dependency this is. There are two supported `type` of operator dependencies. It can be a package type (`olm.package`) meaning this is a dependency for a specific operator version. For `olm.package` type, the dependency information should include the `package` name and the `version` of the package in semver format. We use `blang/semver` library for semver parsing (https://github.com/blang/semver). For example, you can specify an exact version such as `0.5.2` or a range of version such as `>0.5.1` (https://github.com/blang/semver#ranges). In addition, the author can specify dependency that is similar to existing CRD/API-based using `olm.gvk` type and then specify GVK information as how it is done in CSV. This is a path to enable operator authors to consolidate all dependencies (API or explicit version) to be in the same place.
7373

7474
An example of a `dependencies.yaml` that specifies Prometheus operator and etcd CRD dependencies:
7575

@@ -84,9 +84,6 @@ dependencies:
8484
group: etcd.database.coreos.com
8585
kind: EtcdCluster
8686
version: v1beta2
87-
- type: olm.label
88-
value:
89-
label: lts
9087
```
9188

9289
### Bundle Dockerfile

0 commit comments

Comments
 (0)
Please sign in to comment.