From 60062a3b83589b232f110041ce3422c018b7f8a6 Mon Sep 17 00:00:00 2001 From: Sergii Mikhtoniuk Date: Tue, 26 Nov 2024 13:43:01 -0800 Subject: [PATCH] Update readme --- README.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 58bcd28..0de078f 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,15 @@ Official [Helm](https://helm.sh) charts for deploying [Kamu](https://kamu.dev) components in [Kubernetes](https://kubernetes.io). +## Using +See [Kamu Node documentation](https://docs.kamu.dev/node/) for architecture overview and deployment instructions. -## Usage -[Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs) to get started. - -Once Helm has been set up correctly, add the repo as follows: - - helm repo add kamu https://kamu-data.github.io/helm-charts - -If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. You can then run `helm search repo -kamu` to see the charts. - -To install, for example, the `kamu-api-server` chart: - - helm install my-kamu-api-server kamu/kamu-api-server - -To uninstall the chart: - - helm delete my-kamu-api-server +See [kamu-deploy-example](https://github.com/kamu-data/kamu-deploy-example) repository for recommended Infrastructure-as-Code setup. ## Contributing -The source code of all Kamu Helm charts can be found on Github: [https://github.com/kamu-data/helm-charts/](https://github.com/kamu-data/helm-charts/) - -We'd love to have you contribute! Please refer to our [developer documentation](https://github.com/kamu-data/helm-charts/blob/master/DEVELOPERS.md) for details. +Contributions are welcome! Please refer to our [developer documentation](https://github.com/kamu-data/helm-charts/blob/master/DEVELOPERS.md) for details. ## License -Apache 2.0 License. +Charts are provided under Apache 2.0 License.