Part 3: Installation of the platform#

This part of the guide describes the process of setting up a server environment and simplified platform installation instructions.

Note

Please contact your Intel® Geti™ account representative or technical support personnel if you have any questions.

Note

Use the workstation where the Intel® Geti™ platform is installed and hosted solely for the Intel® Geti™ platform. Do not run any other software in parallel on that same machine. To learn more, go to the Best Practices page.

Installing the Intel® Geti™ platform#

The platform is installed on the machine where the installer is executed.

To start the installation, log in to your Ubuntu machine and make sure that all the hardware, software, network, and security prerequisites are met.

The first step is to download and extract the Intel® Geti™ installation package on your previously prepared server.

tar -xf <package>.tar.gz

Warning

Before extracting the package, ensure you do not have the previous platform_<VERSION> folder in the same location.

Go into the folder created by the previous command:

cd platform_<VERSION>

Now, you can choose between two modes of installation:

with wizard - where the installer asks a user for all data needed during the installation process
with configuration file - where a user must fill in all the data prior to running the installer

In the following, we will describe the two installation modes.

Installation with wizard#

To start installing the platform with wizard run the following command:

sudo ./platform_installer install

You will be asked to provide the password if you are not logged in as a passwordless sudo user.

When running in the wizard mode, the installer will prompt for the following data:

Admin username and password

The installer asks for the name of the administrator user that will be created on the platform.
```
Login name (e.g. admin@my-company.com) of the user to be created during the installation:
```
The installer verifies if the format of the entered value conforms to an email address. After that, it asks for the user’s password:
```
Password (8 - 200 characters, at least one capital letter, lower letter, digit or symbol):
Repeat for confirmation:
```
The installer verifies if the entered passwords are the same and if they comply with the security constraints.
Mail server configuration

The installer asks for all the details required to configure the mail server, which is used to send email invitations to newly added users. It is assumed that this server supports TLS. If the user decides not to enter mail server data, the platform will allow to create users but will not send invitation mails.
```
Do you want to configure mail server? (y/N)
```
If the answer is ‘y’ the installer asks one by one for:
```
SMTP address (example: smtp.your_server.com):
SMTP port (default: 587):
```
Then the installer asks for the authentication data that is to be passed when sending emails.
```
SMTP username:
SMTP password:
```
Finally, the installer asks for sender information.
```
Sender's email address: (example: admin@your_server.com):
Sender's name: (example: Platform Admin):
```
The installer verifies if the provided configuration is correct by trying to connect to the given SMTP server. If it fails, it displays the appropriate message and asks for the mail server details again.
Custom SSL certificate
```
Do you want to configure your custom SSL certificate? (y/N)
```
If the answer is ‘y’ the installer asks one by one for:
```
Path to the certificate file:
Path to the key file:
```
Only full chain certificates are supported. Key files cannot be encrypted.

The installer verifies if the provided paths point to an existing file. If not, it displays an appropriate message and asks for the path again.
Datasets location

The installer asks for the path to a data storage folder
```
Path to the data storage (e.g. /datasets):
```
Ensure that the entire directory path, starting from the root to the location, which you you plan to use for the data storage, does not contain spaces in any of its folders’ names.

The installer verifies if the provided path points to an existing folder with proper permissions and if this folder is empty. If not, it displays an appropriate message and asks for the path again.
Grafana stack configuration

Grafana is a data visualization and monitoring tool. Based on collected platform logs and metrics, it helps to better understand in-app user behaviour and understand platforms usage thanks to customizable dashboards.
```
Do you want to install the Grafana stack (not recommended on setups meeting only the minimum HW requirements)? [y/N]
```
If the answer is ‘y’, the Grafana stack will be installed on the platform. If the answer is ‘N’, the Grafana stack will not be installed on the platform.
Final confirmation

The installer displays the data it gathered and asks for confirmation. If it is given, it starts the installation process. If not, the installation is aborted.
The installer creates all the configuration files based on the user’s input and starts the installation process.
Watch for warnings or error messages displayed during the process and act accordingly.

Installation with configuration file#

If the –config-file parameter is provided the installation package starts the installation without the user interaction.

The configuration file is a yaml file with all configuration data specified in advance. The template for the file has the following initial content:

# Name of the first user that will be created on the platform
# (email format, e.g. admin@my-company.com)
user_login:
# Password for the user specified by user_login
# (8 - 200 characters, at least one capital letter, lower letter, digit or symbol):
user_password:

# Mail server configuration
# If smtp_address is empty or the entry is missing the remaining mail server entries will be ignored
# and the mail server will not be configured
# Example entries:
# smtp_address: smtp.your_server.com
# smtp_port: 587
# smtp_username: admin@your_server.com
# smtp_password: ******
# sender_address: admin@your_server.com
# sender_name: Platform Admin
smtp_address:
smtp_port:
smtp_username:
smtp_password:
sender_address:
sender_name:

# Specifies whether the Grafana stack will be installed on the platform.
# Not recommended on setups meeting only the minimum HW requirements.
# Allowed values: true or false
# If set to true, the Grafana stack will be installed on the platform.
# If set to false or when value or entry is missing, the Grafana stack will not be installed on the platform.
grafana_enabled:

# Path to the custom SSL certificate file
# If empty or entry missing the custom SSL certificate will not be configured
cert_file:
# Full path to the custom private key file
# Ignored if cert_file empty or missing
key_file:

# Path to the data folder, empty prior to running the installation (e.g. /data)
# Ensure that the entire directory path, starting from the root to the location, which you you plan to use for
# the data storage, does not contain spaces in any of its folders' names.
data_folder:

Sample file the installation:

user_login: admin@my-company.com
user_password: fancy-password
data_folder: /data
cert_file: /home/my-user/domain.crt
key_file: /home/my-user/domain.rsa