Skip to content
This repository has been archived by the owner on Jan 11, 2025. It is now read-only.

Commit

Permalink
docs: Update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasVitale committed Mar 11, 2024
1 parent b6b0728 commit c5d75b3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ Add the Kadras [package repository](https://github.com/kadras-io/kadras-packages
```shell
kctrl package repository add -r kadras-packages \
--url ghcr.io/kadras-io/kadras-packages \
-n kadras-packages --create-namespace
-n kadras-system --create-namespace
```

<details><summary>Installation without package repository</summary>
The recommended way of installing the kpack package is via the Kadras <a href="https://github.com/kadras-io/kadras-packages">package repository</a>. If you prefer not using the repository, you can add the package definition directly using <a href="https://carvel.dev/kapp/docs/latest/install"><code>kapp</code></a> or <code>kubectl</code>.

```shell
kubectl create namespace kadras-packages
kapp deploy -a kpack-package -n kadras-packages -y \
kubectl create namespace kadras-system
kapp deploy -a kpack-package -n kadras-system -y \
-f https://github.com/kadras-io/package-for-kpack/releases/latest/download/metadata.yml \
-f https://github.com/kadras-io/package-for-kpack/releases/latest/download/package.yml
```
Expand All @@ -48,20 +48,20 @@ Install the kpack package:
kctrl package install -i kpack \
-p kpack.packages.kadras.io \
-v ${VERSION} \
-n kadras-packages
-n kadras-system
```

> **Note**
> You can find the `${VERSION}` value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.
>
> ```shell
> kctrl package available list -p kpack.packages.kadras.io -n kadras-packages
> kctrl package available list -p kpack.packages.kadras.io -n kadras-system
> ```
Verify the installed packages and their status:
```shell
kctrl package installed list -n kadras-packages
kctrl package installed list -n kadras-system
```
## 📙&nbsp; Documentation
Expand All @@ -87,7 +87,7 @@ Reference the `values.yml` file from the `kctrl` command when installing or upgr
kctrl package install -i kpack \
-p kpack.packages.kadras.io \
-v ${VERSION} \
-n kadras-packages \
-n kadras-system \
--values-file values.yml
```

Expand Down
4 changes: 2 additions & 2 deletions docs/default-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can pass the container registry credentials via a Secret, which needs to be
kp_default_repository:
secret:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system
```

If you use this package outside the Kadras Engineering Platform, you also need to configure it to export the Secret from the source namespace to the kpack namespace.
Expand All @@ -39,7 +39,7 @@ If you use this package outside the Kadras Engineering Platform, you also need t
kp_default_repository:
secret:
name: supply-chain-registry-credentials
namespace: kadras-packages
namespace: kadras-system
create_export: true
```

Expand Down

0 comments on commit c5d75b3

Please sign in to comment.