On-Premises Private

Installing CARTO On-Premises LDS

Installation

The CARTO LDS installer artifact can be used to setup CARTO LDS in the following scenarios:

• a fresh installed Red Hat server
• a previous compatible running version (CARTO LDS). An upgrade will be performed in this case.

1) Unpack the tar.gz file of the Builder installer

1
tar xfz carto-dataservices-<version>-rhel-7-x86_64.tar.gz

Where version is the version of the file provided.

2) Initialize the configuration database and install the license

1
2
cd carto-dataservices-<version>-rhel-7-x86_64
sudo ./cartoctl init --license license1.lic

3) Add Dataservices role configuration to ~/carto/config.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
nodes:
- hostname: node01-lds.carto.lan
  user:
    privileges: true
    ssh_key: id_rsa
    command: /bin/sudo
  role:
  - name: dataservices
    release: ""
    installed: false
    env:
    - name: CARTO_DATASERVICES_ADDRESS
      value: 4.4.4.4
    - name: CARTO_DATASERVICES_BIND
      value: 0.0.0.0
    - name: CARTO_REDIS_ADDRESS
      value: 5.5.5.5
    package: []
    task: []

4) Perform the installation with sudo (or as root):

1
sudo ./cartoctl nodes install

5) If the installation was successful, you will see the message below, otherwise please check ~/carto.log looking for errors.

1
2
3
4
5
6
7
8
9
10
11
12
Starting installation...
 Starting install process on node node01.carto.lan
 Roles configured on this node: [dataservices]
 Installing role dataservices on node01.carto.lan

   <--- Snipping content here --->

   Reloading templates ✔
   Enabling service dataservices ✔
   Starting service dataservices ✔
Successfully installed dataservices
The installation has been successfully completed

6) Go to Builder server and add the config block below to ~/.carto/config.yml, under nodes section:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
- hostname: node01.carto.lan
  user:
    privileges: true
    ssh_key: id_rsa
    command: /bin/sudo
  role:
  - name: dataservices
    release: ""
    installed: false
    env:
    - name: CARTO_DATASERVICES_ADDRESS
      value: 4.4.4.4
    - name: CARTO_DATASERVICES_PORT
      value: "5433"
    - name: CARTO_DS_ANALYSIS_GEOCODER
      value: "false"
    - name: CARTO_DS_ANALYSIS_HIRES
      value: "false"
    - name: CARTO_DS_ANALYSIS_ISOLINES
      value: "false"
    - name: CARTO_DS_ANALYSIS_ROUTING
      value: "false"
    - name: CARTO_DS_ANALYSIS_DOBSERVATORY
      value: "false"

7) Continue with LDS Configuration in Builder server lds_configuration

Pre-Configuration

CARTO LDS has some default parameters that will help run all of the components correctly. However, it is recommended to review these parameters and change them before running the installer. Some of the initial configurations cannot be modified once the product is installed.

The following is the default config for DATASERVICES (LDS). See lds_keys_reference for a complete reference.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
nodes:
- hostname: node01-lds.carto.lan
  user:
    privileges: true
    ssh_key: id_rsa
    command: /bin/sudo
  role:
  - name: dataservices
    release: ""
    installed: false
    env:
    - name: CARTO_DATASERVICES_ADDRESS
      value: 4.4.4.4
    - name: CARTO_DATASERVICES_BIND
      value: 0.0.0.0
    - name: CARTO_REDIS_ADDRESS
      value: 5.5.5.5
    package: []
    task: []

Installation Configuration Option Keys Reference

CARTO LDS is highly configurable on installation time. The different sections of the documentation mention many option keys that modify the behavior of the product. The following table contains a reference of the keys that can be found in ~/.carto/config.yml setup file and whether they are modifiable or not.