Skip to content
This repository has been archived by the owner on Jul 30, 2021. It is now read-only.

Latest commit

 

History

History
48 lines (34 loc) · 2.65 KB

operator-ci-yaml.md

File metadata and controls

48 lines (34 loc) · 2.65 KB
Raw

Operator Publishing / Review settings

Each operator might have ci.yaml configuration file to be present in operator directory (for example community-operators/aqua/ci.yaml). This configuration file is used by community-operators pipeline to setup various feature like reviewers or operator versioning.

!!! note One can create or modify ci.yaml file with new operator version. This operation can be done in the same PR with other operator changes.

Reviewers

If you want to accelerate publishing your changes, consider adding yourself and others you trust to the reviewers list. If the author of PR will be in that list, chnages she/he made will be taken as authorized changes (label authorized-changes will be set). This will be the indicator for our pipeline that the PR is ready to merged automatically.

!!! note If author of PR is not in reviewers list, PR will not be merged automatically. For automatic merging PR needs to have authorized-changes label set. Manually or by pipeline finding reviewer in ci.yaml on main branch. For security reasons we are not checking reviewers from a fork.

!!! note If auhor of PR is not in reviewers list and reviewers are present in ci.yaml file. All reviewers will be mentioned in PR comment to check for upcomming changes

For this to work, it is required to setup reviewers in ci.yaml file. It can be done by adding reviewers tag with list of github usernames. For example

Example

$ cat <path-to-operator>/ci.yaml
---
reviewers:
  - user1 
  - user2

Operator versioning

Operators have multiple versions. When a new version is released, OLM can update operator automatically. There are 2 update strategies possible, which are defined in ci.yaml at the operator top level.

replaces-mode

Every next version defines which version will be replaced using replaces key in the CSV file. It means, that there is a possibility to omit some versions from the update graph. Best practice is to put them to a separate channel then.

semver-mode

Every version will be replaced by next higher version according semantic versioning.

Restrictions

Contributor can decide, if semver-mode or replaces-mode mode will be used for a specific operator. By default, replaces-mode is activated, when ci.yaml file is present and contains updateGraph: replaces-mode. When a contributor decides to switch and use semver-mode, it will be specified in ci.yaml file or the key updateGraph will be missing.

Example

$ cat <path-to-operator>/ci.yaml
---
# Use `replaces-mode` or `semver-mode`.
updateGraph: replaces-mode