README.md 2.9 KB
Newer Older
Tomasz Walkowiak's avatar
Tomasz Walkowiak committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
# Zawartość katalogu
## budowanie kontenerów
### pliki Dockerfile
- base.Dockerfile - bazowy obraz
- gtpprmc.Dockerfile - obraz z narzędziem gtpprmc, na podst. obrazu bazowego,
  kompilacja ze źródeł
- gtpprmc-precomp.Dockerfile - obraz z narzędziem gtpprmc, na podst. obrazu
  bazowego, instalacja ze skompilowanej wcześniej paczki
- kwazon.Dockerfile - obraz z narzędziem kwazon, na podst. obrazu gtpprmc,
  używany przez docker-compose
### Pomocnicze skrypty
- build.sh - skrypt ułatwiający budowanie powyższych obrazów
- install_resources.sh - skrypt ułatwiający instalowanie dużych zasobów
  - pobranie
  - instalacja w odpowiednim katalogu
  - modyfikacja pliku konfiguracyjnego (wskazanie na zainstalowane zasoby)
### Zasoby do skryptów
- resources-0.9.install - plik ze URLami do zasobów instalowanych w czasie
  budowania kwazon (używany przez install_resources.install)  
## skrypty konfuguracyjne kontenera kwazon
- init.sh - startuje narzędzia wewnątrz kontenera
- clean.sh - czyści logi
## pliki do usługi
- kwazon_worker.py - worker dla kwazon
- config.ini - config do workera

# Budowanie narzędzia kwazon
## Krótka instrukcja
1. Zbudowanie zależności
```
./build.sh base
./build.sh gtpprmc-precomp
```
lub
```
./build.sh base	--no-cache
./build.sh gtpprmc-precomp --no-cache
```
lub
```
./build.sh base
./build.sh gtpprmc-precomp
```
jeśli chcemy korzystać z pośrednich obrazów z ostatniego budowania.
Jeśli chcemy kompilować ze źródeł to należy użyć *gtpprmc*
zamiast *gtpprmc-precomp*:
```
./build.sh gtpprmc --no-cache
```
2. budowanie narzędzia
```
cd ..
docker-compose build kwazon
```
3. Uruchomienie narzędzia
```
docker-compose up -d kwazon
```

## Budowanie obrazu
Budowanie obrazu dla narzędzia kwazon jest podzielone na trzy etapy.
Przygotowano cztery Dockerfile kolejno dla obrazu: podstawowego, dwie
wersje Dockerfile dla customowej wersji graph_toola (prekompilowana paczka oraz
pełna kompilacja) oraz dla narzędzia kwazon. Każdy kolejny obraz jest 
budowany na podstawie poprzedniego.

Przygotowano skrypt build.sh ułatwiający budowanie obrazów.

Zbudowanie wszystkich obrazów (pierwszego i wszystkich kolejnych):
./build.sh base --all

Zbudowanie wybranego obrazu:
./build.sh kwazon

### Fazy budujące poszczególne obrazy (dla skryptu build.sh):
- base
- gtpprmc - wersja z kompilacją ze źródeł
- gtpprmc-precomp - budowanie ze skompilowanej paczki
- kwazon

### Obrazy są budowane z tagami:
- base_image:"azon/kwazon-base"
- gtpprmc_image:"azon/kwazon-gtpprmc"
- complete_image:"azon/kwazon"

### Zasoby wymagane do poszczególnych wersji kwazon
- Plik 'resources-0.9.install' zawiera listę zasobów wymaganych dla wersji 0.9.
- Plik 'resources-0.8.install' zawiera listę zasobów wymaganych dla wersji 0.8.
- Plik 'resources-without-vecs.install' zawiera listę zasobów wymaganych dla wersji 0.6.
- Plik 'resources.install' zawiera listę zasobów wymaganych dla wersji 0.7.