OpenShift

Installing NEOGAGE on OpenShift is done by utilising our Helm Chart. The deployment files can be obtained by contacting your Account Manager.

Create New Project

First we need to create the project/namespace for use for the NEOGAGE application:

oc new-project neogage

if an alternative project name will be used, then the name of the project/namespace needs to be updated in subsequent commands below.

Secrets

Image Pull Secret

A login and token is required to login to the NEOGAGE application container registry to be able to download our images. Obtain a login and token from your Account Manager, and ensure that the secret that is created with this information is named image-registry-secret. Alternatively if using a different secret name, change this value in the helm charts prior to deployment by updating the value as shown below:

imagePullSecrets:
  name: image-registry-secret

replace image-registry-secret with the name of the secret you created.

Deploy

There are two helm charts for deploying the NEOGAGE application. The first is the MSSQL Server helm chart, and the second being the NEOGAGE application. If you are utilising an external MSSQL Server, then you do not need to deploy the MSSQL Server helm chart and can skip this.

MSSQL Server

The first thing to do before deploying the MSSQL Server container, is to review the `values.yaml file and configure appropriate settings.

image:
  repository: registry.upware.pl/mssql/server
  pullPolicy: IfNotPresent
  tag: "2022"

imagePullSecrets:
  name: image-registry-secret

pvc:
  data:
    name: mssql-server
    accessMode: ReadWriteOnce
    storage: 10Gi
    volumeMode: Filesystem

volumes:
  - name: mssql-server
    persistentVolumeClaim:
      claimName: mssql-server

volumeMounts:
  - name: mssql-server
    mountPath: "/var/opt/mssql"

# Set to your requirements for deploying MSSQL Server
secrets:
  accept_eula: "Y"
  mssql_pid: "Express"
  sa_password: "MySecretPassword123!"

We recommend utilising Microsoft SQL Server 2022, however it's possible to change this and utilise 2019 if you wish by updating the tag value. The only other options that need to be configured is the version of MSSQL - in the example above it's configured to deploy MSSQL Express. Also, set the SA user password.

Once all the above has been configured correctly, the helm chart can be ran to install as follows:

helm install mssql-server . -n neogage

It will be required to wait a few minutes for the MSSQL Server container to start and configure itself for access.

NEOGAGE Application

First we must review the values.yaml file and ensure it's configured appropriately.

clusterName: os.upware.pl

replicaCount: 1
strategy: Recreate

image:
  repository: registry.upware.pl/neogage/neogage
  pullPolicy: IfNotPresent
  tag: "3.7.0"

imagePullSecrets:
  name: image-registry-secret

pvc:
  data:
    name: neogage-data
    accessMode: ReadWriteOnce
    storage: 10Gi
    volumeMode: Filesystem

volumes:
  - name: neogage-data
    persistentVolumeClaim:
      claimName: neogage-data
  - name: neogage-secrets
    secret:
      secretName: neogage-secrets

volumeMounts:
  - name: neogage-data
    mountPath: "/var/www/neogage/data"
  - name: neogage-secrets
    mountPath: "/etc/neogage"
    readOnly: true

# Set to your requirements from when MSSQL Server was deployed
secrets:
  sql_db_app: neogage_master
  sql_db_data: neogage_data
  sql_instance: ""
  sql_password: MySecretPassword123!
  sql_port: 1433
  sql_server: mssql-server
  sql_user: sa

The first item to be configured is the clusterName value since this corresponds to our OpenShift cluster and it's utilised to ensure the routes are configured correctly to allow access to the NEOGAGE application. Another option that can be configured is the NEOGAGE version by changing the tag accordingly. Ensure the imagePullSecret is configured for what was initially created. If this was changed from our default, then update accordingly. The only other remaining values that need to be updated are in relation to the SQL databases and passwords. Ensure that all these values are valid.

Once it has been configured appropriately, NEOGAGE can then be installed:

helm install neogage . -n neogage

It will be required to wait a few minutes for the NEOGAGE application container to start and configure itself for access. The only steps now needed are to create the admin user and apply the license to the installation, as follows:

oc exec <container> -- update-license.py <license>
oc exec <container> -- create-admin-user.sh

alternatively the same thing can be achieved by connecting remotely to the container either via the OpenShift web interface and terminal for the pod, or by using oc rsh from the command line as follows:

oc rsh <container>
update-license.py <license>
create-admin-user.sh

It will be required to change the admin user password on initial login.