Skip to content

Commit bb8bfb7

Browse files
committed
Update docs and bump to 0.5.0
1 parent 4f6c82f commit bb8bfb7

File tree

2 files changed

+43
-42
lines changed

2 files changed

+43
-42
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ env:
66
COSIGN_EXPERIMENTAL: 1
77
REGISTRY: ghcr.io
88
IMAGE_NAME: ${{ github.repository }}
9-
VERSION: 0.4.0
9+
VERSION: 0.5.0
1010

1111
jobs:
1212
build:

README.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -29,68 +29,69 @@ This repository contains the following Carvel packages part of the [Kadras](http
2929

3030
## Prerequisites
3131

32-
* Install the [`kctrl`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl) CLI to manage Carvel packages in a convenient way.
33-
* Ensure [kapp-controller](https://carvel.dev/kapp-controller) is deployed in your Kubernetes cluster. You can do that with Carvel
34-
[`kapp`](https://carvel.dev/kapp/docs/latest/install) (recommended choice) or `kubectl`.
32+
* Kubernetes 1.24+
33+
* Carvel [`kctrl`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl) CLI.
34+
* Carvel [kapp-controller](https://carvel.dev/kapp-controller) deployed in your Kubernetes cluster. You can install it with Carvel [`kapp`](https://carvel.dev/kapp/docs/latest/install) (recommended choice) or `kubectl`.
3535

36-
```shell
37-
kapp deploy -a kapp-controller -y \
38-
-f https://github.com/vmware-tanzu/carvel-kapp-controller/releases/latest/download/release.yml
39-
```
36+
```shell
37+
kapp deploy -a kapp-controller -y \
38+
-f https://github.com/vmware-tanzu/carvel-kapp-controller/releases/latest/download/release.yml
39+
```
4040

4141
## Installation
4242

4343
You can install the Kadras package repository in a dedicated namespace using `kctrl`:
4444

45-
```shell
46-
kubectl create namespace carvel-packages
47-
kctrl package repository add -r kadras-repo \
48-
--url ghcr.io/arktonix/kadras-packages:0.4.0 \
49-
-n carvel-packages
50-
```
45+
```shell
46+
kubectl create namespace kadras-packages
47+
kctrl package repository add -r kadras-repo \
48+
--url ghcr.io/arktonix/kadras-packages:0.5.0 \
49+
-n kadras-packages
50+
```
5151

52-
Alternatively, you can add the repository by applying the `PackageRepository` manifest:
52+
### Verification
5353

54-
```shell
55-
kubectl create namespace carvel-packages
56-
kapp deploy -a kadras-repo -n carvel-packages -y \
57-
-f https://github.com/arktonix/kadras-packages/releases/latest/download/package-repository.yml
58-
```
54+
You can verify the list of available Carvel package repositories and their status.
5955

60-
After the installation, you can retrieve the list of available Carvel package repositories in your cluster
61-
with the following command.
56+
```shell
57+
kctrl package repository list -n kadras-packages
58+
```
6259

63-
```shell
64-
kctrl package repository list -n carvel-packages
65-
```
60+
### Packages
6661

67-
The Kadras package repository provides a collection of Carvel packages that you can list as follows.
62+
The Kadras package repository provides a collection of Carvel packages that you can list.
6863

69-
```shell
70-
kctrl package available list -n carvel-packages
71-
```
64+
```shell
65+
kctrl package available list -p kpack.packages.kadras.io -n kadras-packages
66+
```
7267

73-
## Update
68+
## Upgrading
7469

75-
You can update the repository by applying the `PackageRepository` manifest from the newest release, similar
76-
to the process described in the "Installation" section. Alternatively, you can use the `kctrl` CLI.
70+
You can upgrade an existing repository to a newer version using `kctrl`.
7771

78-
```shell
79-
kctrl package repository update -r kadras-repo \
72+
```shell
73+
kctrl package repository update -r kadras-repo \
8074
--url ghcr.io/arktonix/kadras-packages:<new-version> \
81-
-n carvel-packages
82-
```
75+
-n kadras-packages
76+
```
8377

84-
## Documentation
78+
## Other
8579

86-
You can find more documentation about Carvel package management at [carvel.dev](https://carvel.dev/kapp-controller/docs/latest/packaging).
80+
Instead of installing the Kadras package repository with `kctrl`, you can apply the necessary Carvel `PackageMetadata` and `Package` resources directly using [`kapp`](https://carvel.dev/kapp/docs/latest/install) or `kubectl`.
8781

88-
## References
82+
```shell
83+
kubectl create namespace kadras-packages
84+
kapp deploy -a kadras-repo -n kadras-packages -y \
85+
-f https://github.com/arktonix/kadras-packages/releases/latest/download/package-repository.yml
86+
```
8987

90-
This package repository is inspired by the work done by the Carvel team and the
91-
[Tanzu Community Edition](https://github.com/vmware-tanzu/community-edition) project (now retired).
88+
## Support and Documentation
89+
90+
For support and documentation about Carvel package management, check out [carvel.dev](https://carvel.dev/kapp-controller/docs/latest/packaging).
91+
92+
## References
9293

93-
Learn more about [Kubernetes-native package management with Carvel](https://carvel.dev/kapp-controller/docs/latest/packaging).
94+
This package repository is inspired by the work done by the Carvel team and the [Tanzu Community Edition](https://github.com/vmware-tanzu/community-edition) project (now retired). Learn more about [Kubernetes-native package management with Carvel](https://carvel.dev/kapp-controller/docs/latest/packaging).
9495

9596
## Supply Chain Security
9697

0 commit comments

Comments
 (0)