Skip to content

Commit eeba8d5

Browse files
committed
Improve installation docs
1 parent 8d8580c commit eeba8d5

File tree

1 file changed

+71
-47
lines changed

1 file changed

+71
-47
lines changed

README.md

Lines changed: 71 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,52 @@
22

33
This project provides a [Carvel package](https://carvel.dev/kapp-controller/docs/latest/packaging) for [Cert Manager](https://cert-manager.io), a cloud-native solution to automatically provision and manage TLS certificates in Kubernetes.
44

5-
## Components
6-
7-
* Cert Manager
8-
95
## Prerequisites
106

11-
* 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.
12-
* Ensure [kapp-controller](https://carvel.dev/kapp-controller) is deployed in your Kubernetes cluster. You can do that with Carvel
13-
[`kapp`](https://carvel.dev/kapp/docs/latest/install) (recommended choice) or `kubectl`.
7+
* Kubernetes 1.24+
8+
* Carvel [`kctrl`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl) CLI.
9+
* 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`.
1410

15-
```shell
16-
kapp deploy -a kapp-controller -y \
17-
-f https://github.com/vmware-tanzu/carvel-kapp-controller/releases/latest/download/release.yml
18-
```
11+
```shell
12+
kapp deploy -a kapp-controller -y \
13+
-f https://github.com/vmware-tanzu/carvel-kapp-controller/releases/latest/download/release.yml
14+
```
1915

2016
## Installation
2117

22-
You can install the Cert Manager package directly or rely on the [Kadras package repository](https://github.com/arktonix/carvel-packages)
23-
(recommended choice).
24-
25-
Follow the [instructions](https://github.com/arktonix/carvel-packages) to add the Kadras package repository to your Kubernetes cluster.
18+
First, add the [Kadras package repository](https://github.com/arktonix/kadras-packages) to your Kubernetes cluster.
2619

27-
If you don't want to use the Kadras package repository, you can create the necessary `PackageMetadata` and
28-
`Package` resources for the Cert Manager package directly.
29-
30-
```shell
31-
kubectl create namespace carvel-packages
32-
kapp deploy -a cert-manager-package -n carvel-packages -y \
33-
-f https://github.com/arktonix/package-for-cert-manager/releases/latest/download/metadata.yml \
34-
-f https://github.com/arktonix/package-for-cert-manager/releases/latest/download/package.yml
35-
```
20+
```shell
21+
kubectl create namespace kadras-packages
22+
kctrl package repository add -r kadras-repo \
23+
--url ghcr.io/arktonix/kadras-packages \
24+
-n kadras-packages
25+
```
3626

37-
Either way, you can then install the Cert Manager package using [`kctrl`](https://carvel.dev/kapp-controller/docs/latest/install/#installing-kapp-controller-cli-kctrl).
27+
Then, install the Cert Manager package.
3828

39-
```shell
40-
kctrl package install -i cert-manager \
29+
```shell
30+
kctrl package install -i cert-manager \
4131
-p cert-manager.packages.kadras.io \
4232
-v 1.10.1 \
43-
-n carvel-packages
44-
```
33+
-n kadras-packages
34+
```
35+
36+
### Verification
37+
38+
You can verify the list of installed Carvel packages and their status.
4539

46-
You can retrieve the list of available versions with the following command.
40+
```shell
41+
kctrl package installed list -n kadras-packages
42+
```
4743

48-
```shell
49-
kctrl package available list -p cert-manager.packages.kadras.io
50-
```
44+
### Version
5145

52-
You can check the list of installed packages and their status as follows.
46+
You can get the list of versions available in the Kadras package repository for Cert Manager.
5347

54-
```shell
55-
kctrl package installed list -n carvel-packages
56-
```
48+
```shell
49+
kctrl package available list -p cert-manager.packages.kadras.io -n kadras-packages
50+
```
5751

5852
## Configuration
5953

@@ -65,23 +59,53 @@ The Cert Manager package has the following configurable properties.
6559

6660
You can define your configuration in a `values.yml` file.
6761

68-
```yaml
69-
namespace: cert-manager
70-
```
62+
```yaml
63+
namespace: cert-manager
64+
```
7165
72-
Then, reference it from the `kctrl` command when installing or upgrading the package.
66+
Then, pass the file when installing the package.
7367
74-
```shell
75-
kctrl package install -i cert-manager \
68+
```shell
69+
kctrl package install -i cert-manager \
7670
-p cert-manager.packages.kadras.io \
7771
-v 1.10.1 \
78-
-n carvel-packages \
72+
-n kadras-packages \
7973
--values-file values.yml
80-
```
74+
```
75+
76+
## Upgrading
77+
78+
You can upgrade an existing package to a newer version using `kctrl`.
79+
80+
```shell
81+
kctrl package installed update -i cert-manager \
82+
-v <new-version> \
83+
-n kadras-packages
84+
```
85+
86+
You can also update an existing package with a newer `values.yml` file.
87+
88+
```shell
89+
kctrl package installed update -i cert-manager \
90+
-n kadras-packages \
91+
--values-file values.yml
92+
```
93+
94+
## Other
95+
96+
The recommended way of installing the Cert Manager package is via the [Kadras package repository](https://github.com/arktonix/kadras-packages). If you prefer not using the repository, you can install the package by creating the necessary Carvel `PackageMetadata` and `Package` resources directly
97+
using [`kapp`](https://carvel.dev/kapp/docs/latest/install) or `kubectl`.
98+
99+
```shell
100+
kubectl create namespace kadras-packages
101+
kapp deploy -a cert-manager-package -n kadras-packages -y \
102+
-f https://github.com/arktonix/package-for-cert-manager/releases/latest/download/metadata.yml \
103+
-f https://github.com/arktonix/package-for-cert-manager/releases/latest/download/package.yml
104+
```
81105

82-
## Documentation
106+
## Support and Documentation
83107

84-
For documentation specific to Cert Manager, check out [cert-manager.io](https://cert-manager.io).
108+
For support and documentation specific to Cert Manager, check out [cert-manager.io](https://cert-manager.io).
85109

86110
## References
87111

0 commit comments

Comments
 (0)