update docs

Altinity · Sep 30, 2024 · 5cd6019 · 5cd6019
1 parent 0ba1614
commit 5cd6019
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 95 deletions.
diff --git a/README.md b/README.md
@@ -29,8 +29,8 @@ helm install clickhouse-operator clickhouse-operator/altinity-clickhouse-operato
 
 ## Helm Charts
 
-- **[clickhouse-eks](./helm/clickhouse-eks/)**: Deploys ClickHouse optimized for AWS EKS.
-- **[keeper-sts](./helm/keeper-sts/)**: Deploys ClickHouse Keeper using StatefulSets for better data persistence.
+- **[clickhouse-eks](./charts/clickhouse-eks/)**: Deploys ClickHouse optimized for AWS EKS.
+- **[keeper-sts](./charts/keeper-sts/)**: Deploys ClickHouse Keeper using StatefulSets for better data persistence.
 
 ### How to Install a Chart
 

diff --git a/charts/clickhouse-eks/README.md b/charts/clickhouse-eks/README.md
@@ -1,6 +1,6 @@
 # clickhouse-eks
 
-![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
+![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
 
 A Helm chart for ClickHouse running on AWS EKS across AZs using a nodeSelector to pin resources to run on specific VMs types
 

diff --git a/charts/clickhouse-keeper-sts/README.md b/charts/clickhouse-keeper-sts/README.md
@@ -1,53 +1,9 @@
-
-
-# clickhouse-keeper
+# clickhouse-keeper-sts
 
 ![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 24.3.6.48](https://img.shields.io/badge/AppVersion-24.3.6.48-informational?style=flat-square)
 
 A ClickHouse Keeper chart for Kubernetes
 
-## Installing the Chart
-
-```sh
-# add the kubernetes-blueprints-for-clickhouse chart repository
-helm repo add kubernetes-blueprints-for-clickhouse https://altinity.github.io/kubernetes-blueprints-for-clickhouse
-
-# use this command to install clickhouse-keeper chart (it will also create a `clickhouse` namespace)
-helm install ch kubernetes-blueprints-for-clickhouse/clickhouse-keeper --namespace clickhouse --create-namespace
-```
-
-> Use `-f` flag to override default values: `helm install -f newvalues.yaml`
-
-## Upgrading the Chart
-```sh
-# get latest repository versions
-helm repo update
-
-# upgrade to a newer version using the release name (`ch`)
-helm upgrade ch kubernetes-blueprints-for-clickhouse/clickhouse-keeper --namespace clickhouse
-```
-
-## Uninstalling the Chart
-
-```sh
-# uninstall using the release name (`ch`)
-helm uninstall ch --namespace clickhouse
-```
-
-> This command removes all the Kubernetes components associated with the chart and deletes the release.
-
-## Connecting to your ClickHouse Cluster
-
-```sh
-# list your pods
-kubectl get pods --namespace clickhouse
-
-# pick any of your available pods and connect through the clickhouse-client
-kubectl exec -it chi-eks-dev-0-0-0 --namespace clickhouse -- clickhouse-client
-```
-
-> Use `kubectl port forward` to access your ClickHouse cluster from outside: `kubectl port-forward service clickhouse-eks 9000:9000 & clickhouse-client`
-
 ## Values
 
 | Key | Type | Default | Description |
@@ -90,3 +46,6 @@ kubectl exec -it chi-eks-dev-0-0-0 --namespace clickhouse -- clickhouse-client
 | tolerations | list | `[]` |  |
 | volumeMounts | list | `[]` |  |
 | volumes | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/charts/clickhouse/README.md b/charts/clickhouse/README.md
@@ -1,59 +1,15 @@
-
-
 # clickhouse
 
-![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 23.8.8.21](https://img.shields.io/badge/AppVersion-23.8.8.21-informational?style=flat-square)
+![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 23.8.8.21](https://img.shields.io/badge/AppVersion-23.8.8.21-informational?style=flat-square)
 
 A Helm chart for creating a ClickHouse Cluster with the Altinity Operator for ClickHouse
 
 ## Requirements
 
 | Repository | Name | Version |
 |------------|------|---------|
-| file://../clickhouse-keeper-sts | keeper(clickhouse-keeper) | 0.1.3 |
-| https://altinity.github.io/clickhouse-operator | operator(altinity-clickhouse-operator) | 0.23.6 |
-
-## Installing the Chart
-
-```sh
-# add the kubernetes-blueprints-for-clickhouse chart repository
-helm repo add kubernetes-blueprints-for-clickhouse https://altinity.github.io/kubernetes-blueprints-for-clickhouse
-
-# use this command to install clickhouse chart (it will also create a `clickhouse` namespace)
-helm install ch kubernetes-blueprints-for-clickhouse/clickhouse --namespace clickhouse --create-namespace
-```
-
-> Use `-f` flag to override default values: `helm install -f newvalues.yaml`
-
-## Upgrading the Chart
-```sh
-# get latest repository versions
-helm repo update
-
-# upgrade to a newer version using the release name (`ch`)
-helm upgrade ch kubernetes-blueprints-for-clickhouse/clickhouse --namespace clickhouse
-```
-
-## Uninstalling the Chart
-
-```sh
-# uninstall using the release name (`ch`)
-helm uninstall ch --namespace clickhouse
-```
-
-> This command removes all the Kubernetes components associated with the chart and deletes the release.
-
-## Connecting to your ClickHouse Cluster
-
-```sh
-# list your pods
-kubectl get pods --namespace clickhouse
-
-# pick any of your available pods and connect through the clickhouse-client
-kubectl exec -it chi-eks-dev-0-0-0 --namespace clickhouse -- clickhouse-client
-```
-
-> Use `kubectl port forward` to access your ClickHouse cluster from outside: `kubectl port-forward service clickhouse-eks 9000:9000 & clickhouse-client`
+| https://docs.altinity.com/clickhouse-operator | operator(altinity-clickhouse-operator) | 0.23.6 |
+| https://helm.altinity.com | keeper(clickhouse-keeper-sts) | 0.1.3 |
 
 ## Values
 
@@ -84,3 +40,6 @@ kubectl exec -it chi-eks-dev-0-0-0 --namespace clickhouse -- clickhouse-client
 | keeper.enabled | bool | `false` | Whether to enable Keeper. Required for replicated tables. |
 | keeper.replicaCount | int | `3` | Number of keeper replicas. Must be an odd number. !! DO NOT CHANGE AFTER INITIAL DEPLOYMENT |
 | operator.enabled | bool | `true` | Whether to enabled the Altinity Operator for ClickHouse. Disable if you already have the Operator installed cluster-wide. |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)