https://github.com/kudobuilder/kitt
KUDO Index Transfer Tool
https://github.com/kudobuilder/kitt
Last synced: 3 months ago
JSON representation
KUDO Index Transfer Tool
- Host: GitHub
- URL: https://github.com/kudobuilder/kitt
- Owner: kudobuilder
- License: apache-2.0
- Created: 2020-07-07T12:28:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-19T10:58:29.000Z (over 4 years ago)
- Last Synced: 2025-02-14T17:42:22.791Z (4 months ago)
- Language: Go
- Size: 195 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# KUDO Index Transfer Tool
[](https://pkg.go.dev/mod/github.com/kudobuilder/kitt)
`kitt` synchronizes KUDO repositories from an index of _operator package references_.
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.
Example usage:
```shell
kitt update --repository /var/kudo/repo /var/kudo/operators/*.yaml
```
## Operator package references
`kitt` builds the KUDO repository from references to operator packages. Each reference describes how to retrieve one or more versioned packages of an operator.
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:
```yaml
apiVersion: index.kudo.dev/v1alpha1
kind: Operator
name: MyOperator
gitSources:
- name: my-git-repository
url: https://github.com/example/myoperator.git
versions:
- operatorVersion: "1.0.0"
git:
source: my-git-repository
directory: operator
tag: "v1.0.0"
- operatorVersion: "2.0.0"
git:
source: my-git-repository
directory: operator
tag: "v2.0.0"
```
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.