LogoLogo
API Documentation
Version 1.19.5 and Older
Version 1.19.5 and Older
  • DecisionRules Documentation
  • API
    • API Introduction
    • API Keys
      • Solver API Keys
      • Management API keys
      • BI API keys
    • Rule Solver API
    • Management API
      • Deprecated Endpoints
    • Console Logs API
    • Business Intelligence API
      • Deprecated Endpoints
    • Datacenters & Locations
      • Global Cloud
      • Regional Cloud
    • Apache Kafka Solver API
    • Endpoint Settings
    • Archive
      • Rule Flow Solver API (DEPRECATED)
  • Decision tables
    • Decision Tables Introduction
    • Table Designer
    • Input & Output JSON Model
      • Simple Editor
      • JSON Editor
      • Binding to Model
    • Supported Data Types
    • Operators and Functions
      • Basic operators
      • Date operators
      • Functions
        • Logical Functions
        • Math Functions
        • Date and Time Functions
        • Text Functions
        • Data Functions
        • Array Functions
        • Integration functions
        • Functions and JSON
    • Export & Import of Decision Tables
      • Export Decision Table
      • Import Decision Table
      • File Structure of JSON Format
      • Managing Decision Table in Excel/Google Sheets
      • Deprecated Formats: XLSX v.1 and CSV
    • Table Operations
      • Filter Values
      • Valid Values
      • Sorting
  • Decision Trees
    • Decision Trees Introduction
    • Decision Tree Designer
    • Export & Import Decision Trees
      • Export Decision Tree
      • Import Decision Tree
  • Scripting Rules
    • Scripting Rule Introduction
    • Custom functions in Scripting Rules
    • Calling external API within ScriptingRules
    • Use Rule Variables in Scripting Rules
    • Call Embedded Rules in Scripting Rules
    • Export & Import Scripting Rules
      • Export Scripting Rule
      • Import Scripting Rule
    • Tips
  • Rule Flow
    • Rule Flow Designer
    • Rule Flow Mapping
    • Rule States in Rule Flow
    • Warnings & Errors
    • Rule Flow Limits
    • Export & Import Rule Flows
      • Export Rule Flow
      • Import Rule Flow
  • Workflow
    • Workflow Introduction
    • Workflow Designer
    • Workflow Nodes Overview
    • Workflow Limits
  • Other
    • Rule Alias
    • Execution Strategy
    • Rule State
    • Rule Versioning
    • Favorite Rules
    • Rule Variables
    • Rule Comparison
      • Decision Table Comparison
      • Decision Tree Comparison
      • Scripting Rule Comparison
    • Rule Tags
    • Rule Dependencies
    • Test Bench
    • Single Sign-On (SSO)
    • Event timeline
    • Rule Lock
    • Rule Migration Strategies
    • Changes in Version 1.19.0 (10/2024)
  • Organizations
    • Introduction
      • Access to Organization
    • Structure
      • Organization Roles
      • Members
      • Teams
      • Spaces
      • Space Roles
      • Policies
      • Settings
  • Teamwork
    • Dashboard
    • Folders
    • Spaces
    • Manage Spaces
    • Share Rules Between Spaces
    • Users & Roles
    • Teamwork Indicator
  • SDK and Integrations
    • Languages / Frameworks
      • SQL Server
      • Oracle PL/SQL
      • PostgreSQL
      • JavaScript
      • Java Spring Example
      • PHP Library
      • Python Library
      • .NET Library
      • Google Tag Manager
    • Excel Add-in
  • Business Intelligence
    • Audit Logs
    • Create a Power BI Report
    • Connect Power BI to Business Intelligence API
    • Connecting from Power BI (deprecated)
    • Connect DecisionRules to Power BI Using Our Custom Connector
  • Billing
    • Invoices & Billing
    • Change Product Plan
    • Billing Information
    • Plan Limits Explained
  • Regional Cloud
    • Regional Cloud
    • Region Specific API URLs
  • On-Premise / Docker
    • Environment Variables
    • Redis Connection Modes
    • Setup Single Sign-On (SSO)
      • Set up Microsoft Entra ID SSO
      • Set up Google SSO
    • DecisionRules Application
      • Minimal Requirements
      • DecisionRules Server
      • DecisionRules Client
      • DecisionRules Business Intelligence
      • Networking Between Docker Containers
    • Docker Showcase App
      • Showcase
      • Showcase + Business Intelligence
    • AWS Setup
      • AWS ECS/Fargate
      • Cache - Amazon ElastiCache
    • Microsoft Azure Setup
      • Database - Azure CosmosDB
      • Cache - Azure Cache for Redis
      • Azure Container Apps
    • Azure Red Hat OpenShift
    • Google Kubernetes Engine (GKE)
    • Kubernetes Setup
      • Kubernetes Setup with Business Intelligence
    • Logging options
    • CD/CI Pipelines
      • Azure DevOps CICD Pipelines
      • Using Migration script (old way)
    • Offline License
  • Terms & Conditions
    • Terms and Conditions
    • Privacy Policy
    • Service Level Agreement
      • Community Support
      • Standard Cloud (SaaS)
      • Silver SLA
      • Gold SLA
      • Custom SLA
    • Sub-Processor List
  • Roadmap 🚲 🗺️
  • Release Notes
    • Public Cloud
    • On-Premise / Private Cloud
Powered by GitBook
On this page
  • Requirements
  • Deploy DecisionRules to Openshift Cluster
  • Deploy DecisionRules server
  • Deploy DecisionRules client
  • Modify DecisionRules server Deployment
  • Scaling
  • Resource limit
  • HorizontalPodAutoscaler
  • Info

Was this helpful?

  1. On-Premise / Docker

Azure Red Hat OpenShift

Was this helpful?

Requirements

  • OpenShift Cluster

Deploy DecisionRules to Openshift Cluster

  • Before setting up DecisionRules on Openshift it is important to set up the MongoDB database and Redis Cache. Without these requirements, DecisionRules won't start successfully.

  • For deploying Decision Rules you need to login into the OpenShift console.

  • After you are logged in, select developer perspective.

  • Go to Project and click on create a Project.

  • After the Project is created and selected go to +Add.

Deploy DecisionRules server

Choose Container images.

Image

  • Image name from the external registry: docker.io/decisionrules/server(:version)

Resources

  • Deployment

Advanced options

  • Target port: 8080

Health checks

Readiness probe

  • Type: HTTP GET

  • Path: /health-check

  • Port: 8080

  • Failure threshold: 3

  • Success threshold: 1

  • Initial delay: 30

  • Period: 30

  • Timeout: 5

Liveness probe

  • Type: HTTP GET

  • Path: /health-check

  • Port: 8080

  • Failure threshold: 3

  • Success threshold: 1

  • Initial delay: 30

  • Period: 30

  • Timeout: 5

Startup probe

  • Type: HTTP GET

  • Path: /health-check

  • Port: 8080

  • Failure threshold: 3

  • Success threshold: 1

  • Initial delay: 30

  • Period: 30

  • Timeout: 5

Deployment (Environmental variables)

  • LICENSE_KEY: Your license key

  • DB_TYPE: COSMOSDB (in case you’re using Cosmos DB otherwise do not use this environment variable)

Click on Create.

Deploy DecisionRules client

Choose Container images.

Image

  • Image name from the external registry: docker.io/decisionrules/client(:version)

Resources

  • Deployment

Advanced options

  • Target port: 8080

Deployment (Environmental variables)

  • API_URL: URL of created DecisionRules server deployment

  • NGINX_PORT: 8080

Click on Create.

Modify DecisionRules server Deployment

After DecisionRules server deployment and DecisionRules client deployment is deployed, it is necessary to modify DecisionRules server deployment for the best experience.

You need to add a CLIENT_URL environment variable. The value is the URL of created DecisionRules client deployment with #. For example: https://app.decisionrules.io/#

Scaling

Openshift supports horizontal cluster scaling using 2 metrics. Either by using the CPU or RAM usage of the containers. The following parameters need to be set for scaling to work properly.

  • Resource limit

  • HorizontalPodAutoscaler

Resource limit

CPU

Request: same as WORKERS_NUMBER environmental variable (cores)

Limit: same as WORKERS_NUMBER environmental variable (cores)

Memory

Request: WORKERS_NUMBER * 300 + 400 (Mi)

Limit: WORKERS_NUMBER * 300 + 1000 (Mi)

HorizontalPodAutoscaler

Name

Custom name of metrics.

Minimum Pods

It depends on the needs. The recommended value is a minimum of 2.

Maximum Pods

It depends on the needs and the expected maximum performance.

CPU Utilization

Value: 60%

Memory Utilization

Value: 0%

Info

The default value when the cluster checks if the pods exceed the set parameters is 15s.

The cluster will add more pods if needed until the maximum number of pods defined in HorizontalPodAutoscaler is filled.

When resources (pods) are no longer needed, they are automatically deleted according to usage up to the Minimum Pods value set in HorizontalPodAutoscaler. This ensures that unused pods are not running unnecessarily.

List of .

REDIS_URL: Redis Cache connection string ()

MONGO_DB_URI: MongoDB connection string ()

List of .

MongoDB database (or CosmosDB)
Redis cache
all environmental variables
more information here
more information here
all environmental variables