Skip to content

Commit

Permalink
Update docs to reflect versioning changes (#124)
Browse files Browse the repository at this point in the history
The 'operatorVersion' field is used instead of 'version' in operator packages and the index.
Also, some CLI parameters have changed to have 'app-version' and 'operator-version' flags.
  • Loading branch information
Jan Schlicht committed Jan 23, 2020
1 parent cdd229a commit 95e9e8d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
14 changes: 9 additions & 5 deletions content/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,11 @@ The namespace used for the operator installation. (default: "default")
:::

::: flag --operator-version (string)
A specific operator version in the official GitHub repo. (default to the most recent)
A specific operator version on the official GitHub repo. (default to the most recent)
:::

::: flag --app-version (string)
A specific application version on the official GitHub repo. (default to the most recent)
:::

::: flag -p, --parameter (stringArray)
Expand Down Expand Up @@ -448,7 +452,7 @@ A repository is a set of operator packages (tarballs) which are indexed in an in
```bash
# example folder
ls ~/repo
kafka-0.1.2.tgz kafka-0.2.0.tgz
kafka-2.2.1-0.1.2.tgz kafka-0.2.0.tgz
# repo index
kubectl kudo repo index ~/repo
Expand All @@ -462,17 +466,17 @@ entries:
maintainers:
- name: Zain Malik <zmalikshxil@gmail.com>
name: kafka
operatorVersion: 0.2.0
urls:
- http://localhost/kafka-0.2.0.tgz
version: 0.2.0
- appVersion: 2.2.1
digest: fbff9679cd0070bf10dcafc8d5e1e7d13a5c1651154165162c543508895a37c0
maintainers:
- name: Zain Malik <zmalikshxil@gmail.com>
name: kafka
operatorVersion: 0.1.2
urls:
- http://localhost/kafka-0.1.2.tgz
version: 0.1.2
- http://localhost/kafka-2.2.1-0.1.2.tgz
```
It can be useful when overwriting a file to use `--overwrite`. It is also useful to use `--url=http://kudo.dev/repo` to supply the desired URL the operator packages will be hosted on.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ entries:
- apiVersion: v1alpha1
appVersion: 7.0.0
name: youroperator
operatorVersion: 0.1.0
urls:
- https://kudo-repository.storage.googleapis.com/elastic-0.1.0.tgz
version: 0.1.0
- https://kudo-repository.storage.googleapis.com/elastic-7.0.0-0.1.0.tgz
```

The `url` points to a location where a tarball package is hosted. These locations can be within the repository, or outside of it.
Expand Down

0 comments on commit 95e9e8d

Please sign in to comment.