This folder contains various OpenShift templates for different deployment scenarios:
Template | Description |
---|---|
Onix with ephemeral storage | Deploys Onix and PostgreSQL with ephemeral storage. |
Onix with persistent storage | Deploys Onix and PostgreSQL with persistent storage. |
Onix with external database | Deploys Onix and connects it to an external PostgreSQL database. |
Onix Kubernetes Agent | Deploys the Kubernetes Agent for Onix. |
Onix Web Console | Deploys the Web Console only. |
Onix All Persistent | Deploys all onix services (i.e. the database, web api, web console and kubernetes agent.) |
NOTE: Onix will automatically deploy the SQL schemas when the readyness probe is called upon deployment of the Onix WAPI container.
The persistent template uses an OpenShift volume claim as durable storage for the database component.
The ephemeral template use an empty dir as storage for the database, which means all data is lost if the database container is restarted. Use only if you don't have any persistent storage at hand.
The external database template uses an external service to connect to an instance of PostgreSQL that is external to OpenShift.
The following steps use the oc command line tool to create a new empty project and deploy using the persistant template.
# first, create an empty project
$ oc new-project onix
# Deploy Onix using the persistent storage option
$ oc new-app https://raw.githubusercontent.com/gatblau/onix/master/docs/install/openshift/onix-all-persistent.yml
To import the templates in OpenShift, run the following command:
# log in as admin
oc login -u system:admin
# import the templates so they show in the catalogue
sh import.sh
Once the templates have been imported, they should be visible in the Web Console under the Catalogue section in OpenShift.
The table below list a few cloud providers running PostgreSQL database services that could be used as a backing database for Onix:
Provider | Service |
---|---|
AWS | Amazon RDS |
Azure | Azure Database for PostgreSQL |
Google Cloud | Cloud SQL for PostgreSQL |