IoMBian Updatable Services Handler

This services is in charge of updating the updatable services field of the firestore device.

updatable_services is a field on each device that determines if a service can be updated. If there is a new version available of an installed service, it is represented like this:

{
    ...,
    updatable_services: {
        iombian-button-handler: "0.1.1"
    }
}

Whenever a new service version is added or the installed service version is updated, the updatable services changes.

Installation

• Define project name in an environment variable:

PROJECT_NAME=iombian-updatable-services-handler

• Clone the repo into a temp folder:

git clone https://github.com/Tknika/${PROJECT_NAME}.git /tmp/${PROJECT_NAME} && cd /tmp/${PROJECT_NAME}

• Create the installation folder and move the appropriate files (edit the user):

sudo mkdir /opt/${PROJECT_NAME}

sudo cp requirements.txt /opt/${PROJECT_NAME}

sudo cp -r src/* /opt/${PROJECT_NAME}

sudo cp systemd/${PROJECT_NAME}.service /etc/systemd/system/

sudo chown -R iompi:iompi /opt/${PROJECT_NAME}

• Create the virtual environment and install the dependencies:

cd /opt/${PROJECT_NAME}

python3 -m venv .venv

source .venv/bin/activate

pip install --upgrade pip

pip install -r requirements.txt

• Start the script

sudo systemctl enable ${PROJECT_NAME}.service && sudo systemctl start ${PROJECT_NAME}.service

Docker

To build the docker image, from the cloned repository, execute the docker build command in the same level as the Dockerfile:

docker build -t ${IMAGE_NAME}:${IMAGE_VERSION} .

For example docker build -t iombian-updatable-services-handler:latest .

After building the image, execute it with docker run:

docker run --name ${CONTAINER_NAME} --rm -d -e CONFIG_PORT=5555 iombian-updatable-services-handler:latest

• --name is used to define the name of the created container.
• --rm can be used to delete the container when it stops. This parameter is optional.
• -d is used to run the container detached. This way the container will run in the background. This parameter is optional.
• -e can be used to define the environment variables:
  • CONFIG_HOST: the host of the IoMBian Config File Handler. Default value is "127.0.0.1".
  • CONFIG_PORT: the port of the IoMBian Config File Handler. Default value is 5555.
  • LOG_LEVEL: define the log level for the python logger. This can be DEBUG, INFO, WARN or ERROR. Default value is INFO.

Otherwise, a docker-compose.yml file can also be used to launch the container:

version: 3

services:
  iombian-updatable-services-handler:
    image: iombian-updatable-services-handler:latest
    container_name: iombian-updatable-services-handler
    restart: unless_stopped
    environment:
      CONFIG_HOST: "iombian-config-file-handler"
      CONFIG_PORT: 5555
      LOG_LEVEL: "INFO"

docker compose up -d

Author

(c) 2024 IoMBian team (Aitor Iturrioz Rodríguez, Aitor Castaño Mesa).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.