Deployer

NOTE

This article introduces the minimum procedure of using Ultipa Deployer to deploy Ultipa HTAP cluster. For deployment without Ultipa Deployer please refer to Deployment Procedure.

Hardware Requirement

• Minimum 3 nodes
• Network connection between nodes, it is suggested that all nodes in one cluster are arranged on the same network segment
• All nodes can be accessed by client (application backend, or Ultipa Manager)
• CPU & Memory depends on the project or testing requirements

Software Requirement

• There is ssh permission between current server and target server
• When target server connects user remotely through ssh, it must have the write permission on WORK_PATH directory in the configuration file
• Docker CE 19+ or equivalent Docker EE installed on target server
• There is ultipaServer image package on current server
• There is ultipaServer license on current server

Deployment Procedure

1. Generate configuration file template

Bash
./ultipa-deploy -g 

1. Modify configuration file according to the instruction in the file

Bash
mv example_config.yaml config.yaml 

vim config.yaml 

1. Upload offline docker image described in LOCAL_IMAGE_TAR to all target servers, and execute docker load

Bash
./ultipa-deploy -c config.yaml -o loadtar 

1. Check the environment beforehand to see if it meets the deployment requirement

Bash
./ultipa-deploy -c config.yaml -o check 

1. Start deployment

Bash
./ultipa-deploy -c config.yaml -o deploy 

1. Check deployment status

Bash
./ultipa-deploy -c config.yaml -o list 

1. Stop the cluster as described in the configuration file when needed

Bash
./ultipa-deploy -c config.yaml -o stop 

1. Start the cluster as described in the configuration file when needed

Bash
./ultipa-deploy -c config.yaml -o start 

License Update

1. Upload server license described by LOCAL_LICENSE to path LICENSE_ON_REMOTE_SERVER in the target server, the old license will be renamed for back up

Bash
./ultipa-deploy -c config.yaml -o uplic 

1. Restart server license in the path LICENSE_ON_REMOTE_SERVER

Bash
./ultipa-deploy -c config.yaml -o relic 

1. In Ultipa Manager, login the cluster that just had license replaced, click the menu Graph and check the expire time of the license under Database Info

Startup Options

Configuration File

YAML
# The local path to store license, used by '-o uplic'

LOCAL_LICENSE: 

# Path of target server to store license, '-o uplic' uploads local license to this location, '-o deploy' copies this license to docker 

LICENSE_ON_REMOTE_SERVER: "/home/ultipa/license/ultipa.lic" 

# Whether to upload this yaml configuration file to the WORK_PATH directory on server, any old version yaml configuration file will be renamed 

SAVE_THIS_CONFIG_TO_REMOTE_SERVER: true 

# Full description of the docker image to be deployed 

IMAGE_TAG: localhost:beta.4.0.118-b4.0.0

# Offline docker image saved locally. When target server cannot connect to docker image repository, '-o loadtar' can upload this offline image to server and execute 'docker load' 

LOCAL_IMAGE_TAR: beta.4.0.118-b4.0.0.tar.gz 

#LOCAL_IMAGE_TAR: /data1/abc/a.tar.gz 

# Only 4.x ultipa-server is supported 

ULTIPA_SERVER_VERSION: 4 

 

# Variables that begin with G_ are global variables. Global variable will be used if the specific server variable is empty 

# Public port of ultipa-server  

G_PUBLIC_PORT: 61510 

# HTAP port of ultipa-server 

G_PRIVATE_PORT: 61511 

# Name of docker container 

G_SERVER_NAME: ultipa-61510 

# Map directory of ultipa-server 

G_WORK_PATH: "/data1/docker_mounts/ultipa-61510" 

# ssh remote connection user of target server, this user must have write permission on WORK_PATH directory 

G_SSH_USER: root 

# Port for ssh remote connection 

G_SSH_PORT: 22 

# ssh remote connection verified by password 

G_SSH_PASSWORD: 

# ssh remote connection verified by key 

G_SSH_PRIVATE_KEY_PATH: id_rsa 

# This can be left empty  

G_CONFLINE: 

 

# FULL_HOST_LIST is an array, the example gives description of only one target server, copy and modify for multiple target servers   

FULL_HOST_LIST: 

  - PRIVATE_IP: 192.168.56.101	# Private IP of target server  

    SERVER_ID:					# SERVER_ID will be sequentially filled if left empty 

    SERVER_ROLE: 1				# Must be filled, refer to the attached table for role definition

    SSH_USER:					# Use G_SSH_USER if it is empty 

    SSH_PORT:					# Use G_SSH_PORT if it is empty 

    SSH_IP:						# Use PUBLIC_IP if it is empty 

    SSH_PASSWORD:				# Use G_SSH_PASSWORD if it is empty 

    SSH_PRIVATE_KEY_PATH: 		# Use G_SSH_PRIVATE_KEY_PATH if it is empty 

    HOST_LISTEN_IP: 			# IP for ultipa-server to provide service externally, by default is 0.0.0.0 

    PUBLIC_IP:					# Use PRIVATE_IP if it is empty 

    PUBLIC_PORT:				# Use G_PUBLIC_PORT if it is empty 

    PRIVATE_PORT:				# Use G_PRIVATE_PORT if it is empty 

    SERVER_NAME:				# Use G_SERVER_NAME if it is empty 

    WORK_PATH:					# Use G_WORK_PATH if it is empty 

    CONFLINE:					# This can be left empty