From 41f8fab5beef8aec780f2c500ac5401e83f931e7 Mon Sep 17 00:00:00 2001
From: "Benguria Elguezabal, Gorka" <gorka.benguria@tecnalia.com>
Date: Sun, 20 Oct 2024 12:25:20 +0200
Subject: [PATCH] adds update guideliness

---
 component_update.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/component_update.md b/component_update.md
index e69de29..b4be0a1 100644
--- a/component_update.md
+++ b/component_update.md
@@ -0,0 +1,37 @@
+# Component Update
+
+Components are updated to fix bugs, add new features, or improve performance. In this guide, we will show you how the different ways in which a component can be updated.
+
+There are two ways to update a component:
+- Automatically by RenovateBot
+- Manually
+
+Finally, there may be situations when configuration changes are require appart from the component update. This will be explained in the last section.
+
+## Table of contents
+- [Automatically by RenovateBot](#automatically-by-renovatebot)
+- [Manually](#manually)
+- [Configuration changes](#configuration-changes)
+
+## Automatically by RenovateBot
+
+RenovateBot is a tool that helps you to keep your dependencies up to date. It will automatically create pull requests to update the dependencies of the components. It will periodically check the component versions in the docker image registry and create a pull request if a new version is available.
+
+This procedure is transparent to the developers.
+
+## Manually
+
+This is required when the component does not use versioning. If you need to update a component manually, you can follow these steps:
+- Ensure the new version is available in the docker image registry.
+- Login into the [kubernetes cluster](https://k8so.emerald.digital.tecnalia.dev).
+- Find the pod that uses the component you want to update.
+- Delete the pod.
+- The pod will be recreated with the new version of the component.
+
+## Configuration changes
+
+Sometimes, when a component is updated, configuration changes are required. This is because the new version of the component may have new features or changes in the configuration. In this case, the component configuration files should be updated.
+
+To do so, create an issue and an MR in the CaaS Framework repository with the changes required in the configuration files. The MR should be reviewed and merged by the CaaS Framework administrator.
+
+In the case of automatic updates, it may happen that the component update fails and the MR is not merged. In this case, add the configuration changes to the MR and ask the CaaS Framework administrator to merge it.
-- 
GitLab