How to install a Merge portal.

This document will cover the preparation steps needed for a Merge Portal install.

The process of installing a Merge portal happens in 3 phases

  • Installation of OpenShift or OKD
  • Preparing OpenShift or OKD for Merge installation
  • Installing merge

OpenShift vs OKD Considerations

The Merge portal runs on either OpenShift or OKD. You will need to install one of these onto the cluster of servers you plan to run a Merge portal on. These projects are related in the sense that OpenShift a commercially supported version of OKD. OKD is a distribution of Kubernetes. For teams that do not have experience running Kubernetes systems, leveraging OpenShift that comes with a support contract and extremely high quality end user documentation and support materials is highly recommended.

Both OpenShift and OKD have install documentation of their own

The Bare Metal Provisioning section of this document covers a streamlined way to install OKD using Merge provided tooling.

Bare Metal Provisioning

This section describes how to use the Ground Control tool to install OKD on a bare metal system.

Kubernetes Provisioning

Persistent Volumes

The Merge portal installer requires 5 persistent volumes to be created.

PurposeMinimum SizeRecommended SizeAccess Mode
Etcd data store2GB10GBRWO
MergeFS file system100GB1TB+RWX

Documentation for setting up persistent volumes on OKD and OpenShift can be found at the following links.

Merge Portal Installation

Last modified April 28, 2021: update link names (cb66524)