Move charts to helm-charts repo

README.md

@@ -65,11 +65,69 @@ make run-loki-server
 
 ### Helm Chart Support
 A custom collector with Audit Logs receiver may be hosted on Kubernetes,
-so to facilitate that the repository contains a [Helm Chart](./charts).
+so to facilitate that a Helm Chart is published in [castai/helm-charts](https://github.com/castai/helm-charts).
 
 One important aspect of hosting this collector on Kubernetes is that it is deployed as StatefulSet and uses PersistentVolumeClaim for storing data about fetching Audit Logs.
 This data is required to ensure that all Audit Logs are collected even in case when Collector's pod got restarted.
 
+### 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 is set up properly, add [castai/helm-charts](https://github.com/castai/helm-charts) repository as follows:
+
+```console
+helm repo add castai-helm https://castai.github.io/helm-charts
+```
+To install Audit Logs receiver's release:
+  * set `castai.apiKey` property to your CAST AI [API Access key](https://docs.cast.ai/docs/authentication#obtaining-api-access-key)
+  * deploy the chart:
+```shell
+helm install logs-receiver castai-helm/castai-audit-logs-receiver \ 
+  --namespace=castai-logs \
+  --create-namespace \ 
+  --set castai.apiKey=<api_access_key>
+  --set castai.apiURL="https://api.cast.ai"
+```
+Default installation uses [logging](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/loggingexporter) as main log exporter but this can be changed by overriding chart's `config` property with desired collector's pipeline setup.  `collector-config.yaml` files for different exporter setups can be found in [examples](./examples/) directory for both reference and to create `values.yaml` file to pass to Helm chart.
+
+Example Helm install with Loki configuration:
+  * create your custom `values.yaml` with pipeline setup from [./examples/loki/collector-config.yaml](./examples/loki/collector-config.yaml):  
+```shell
+# values.yaml
+config:
+  exporters:
+    loki:
+      endpoint: http://localhost:3100/loki/api/v1/push
+
+  processors:
+    attributes: 
+      actions:
+        - action: insert
+          key: loki.attribute.labels
+          value: id, initiatedBy, eventType, labels.ClusterId
+
+  service:
+    pipelines:
+      logs:
+        receivers: [castai-audit-logs]
+        processors: [attributes]
+        exporters: [loki]
+```
+* deploy chart with `--values` flag set to `values.yaml`:
+```shell
+helm install logs-receiver castai-helm/castai-audit-logs-receiver \
+  --namespace=castai-logs --create-namespace \
+  --set castai.apiKey=<api_access_key>
+  --set castai.apiURL="https://api.cast.ai" \
+  --values values.yaml
+```
+
+To see all chart values that can be customized, run:
+```shell
+helm show values castai-helm/castai-audit-logs-receiver
+```
+
 ## License
 
 Code is licensed under the [Apache License 2.0](LICENSE). See [NOTICE.md](NOTICE.md) for complete details, including software and third-party licenses and permissions.