buerokratt / installation-guides

About

This document covers installation guides for all of Bürokratt's services.

Intended target

The intended target of this document is an IT-personnel familiar with Ubuntu, Linux command line, Git and Docker.

Limitations of this document

This document covers the installation of Bürokratt on Ubuntu and by using Linux Terminal.

Glossary

Bykstack - core components of Bürokratt that are essential for services to work

Backoffice GUI - graphical user interface as an administrative tool

Chat Widget - graphical user interface for End Users to chat via text messages

Bot - automated chatbot, responds to End Users without human interference

Training-bot - the same as Bot but is used only for training purposes

Terminal - Linux command line tool

Prerequisites

Approximate resource requirements

Check the requirements here

Docker and docker-compose installation: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04 https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04

Docker must be installed

At least version 1.29.2

docker -v

Docker version 1.29.2 build 5becea4c

Docker Compose must be installed

At least version 2.6.1

docker-compose -v

Docker Compose version v2.6.1

Ports

Make sure, that following ports are allowed

• 8081 Dmapper
• 3000 Chat-widget
• 3001 Customer-service
• 8082 Resql
• 8085 TIM
• 8443 Private ruuter
• 8080 Public ruuter

Installation

Prerequisites

• Create a directory on you personal computer or virtual server where to download Bürokratt's source code
• Move to this directory
• While being in this directory, open Terminal
• Clone the source code of Bürokratt
• Databases installation instructions are here
• Configuration instructions are here

git clone https://github.com/buerokratt/Installation-Guides.git

• Move to a directory called Installation-Guides

cd Installation-Guides

• Make sure there is a folder called default-setup

ls | grep default-setup

default-setup

Setting up Bykstack and Backoffice GUI

Continue in folder Installation-GUides by using Terminal

• Move to folder default-setup

cd default-setup

• Make sure there is a folder called backoffice-and-bykstack

ls | grep backoffice-and-bykstack

backoffice-and-bykstack

• Move to folder backoffice-and-bykstack

cd backoffice-and-bykstack

• Use Docker Compose to set everything up

sudo docker-compose up -d

• Check if appropriate Docker containers were created

sudo docker ps -a | grep byk-

345045515b2c   riaee/byk-tim:07                      "catalina.sh run"        Up 2 minutes                     8080/tcp, 0.0.0.0:8085->8443/tcp, :::8085->8443/tcp                                     byk-tim
06d0a1e5db93   riaee/byk-chatbot-public-ruuter:03    "catalina.sh run"        Up 2 minutes                     8080/tcp, 0.0.0.0:8080->8443/tcp, :::8080->8443/tcp                                     byk-public-ruuter
4d456da8f574   riaee/byk-dmapper:10                  "catalina.sh run"        Up 2 minutes                     8080/tcp, 0.0.0.0:8081->8443/tcp, :::8081->8443/tcp                                     byk-dmapper
a44d482ae918   riaee/byk-customer-service:17         "/docker-entrypoint.…"   Up 2 minutes                     80/tcp, 0.0.0.0:3001->443/tcp, :::3001->443/tcp                                         byk-customer-service
e1272ee93df0   riaee/byk-chatbot-private-ruuter:03   "catalina.sh run"        Up 2 minutes                     8080/tcp, 0.0.0.0:8443->8443/tcp, :::8443->8443/tcp                                     byk-private-ruuter
d9a02b7de5f4   riaee/byk-chat-widget:14              "/docker-entrypoint.…"   Up 2 minutes                     80/tcp, 0.0.0.0:3000->443/tcp, :::3000->443/tcp                                         byk-widget
1388f20c5613   riaee/byk-resql:11                    "catalina.sh run"        Up 2 minutes                     8080/tcp, 0.0.0.0:8082->8443/tcp, :::8082->8443/tcp                                     byk-resql
bc0dd35d3451   riaee/byk:monitoring-20220802         "/docker-entrypoint.…"   Up 2 minutes                     443/tcp, 0.0.0.0:81->80/tcp, :::81->80/tcp, 0.0.0.0:8444->8443/tcp, :::8444->8443/tcp   byk-monitor

• Open Backoffice GUI in browser Open https://localhost:3001/ in your browser of choice. You should see Bürokratt's Backoffice GUI.

installation-guides's Issues

Installation Guide repo refacto

AS A DevOps
I WANT TO follow a comprehensive step-by-step guide to install the Bürokratt chat
SO THAT I wouldn't have to debug and install it based on trial and error myself

Acceptance Criteria

README.md gives an overview of

• what Bürokratt chat is about
• what Bürokratt chat does functionally
• all the links to necessary additional information

The installation guide gives a comprehensive step-by-step overview of how to install Bürokratt chatt

• on virtual servers as Docker services
• on Kubernetes environment

Tags

• Current stage of main branch is tagged as 0.2.999
• New version of main branch is tagged as 1.0.0

Feature branches

• All feature branches are removed

Installation guide to start using Bürokratt's chat-related services on Docker

AS A Technical Interested Party
I WANT TO run Bürokratt's chat-related services on Docker containers
SO THAT I could just test or take them into actual use as easily as possible

Acceptance Criteria

General requirements

• Documentation covering all necessary (additional) steps, orders of execution, etc is up-to-date, and following it step-by-step results in setting up given services
• Written description about how to test if the technical setup was successful. When using docker-compose up -d (see below), installation is considered technically successful if all Docker containers are up and running and accessible as standalone components, but also if necessary and graphical user interfaces are accessible via browser
• Written description about how to test if the setup was successful in a sense of using installed components as fully functional services

Configuration parameters

• Configuration parameters in public repositories may not contain any sensitive information
• One comprehensive configuration (the so-called master-conf) file containing all of the variables used during the following installation steps
• When setting up different services, appropriate configuration values are automatically applied from the so-called master conf

Plain chat services

• Technical components are installed simply by cloning the repo and running docker-compose up -d

Rasa-based services

• Technical components are installed simply by cloning the repo and running docker-compose up -d

Analytics

• Technical components are installed simply by cloning the repo and running docker-compose up -d

Tutorial for requesting and granting access by SSH keys

AS A Developer
I WANT TO get access to remote infrastructure by providing my public SSH key
SO THAT I wouldn't have to use my username and password for it

AS A Service Manager
I WANT TO grant access to virtual machines under my control via SSH keys
SO THAT I wouldn't have to create an account with a username and password for it

Acceptance Criteria

• Step-by-step tutorial about creating and storing public and private SSH keys by Developer (may be a copy/paste from a tutorial with a link to original source);
• Step-by-step tutorial about adding the Developer's public key by a Service Manager (may be a copy/paste from a tutorial with a link to original source);
• By following provided tutorials, remote access is granted by a Service Manager to a Developer in Bürokratt's https://riigipilv.ee/ environment.