Instalator

Wstęp.

Instalator to kreator instalowania systemu PlusWorkflow z wszystkimi niezbędnymi do jego działania komponentami takimi jak baza danych, serwer aplikacyjny Tomcat, środowisko uruchomieniowe JAVA itp. tak aby system był gotowy do uruchomienia w jak najkrótszym czasie, bez potrzeby instalacji dodatkowych elementów. Instalator pozwala na wybranie własnych ustawień i wielokrotnie proponuje domyślne ustawienia.

Dodatkowe informacje.

• instalator PlusWorkflow można pobrać z http://192.168.1.111:8080/job/plusworkflow-release-pipeline/lastSuccessfulBuild/artifact/  lub w przypadku dostępu z zewnątrz po VPN z: http://jenkins.suncode.local:8080/job/plusworkflow-release-pipeline/lastSuccessfulBuild/artifact/ lub z: / (plusworkflow.pl)
• instalator jest dostępny w wersji dla Windows 64 bit oraz dla Linux
• instalator jest dostępny w polskiej i angielskiej wersji językowej
• zainstalowany PlusWorkflow korzysta z wbudowanej bazy Postgres lub zewnętrznych baz danych Postgres, MS SQL, Oracle, DB2
• zainstalowany PlusWorkflow jest uruchomiony na serwerze aplikacyjnym Tomcat

Instalacja PlusWorkflow w Windows.

Instalacja systemu PlusWorkflow za pomocą instalatora przebiega następująco :

1. Uruchom instalator jako administrator. Po uruchomieniu instalatora pojawi się okno powitalne, gdzie kliknij przycisk 'Dalej'.
   
   
   
   

2. Podaj główny katalog w którym zostaną zainstalowane potrzebne pliki i kliknij przycisk 'Dalej'.

   
   
   
   
3. Podaj katalog domowy w którym będzie umieszczona między innymi potrzebna konfiguracja, wtyczki, mapy procesu, logi i kliknij 'Dalej'.
   
   
   
   

4. Podaj numer portu serwera, który będzie używany do połączenia i kliknij 'Dalej'.

   
   
   
   

5. Podaj hasło do konta admin oraz wybierz, czy korzystać z wbudowanej bazy.
   
   

   Wybór zewnętrznej bazy

   W przypadku wyłączenia wbudowanej bazy instalator poinformuje o ręcznym skonfigurowaniu zewnętrznej bazy oraz restarcie serwisu.

   
   

6. Jeśli wcześniejsze ustawienia nie wymagają zmiany to wybierz przycisk 'Zainstaluj', co rozpocznie instalację.
   
   
   
   
7. Podczas instalacji widoczne będzie okno z aktualnym statusem przebiegu instalacji.
   
   

8. Po poprawnym zakończeniu instalacji pojawi się okno z odpowiednią informacją.
   
   
   
   

   Skrót do PlusWorkflow

   Po udanej instalacji w Windows, skrót do PlusWorkflow został umieszczony także w 'Wszystkie programy' -> 'PlusWorkflow'.
   Podczas pierwszego uruchomienia systemu zostanie przeprowadzona dalsza część konfiguracji zainstalowanego PlusWorkflow.

Instalacja wielu instancji na jednym serwerze

Instalator umożliwia zainstalowanie kilku instancji systemu. W zależności od wyboru instancji, zmianie ulegnie katalog instalacji, nazwa serwisu itp. Dostępne instancje:

• PROD
• TEST 
• DEV 
• default (domyślna)

Ponadto dostępne są ogólne instancje numerowane od 1  do 10 z prefixem P np. P1

Wybór instancji możliwy jest tylko poprzez linie komend. Wiersz poleceń uruchom jako administrator. Następnie należy uruchomić instalator używając komendy:

msiexec /i <wskazanie-instalatora.msi> MSINEWINSTANCE=<numer-instancji> TRANSFORMS=":<typ>"

np. instalacja instancji PROD odbywa poprzez:

msiexec /i plusworkflow-4.2.7-x64-pl.msi MSINEWINSTANCE=1 TRANSFORMS=":PROD"

  instalacja instancji TEST odbywa poprzez:

msiexec /i plusworkflow-4.2.10-x64-pl.msi MSINEWINSTANCE=2 TRANSFORMS=":TEST"

Instalacja PlusWorkflow na systemach Linux.

Instalacja na systemach z rodziny Linux odbywa się z pliku plusworkflow-<wersja>-x64.bin.

1. Po pobraniu instalatora należy dodać mu prawa do uruchomienia: chmod +x plusworkflow-<wersja>-x64.bin.
   
   
   
   

2. Następnie należy uruchomić instalator z prawami root (np. za pomocą komendy sudo).

   Instalator tworzy użytkownika plusworkflow, który będzie odpowiedzialny za uruchamianie systemu. Utworzony użytkownik nie ma nadanego hasła i nie jest możliwe zalogowanie się na jego konto.

   Uwaga

   W przypadku braku narzędzi curl, systemctl oraz netcat instalator przerwie działanie i wyświetli następujący monit.

   

   Instalacja wymaganych pakietów:

   Debian

   sudo apt update && sudo apt install curl systemctl netcat

   CentOs

   sudo yum update && sudo yum install curl systemctl nc

   Uwaga

   W przypadku braku biblioteki libfreetype.so.6(fontconfig) będziemy musieli doinstalować pakiety. Zmiana wymagana, ponieważ używamy teraz najnowszego wydania OpenJDK. (aktualnie: amazon-corretto-8.352.08.1)

    

   
   

   Instalacja wymaganych pakietów:

   Debian

   sudo apt update && sudo apt install fontconfig

   CentOs

   sudo yum update && sudo yum install fontconfig

    

   Jeżeli system nie zostanie uruchomiony po instalacji, zalecany jest downgrade do jdk-1.8u202_Oracle.

3. W kolejnych krokach instalator poprosi nas o podanie:
   - Typu instalacji: identyfikator instalacji który wpływa na domyślne katalogi oraz pozwala zarządzać różnymi instancjami z użyciem plusworkflow CLI
   - Katalogu instalacji: katalog w którym zainstalowane zostaną pliki systemu PlusWorkflow (katalog musi być pusty)
   - Katalogu domowego: katalog domowy w którym przechowywane będą ustawienia aplikacji i dane na temat systemu (katalog musi być pusty) 
   - Portu serwera: port serwera PlusWorkflow pod którym dostępna będzie aplikacja webowa
   - Nazwy serwisu (opcjonalnie): nazwa serwisu który będzie wykorzystywany do uruchamiania systemu (Instalator zapyta o to tylko w razie konfliktu z istniejącym serwisem)
   - Wbudowana baza danych (Y/n): określa czy system ma używać wbudowanej bazy danych. W przypadku wyłączenia wbudowanej bazy należy po instalacji określić połączenie do zewnętrznej bazy w pliku db.properties, który znajduje się w '<ścieżka do katalogu domowego>/config'. Następnie należy zrestartować serwis narzędziem plusworkflow lub użyć komendy 'systemctl restart <nazwa serwisu>.service' (np. systemctl restart plusworkflow-test.service)
   - Hasło admina: hasło jakie zostanie ustawione użytkownikowi admin

   Hasło admina systemu PlusWorkflow

   Jeżeli system operacyjny nie posiada pakietu openssl, to instalator pominie parametr 'Admin password'. Oraz wyświetli stosowny komunikat przy uruchomieniu instalatora.

   

   
   
   
   

   W nawiasach podane są domyślne wartości - jeżeli są one poprawne wystarczy zaakceptować wybór klawiszem Enter.

4. Następnie instalator rozpocznie instalacje - może to potrwać kilka minut. Po zakończonej instalacji system będzie już dostępny pod podanym adresem.

   
   

   Bez wbudowanej bazy

   W przypadku wyłączenia wbudowanej bazy instalator poinformuje o ręcznym skonfigurowaniu zewnętrznej bazy oraz restarcie serwisu.

   

Nadawanie uprawnień dla swojego użytkownika

Jeśli korzystamy z konta innego niż plusworkflow, to domyślnie w Linux nie będziemy mieli dostępu do plików systemu, możemy je sobie nadać bez zmiany domyślnych uprawnień poprzez komendę:

sudo setfacl -Rm d:u:suncode:rwx,g:suncode:rwx /home/plusworkflow/

PlusWorkflow CLI

Narzędzie plusworkflow służy do zarządzania zainstalowanymi instancjami systemu. Jest on domyślnie instalowany w /usr/bin. 

Komendy:

1. list - listuje zainstalowane instancje i ich status
   •  (running - serwis działa, healthy - serwer faktycznie odpowiada)
   • instancje default# to instancje w których podczas instalacji nie wybrano typu instalacji
2. start <instance-name> - uruchamia system
3. stop<instance-name> - zatrzymuje system
4. uninstall<instance-name> - umożliwia odinstalowanie systemu

• gdzie <instance-name> to nazwa typu instalacji (np. prod, test) - typy instalacji zwracane są komendą list

Przykładowy listing komendy list:

Pierwsze uruchomienie PlusWorkflow.

Po zainstalowaniu PlusWorkflow instalatorem, jego pierwsze uruchomienie przebiega następująco i pozwala na dalszą jego konfigurację.

1. W przeglądarce www pojawi się okno z możliwością skonfigurowania używanej bazy danych.
   W zależności od aktualnych potrzeb, podaj ustawienia do zewnętrznej bazy danych i wybierz 'Zapisz' albo wybierz przycisk 'Nadal korzystaj z wbudowanej bazy danych'.
   
   
   
   

   Wbudowana czy zewnętrzna baza ?

   Wbudowana baza danych jest zalecana tylko dla systemów tymczasowych np. demonstracyjnych.
   Natomiast systemy docelowe tj. deweloperskie, testowe, produkcyjne powinny korzystać z zewnętrznej bazy danych.

   Zewnętrzna baza

   Podana zewnętrzna baza musi istnieć już w momencie pierwszego uruchomienia, musi mieć założonego podanego użytkownika, ale może być pusta.

   Ponieważ przy uruchomieniu zostanie zbudowany potrzebny schemat bazy danych, ale baza nie jest tworzona.

2. Jeśli ustawienia są poprawne pokaże się okno logowania do PlusWorkflow, gdzie wpisz poprawny login i hasło administratora i wybierz przycisk 'Zaloguj'.
   
   
   
   

3. Pokaże się wtedy okno, gdzie wskaż odpowiednią licencję i potwierdź przycisk 'Tak' w celu załadowania wybranej licencji.
   
   

   Licencja

   Dla systemów tymczasowych możesz skorzystać z 30 dniowego okresu próbnego.
   Natomiast dla systemów docelowych konieczne jest wybranie pliku licencją, otrzymanego od producenta PlusWorkflow w ramach jego zakupu.

4.   Pokaże się wtedy potwierdzenie, gdzie kliknij 'OK'.
   
   
   
   
5. Pokaże się ponownie ekran logowania jak w pkt 2, gdzie ponownie podaj poprawny login i hasło administratora i wybierz przycisk 'Zaloguj'.
   
   
6. Po udanym logowaniu pokaże się poniższe okno i można rozpocząć pracę z PlusWorkflow.
   
   

Odinstalowanie.

Windows

Na systemie Windows można odinstalować system PlusWorkflow poprzez standardowe odinstalowanie programów Widndows np. w Windows 7 w 'Programy i funkcje' -> 'PlusWorkflow' -> 'Odinstaluj'.

Linux

System zainstalowany na systemie Linux usuwamy poprzez wywołanie skryptu uninstall znajdującego się w głównym katalogu wybranym w trakcie instalacji np. /home/plusworkflow/PlusWorkflow/uninstall. W trakcie usuwania systemu usunięte zostaną:

1. serwis skonfigurowany podczas instalacji,
2. katalog z systemem PlusWorkflow,
3. katalog domowy (opcjonalnie).