Skip to content

Commit ebc79e5

Browse files
author
Jan Schlicht
committed
Bump KUDO and update README
Signed-off-by: Jan Schlicht <[email protected]>
1 parent 67e97c5 commit ebc79e5

File tree

3 files changed

+99
-87
lines changed

3 files changed

+99
-87
lines changed

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,38 @@
55

66
`kitt` synchronizes KUDO repositories from an index of _operator package references_.
77

8+
A list of YAML files describing _operator package references_ is used to create or update a [KUDO operator repository](https://github.com/kudobuilder/kudo/blob/main/keps/0015-repository-management.md) on the local file system.
9+
810
Example usage:
911

12+
```shell
13+
kitt update --repository /var/kudo/repo /var/kudo/operators/*.yaml
1014
```
11-
kitt update --repository /var/kudo/repo $(git diff --name-only --diff-filter=AM)
15+
16+
## Operator package references
17+
18+
`kitt` builds the KUDO repository from references to operator packages. Each reference describes how to retrieve one or more versioned packages of an operator.
19+
20+
Consider an operator that is developed in a Git repository. The actual operator package (`operator.yaml`, `parameters.yaml`, ...) is in the `operator` folder of this repository. Tagged versions of this operator are then referenced by the following YAML:
21+
22+
```yaml
23+
apiVersion: index.kudo.dev/v1alpha1
24+
kind: Operator
25+
name: MyOperator
26+
git-sources:
27+
- name: my-git-repository
28+
url: https://github.com/example/myoperator.git
29+
versions:
30+
- version: "1.0.0"
31+
git:
32+
source: my-git-repository
33+
directory: operator
34+
tag: "v1.0.0"
35+
- version: "2.0.0"
36+
git:
37+
source: my-git-repository
38+
directory: operator
39+
tag: "v2.0.0"
1240
```
41+
42+
Running `kitt update` with this YAML as an argument will check out the referenced Git repository with the specified tags `v1.0.0` and `v2.0.0`, build tarballs from the operator package in the `operator` folder, and add these tarballs to a KUDO repository.

go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ go 1.14
44

55
require (
66
github.com/Masterminds/semver v1.5.0
7-
github.com/kudobuilder/kudo v0.14.0
7+
github.com/kudobuilder/kudo v0.15.0
88
github.com/sirupsen/logrus v1.6.0
99
github.com/spf13/afero v1.3.1
1010
github.com/spf13/cobra v1.0.0

0 commit comments

Comments
 (0)