OpenShift Setup

This guide will walk you through setting up a small Germain UX environment, suitable for testing purposes. Please note that this configuration is not recommended for production environments.

💻 Hardware Requirements for the OpenShift Cluster:

Requirement

Details

CPU

CPU with at least 2 cores

RAM

4 GB of RAM

Disk space

20 GB of disk space

Minimum Node Group Size

8 Minimum Node Group Size

Maximum Node Group Size

16 Maximum Node Group Size

Desired Node Group Size

8 Desired Node Group Size

Node Volume Type

GP3 Node Volume Type

Note: The cluster size mentioned here is based on the availability of our lab environments and serves as a sample use case. Feel free to adjust your cluster size based on the availability of memory and CPU per node.

📦 Software Requirements

OpenShift

⬇️ Installation

Step

Details

Download package

Download and extract the Germain UX package

License

Deploy your license key

Configure cluster settings

Configure cluster settings in deploy-germain.sh file as per requirement. Recommended settings for a small cluster is as below.

External DB (optional)

If you are planning to use an external database for config store, you need to modify the below two parameters and set the mysqlReplicase to 0. (optional)

Make sure you update the common.properties file with proper DB details for config store

Email settings (optional)

Update email settings (optional)
Update the email settings in the included common.properties file to match your SMTP server:

kubectl config

Make sure your kubectl command is configured to run kubernetes commands.

Start deployments

Start your cluster deployments running deploy-germain.sh
Note: This will create the kubernetes yaml files inside your germainEnvName folder and you can re-use them in any of your kubernetes clusters with kubecl apply commands. Make sure you apply them in below order.

Access workspace

At the end of your command output, you will get the url to connect to the Germain UX Workspace.
By default, the workspace can be accessed on port 8080 using the default credentials (admin / admin):
ex: http://<your final url>:8080/germainapm/workspace/

image-20230614-183943.png


Component Internal: Germain Enterprise