From a625ef6c198c1d87be3787be78becb158098820e Mon Sep 17 00:00:00 2001 From: Bruno Domingues Date: Wed, 5 Nov 2025 21:26:58 -0300 Subject: [PATCH] SIENTIAPDE-1309: Add Helm chart documentation to README and update image tag in values.yaml --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ values.yaml | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fa12ae..9ff060a 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,8 @@ An enterprise-grade ML model training orchestration platform built on Temporal. - [Code Quality Standards](#code-quality-standards) - [License](#license) - [Support](#support) +- [Docker](#docker) +- [Helm Chart](#helm-chart) ## Features @@ -1059,6 +1061,46 @@ $ docker login -u bruno-aignosi -p LD/IyZ4vtDI7khRYnH4HzfdTx3toorg6hlCetJM54n+AC $ docker push aignosi.azurecr.io/sientia-dataops-model-manager:0.0.0 ``` +## Helm Chart + +### Reference + +https://www.baeldung.com/ops/kubernetes-helm + +### Create Helm Chart folder + +```shell +# inside project root folder +$ helm create helm-chart +``` + +### Helm Lint + +```shell +# Firstly, this is a simple command that takes the path to a chart and runs a battery of tests to ensure that the chart is well-formed: +$ helm lint ./helm-chart +``` + +### Helm Template + +```shell +# Also, we've this command to render the template locally for quick feedback: +$ helm template ./helm-chart +``` + +### Helm Install + +```shell +# Once we've verified the chart to be fine, finally, we can run this command to install the chart into the Kubernetes cluster: +$ helm upgrade --install mlops-bff ./helm-chart -n sientia-core +``` + +### Uninstall Helm Chart + +```shell +$ helm uninstall mlops-bff -n sientia-core +``` + --- **Note**: The Model Manager system is designed for production use in industrial ML environments. Ensure proper security configuration and network isolation for production deployments. diff --git a/values.yaml b/values.yaml index fc71161..d8d6f2b 100644 --- a/values.yaml +++ b/values.yaml @@ -13,7 +13,7 @@ image: # Overrides the image tag whose default is the chart appVersion. tag: "0.0.2" -0# This is for the secrets for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +# This is for the secrets for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ imagePullSecrets: - name: docker-hub-secret # This is to override the chart name.