From b292294ad7b1a35e45c9c6606f4d2ecab40444ec Mon Sep 17 00:00:00 2001
From: stedif <stefano.difrischia@inaf.it>
Date: Wed, 28 Sep 2022 13:01:19 +0200
Subject: [PATCH] L2SS-822: add documentation

---
 docker-compose/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docker-compose/README.md b/docker-compose/README.md
index d76a75b0c..c68719dc3 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -39,6 +39,23 @@ registry and uploaded to our own using matching tags.
 
 Services, same mechanism as devices.
 
+### HDB++ image updates
+
+The hdbpp Docker image is used as a base image for the hdbppts-cm (ConfigurationManager) and hdbppts-es (EventSubscriber)
+images. If one is developing on a branch and any updates is made in hdbpp/Dockerfile, those won't be automatically picked up from hdbppts-cm and hdbppts-es, because the argument SOURCE_IMAGE in the docker-compose yml file always refers to the remote hdbpp image in the repository. 
+
+A temporary workaround for locally testing on these archiving containers is the following:
+
+- Stop and remove any running hdbpp* container
+- In the archiver-timescale.yml file, replace the hdbppts-cm and hdbppts-es SOURCE_IMAGE tag 'latest' with the branch name 
+(e.g. SOURCE_IMAGE: ${LOCAL_DOCKER_REGISTRY_HOST}/${LOCAL_DOCKER_REGISTRY_USER}/hdbpp:l2ss-new-branch)
+- Rebuild all the hdbpp* container (make build hdbpp hdbppts-cm hdbppts-es), and then start them
+- Test the new features
+
+After the branch has been correctly developed, tested, the merge has been approved, and the new images have been built on the repository:
+- Put back 'latest' tag on the archiver-timescale.yml file, replacing the branch name
+- Merge on master 
+
 ### Setup and maintenance
 
 All behavioral logic to orchestrate change detection and image pushing can be
-- 
GitLab