Skip to content

Commit

Permalink
update docker images
Browse files Browse the repository at this point in the history
  • Loading branch information
vcutrona committed Aug 17, 2023
1 parent af08a47 commit bdd088e
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 33 deletions.
Empty file removed .gitignore
Empty file.
14 changes: 7 additions & 7 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:

im:
container_name: im
image: registry.gitlab.com/isteps-sps-lab/human-robot-interaction/better-factory/im:0.1
image: docker.ramp.eu/supsi-pvt/intervention-manager:0.1.9
environment:
DIGITAL_WORKPLACE_PASSWORD: $BF_PASSWORD
DIGITAL_WORKPLACE_URL: http://models:8080/rest
Expand All @@ -26,14 +26,14 @@ services:

kafka-message-model:
container_name: kafka-message-model
image: registry.gitlab.com/isteps-sps-lab/human-robot-interaction/better-factory/kafka-message-model:0.1
image: docker.ramp.eu/supsi-pvt/kafka-message-model:0.1.0
restart: on-failure
volumes:
- message_model:/schemas:rw

middleware:
container_name: middleware
image: registry.gitlab.com/isteps-sps-lab/human-robot-interaction/better-factory/middleware:0.1
image: docker.ramp.eu/supsi-pvt/middleware:0.1.1
environment:
ADV_HOST: middleware
BROKER_PORT: 9092
Expand All @@ -54,7 +54,7 @@ services:

models:
container_name: models
image: registry.gitlab.com/complemant/integration/data-models:latest
image: docker.ramp.eu/betterfactory/data-models:1.0.0
environment:
ADMIN_PASSWORD: $BF_PASSWORD
ADMIN_USERNAME: $BF_USER
Expand All @@ -70,7 +70,7 @@ services:
MQTT_PORT: 1883
MQTT_USER: $BF_USER
MYSQL_DB: $MODELS_MYSQL_DATABASE
MYSQL_HOST: models_db
MYSQL_HOST: models-db
MYSQL_PASS: $BF_PASSWORD
MYSQL_PORT: 3306
MYSQL_USER: $BF_USER
Expand All @@ -84,9 +84,9 @@ services:
- ./init-data:/var/human/init-data:rw
depends_on:
- middleware
- models_db
- models-db

models_db:
models-db:
container_name: models-db
image: mysql:5.7
environment:
Expand Down
14 changes: 6 additions & 8 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ The deployment is based on Docker Compose, and the set of initialized components

``` mermaid
flowchart LR
classDef supsi fill:#B4C7DC;
classDef pub fill:#B2B2B2
classDef pvt fill:#E8F2A1
classDef supsi fill:#B4C7DC,color:#000;
classDef pvt fill:#B2B2B2,color:#000;
classDef pub fill:#E8F2A1,color:#000;
subgraph SUPSI
direction TB
Expand All @@ -25,10 +25,11 @@ flowchart LR
```

The blue-colored components represent the core components for which SUPSI provides and maintains a Docker image; the other components (grey- and green-colored) represent dependencies that are provided as Docker images by third parties.
The blue-colored components represent the core components for which SUPSI provides and maintains a Docker image; the other components represent Docker images that are either publicly available (green-colored) or maintened by other Better Factory partners (grey-colored).

!!! info
In this deployment version, the only external dependencies that is available only in a private registry is *models*. The *models* image is provided and maintained by Holonix (HOL) within the Better Factory project.

In this deployment version, all the Docker images but the public ones can be downloaded from the [RAMP Docker Registry](https://docker.ramp.eu/).

## Dependencies

Expand All @@ -46,8 +47,5 @@ This component embeds the data model shared within the Better Factory project. T
### models
The *models* component exposes a REST API to access the data model shared among all the components involved in the C-HRI scenario. The API is accessed by the IM to fetch information about workers and other factory elements.

!!! important
This image is available in a private Docker registry hosted at GitLab. Please ask HOLONIX to get access to this image.

### models-db
The *models-db* component runs an official MySql docker image (v5.7).
11 changes: 0 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@ rules are known to the IM, which decides which is the best one to trigger.
- [Getting Started](getting-started.md)
- User & Programmers Manual
- [Architecture](architecture.md)
- [API](api.md)
- [User Manual](usermanual.md)
- Installation & Administration Manual
- [Installation Guide](installationguide.md)
- [Acknowledgement](#acknowledgement)
- [Changelog](#changelog)
- [v0.1](#v01)
- [Authors](#authors)

## Authors

Expand All @@ -30,9 +25,3 @@ rules are known to the IM, which decides which is the best one to trigger.
H2020 Innovation Action -- This project has received funding from the
European Union's Horizon 2020 research and innovation programme under
grant agreement No 951813.

## Changelog

### v0.1

- Technical documentation
21 changes: 14 additions & 7 deletions docs/installationguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,35 @@

## Requirements

All the components are provided as Dockerized applications, thus the following software is required:
All the components are provided as Dockerized applications, thus the following
software is required:

- Docker
- Docker Compose

!!! info
We tested our deployment on a machine running Ubuntu 21, with Docker v20.10.8, and Docker Compose v1.29.2.

We tested our deployment on machines running different configurations:

- Ubuntu 21, Docker 20.10.8, Docker Compose 1.29.2
- Ubuntu 22, Docker 24.0.5, Docker Compose 2.20.2

## Install

Before running the containers, it is required to download the Docker images from their respective registries.
While some images are publicly available, some other require credentials to be downloaded from private registries.

!!! faq
Images provided by SUPSI can be download from the GitLab container registry, which supports the token-based authentication. Please send your request for a new token to the repository maintainers.

Once you are provided with a username and a token, you can issue the following command to login to the private GitLab Docker registry and download the images:
Images can be download from the RAMP Docker registry, which supports the token-based authentication. Please send your
request for a new token to the RAMP Docker registry maintainers.

Once you are provided with a username and a token, you can issue the following
command to login to the RAMP Docker registry and download the images:

```shell
docker login registry.example.com -u <username> -p <token>
docker-compose pull
docker login docker.ramp.eu -u <username> -p <token>
docker-compose pull <image>:<tag>
```

## Usage
Expand Down Expand Up @@ -51,5 +59,4 @@ You can now access different components:
## Software Maintainers

- Vincenzo Cutrona - <vincenzo.cutrona@supsi.ch>
- Niko Bonomi - <niko.bonomi@supsi.ch>
- Giuseppe Landolfi - <giuseppe.landolfi@supsi.ch>

0 comments on commit bdd088e

Please sign in to comment.