From 9e4b8f890e9d44221df3720d31a1fb54209e3e10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel=20Herranz=20Trillo?= Date: Thu, 26 Oct 2023 18:10:06 +0200 Subject: [PATCH] doc(readme): Add Midokura notes about this repo (#50) --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e085f54..facfba20 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # Kubernetes resources configuration for ThingsBoard -Here you can find scripts for deployment on different Kubernetes platforms. \ No newline at end of file +Here you can find scripts for deployment on different Kubernetes platforms. + +# Midokura notes + +This fork is expected to be in sync with [Thingsboard upstream](https://github.com/thingsboard/thingsboard). + +Most of Midokura changes will be related to the official Midokura way to deploy +Thingsboard that is Helm chart (code inside `helm/` directory). + +Code for other deployments (`aws/`, `azure/`, `gcp`, `minikube`, `openshift` +and maybe others in the future) WILL NOT include Midokura specific changes, and +it is just left here to make upstream syncing easier. + +If you are a Midokura engineer you SHOULD use only the contents in `helm/` +directory. Other options may miss important changes for production environment +and should be avoided.