Skip to content

Commit e4e7c6c

Browse files
committed
feat(helm): Add observability example. add docs. Add dashboard for opensearch
1 parent b512bda commit e4e7c6c

4 files changed

Lines changed: 9 additions & 11 deletions

File tree

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,15 @@
11
# Cogstack Helm Charts
22

3-
The Helm charts for CogStack are published to Docker Hub, which is an OCI-compliant registry.
43

54
## Chart Listings
65

7-
- **MedCAT Service:**
8-
https://hub.docker.com/r/cogstacksystems/medcat-service-helm
9-
10-
- **MedCAT Trainer:**
11-
https://hub.docker.com/r/cogstacksystems/medcat-trainer-helm
12-
13-
- **CogStack CE (Community Edition, umbrella chart):**
14-
https://hub.docker.com/r/cogstacksystems/cogstack-ce-helm
15-
166
- [MedCAT Service Helm](medcat-service-helm.md)
177
- [MedCAT Trainer Helm](medcat-trainer-helm.md)
188
- [CogStack Community Edition Helm](cogstack-ce-helm.md)
9+
- [CogStack Observability Helm](cogstack-observability-helm.md.md)
1910

2011
## Chart Publishing
2112

13+
The Helm charts for CogStack are published to Docker Hub, which is an OCI-compliant registry. You can see the charts on Dockerhub https://hub.docker.com/r/cogstacksystems
14+
2215
Charts are published automatically via a GitHub Action on every commit to the main branch.

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ nav:
7070
- MedCAT Service Helm: platform/deployment/helm/charts/medcat-service-helm.md
7171
- MedCAT Trainer Helm: platform/deployment/helm/charts/medcat-trainer-helm.md
7272
- Cogstack CE Helm: platform/deployment/helm/charts/cogstack-ce-helm.md
73+
- Cogstack Observability Helm: platform/deployment/helm/charts/cogstack-observability-helm.md
7374
- Examples:
7475
- Examples: platform/deployment/examples/_index.md
7576
- AWS Kubernetes EKS: platform/deployment/examples/aws-kubernetes-eks.md

helm-charts/cogstack-observability-helm/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This chart installs the observability stack for a CogStack deployment on Kubernetes.
44

5+
It is a wrapper around the kube-prometheus-stack, aiming to provide a simple way to get with observability for cogstack services.
6+
57
## Overview
68

79
This chart deploys:
@@ -24,7 +26,7 @@ This chart is intended to be installed alongside a CogStack deployment that expo
2426
## Installation
2527

2628
```sh
27-
helm install cogstack-observability oci://registry-1.docker.io/cogstacksystems/cogstack-observability-helm --namespace observability --create-namespace
29+
helm install observability oci://registry-1.docker.io/cogstacksystems/cogstack-observability-helm
2830
```
2931

3032
If you are deploying this alongside `cogstack-ce-helm`, you can enable the required monitors in the CE chart with the example override file at `../cogstack-ce-helm/values-observability.yaml`.

helm-charts/cogstack-observability-helm/README.md.gotmpl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This chart installs the observability stack for a CogStack deployment on Kubernetes.
44

5+
It is a wrapper around the kube-prometheus-stack, aiming to provide a simple way to get with observability for cogstack services.
6+
57
## Overview
68

79
This chart deploys:

0 commit comments

Comments
 (0)