Skip to content

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 20c96d6 commit a2b8b4c
Showing 1 changed file with 7 additions and 7 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 Weaviate 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 weaviate-package -n kadras-packages -y \
kubectl create namespace kadras-system
kapp deploy -a weaviate-package -n kadras-system -y \
-f https://github.com/kadras-io/package-for-weaviate/releases/latest/download/metadata.yml \
-f https://github.com/kadras-io/package-for-weaviate/releases/latest/download/package.yml
```
Expand All @@ -48,20 +48,20 @@ Install the Weaviate package:
kctrl package install -i weaviate \
-p weaviate.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 weaviate.packages.kadras.io -n kadras-packages
> kctrl package available list -p weaviate.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 @@ -84,7 +84,7 @@ Reference the `values.yml` file from the `kctrl` command when installing or upgr
kctrl package install -i weaviate \
-p weaviate.packages.kadras.io \
-v ${VERSION} \
-n kadras-packages \
-n kadras-system \
--values-file values.yml
```

Expand Down

0 comments on commit a2b8b4c

Please sign in to comment.