Ai-OPs
ai-ops.com

Documentation

Learn how to install, configure, and operate the Koios platform.

Getting Started

Getting Started

High-level overview of the Koios platform: data collection, AI inference, custom components, and trends

Installation

Installation Overview

The full path from a bare machine to a running, licensed Koios server

System Requirements

Hardware and software prerequisites for running Koios

Choosing a Host

Run Koios on a virtual machine or a physical computer, and what differs between them

Creating the Virtual Machine

Create and configure a Hyper-V virtual machine for Koios, from enabling the role to first boot

Installing Ubuntu

Install Ubuntu Server screen by screen, including its permanent address and remote access

Network Configuration

Confirm the machine's permanent address, change it later, and open the ports Koios serves on

Time Synchronization

Keep the host clock synchronized with NTP for accurate, comparable timestamps

Installing Docker Engine

Install Docker Engine on Ubuntu, the runtime Koios ships as

Getting the Koios Image

Download the Koios image from the registry, or install from an offline archive

Running Koios as a Service

Configure Koios to run as a systemd service

Licensing Koios

Activate and manage your Koios license

Installing Without Internet Access

Two ways to stand Koios up on a machine that cannot reach the internet, and which one to prefer

If the Install Goes Wrong

Symptoms, causes and fixes for the problems that come up while installing Koios

Environment Variables

Configure network, performance, logging, authentication, and reverse proxy settings

Manually Starting Koios

Start Koios manually via Docker commands

Running Multiple Instances

Run several Koios containers on one host with explicit port mapping

Backing Up Docker Volumes

Back up and restore Koios Docker volumes

Protocols

Protocols

Overview of supported communication protocols

OPC-UA Certificates

Managing OPC-UA security certificates

Devices

Device Introduction

Overview of device connections in Koios

The Device List

Read, search, filter, sort and act on the Devices table, including bulk actions and live status filtering

Creating a Device

General steps for creating a new device

Creating an OPC-UA Device

Configure a connection to an OPC-UA server

Creating a Modbus TCP Device

Configure a connection to a Modbus TCP device

Creating an EtherNet/IP Device

Configure a connection to an EtherNet/IP Logix controller or Generic CIP device

Creating a Microsoft SQL Device

Configure a connection to a Microsoft SQL database

Creating a REST Device

Configure a connection to a CAREL BOSS device over REST

Creating a SOAP Device

Configure a connection to a SOAP web service

Importing & Exporting Devices

Bulk import devices from CSV and export device data

On-Demand Scanning

Configure device-side on-demand read and write settings for AI model synchronization

Device Parameters

Protocol-specific device configuration parameters

Troubleshooting a Device

How to diagnose and resolve device errors

Device Sets

Group devices for redundancy and automatic failover with a priority-ordered set

Tags

Tag Introduction

Overview of tags and data points in Koios

Creating a Tag

General steps for creating a new tag

Creating an OPC-UA Tag

Configure an OPC-UA node as a tag

Creating a Modbus TCP Tag

Configure a Modbus register as a tag

Creating an EtherNet/IP Tag

Configure tags for Logix controllers and Generic CIP devices

Creating a Microsoft SQL Tag

Configure a SQL column as a tag

Creating a REST Tag

Configure a BOSS variable as a tag

Creating a SOAP Tag

Configure a SOAP field as a tag

Expression Tags

Create calculated tags using mathematical expressions, tag references, and built-in functions

Importing & Exporting Tags

Bulk import tags from CSV and export tag data

Value Mapping

Map raw device values to numeric outputs using ordered match rules

Troubleshooting a Tag

How to diagnose and resolve tag errors

Trends

Trends

Overview of trends: multi-tag time-series charts for visualizing historical and live data

Traces & Axes

Add tags, configure multiple Y-axes, and customize trace colors

Settings & Export

Configure sampling, display options, and export historical tag data

Dashboard

Dashboard

Create customizable dashboards with live widgets for monitoring tags, devices, and AI models

Models

Model Introduction

Overview of AI models in Koios

Training a Model

Understand where model training fits in the Koios workflow and what you need before deploying

Model Inference Requirements

Requirements for running model inference

Structured Input Spaces

Give each model input its own window length, sample rate, and interpolation instead of one model-wide history window

Creating a Model

Create a new AI model in Koios

Managing Model Files

Upload and manage ONNX and TFLite model files

Assigning Bindings

Bind model inputs and outputs to tags

Configuring a Model

Detailed guide to all model configuration settings

On-Demand Inference

Synchronize model inference with fresh device data using on-demand reads and writes

Scan Groups

Group models for synchronized execution with shared on-demand reads and writes

Importing & Exporting Models

Bulk import and export AI model and binding configurations as CSV

Monitoring a Model

View live inference values, binding diagnostics, execution performance, and historical trends

Troubleshooting a Model

How to diagnose and resolve model and binding errors

Model Configuration Errors

Why a model whose configuration would assemble the wrong input is left Stopped instead of Failed, what each reason means, and how the error clears

Components

Components

Overview of the component system: libraries, environments, instances, and wiring

Component Libraries

Upload, activate, version, and manage component library packages

Component Environments

Create and configure execution environments for component instances

Organizing Environments

Group component environments into a drag-and-drop folder tree in the workspace rail

Stacks

Isolated package sets that let components use library versions the platform does not ship

Component Canvas

Add component instances, wire inputs and outputs, and monitor live execution

Building Components

Overview of developing custom components with the Koios Component Builder

Explorer

Explorer

Organize devices, tags, models, and more into a browsable folder hierarchy

Events

Events

Browse the platform operational activity feed: acknowledge, mute, and group events

System

System Overview

View platform version, server health, system information, and server time

License

View license status, details, and re-activate when needed

Users

Create and manage user accounts, assign roles, and control access

Roles & Permissions

Create roles, assign permissions, and control what users can do

Audit Log

Review the tamper-evident record of who changed what, when, and from where

API Clients

Manage API client credentials for external system integrations

Backup & Restore

Create, schedule, and restore system backups

Data Retention

Configure storage monitoring, history compression, and automatic cleanup policies

System Health

Monitor CPU, memory, and disk usage with configurable alarms

Network

Scan and discover hosts on your plant network, view interface details, and run diagnostic tools

Certificates

Install a CA-signed certificate for the Koios web interface and manage the client certificates Koios presents to OPC-UA servers

Services

Monitor platform service status and control service lifecycle

Logs

Stream real-time service logs and browse archived log files

Troubleshoot

Troubleshooting Koios

Start here when something is broken: find your symptom and jump to the right guide

Reading Status, Quality & Errors

Understand entity status, data quality, the three error fields, and look up any error code

Troubleshoot a Connection

Fix a device that won't connect and the tags that fail with it

Bad, Missing, or Frozen Tag Values

The device is running but a tag reads bad quality, no value, or the wrong value

Expression & Value-Mapping Errors

Diagnose expression evaluation and value-mapping failures on a tag

A Model or Binding Isn't Running

Work down from a failed model through its bindings to the tags and devices feeding it

Data Is Stale, Frozen, or Has Gaps

Live values look frozen, trends are flat or gappy, or history isn't recording

Service Health & Resource Alarms

Diagnose unhealthy services, heartbeats, and CPU, memory, disk, and network alarms

Licensing Problems

Resolve missing, invalid, or expired licenses and understand what Unlicensed disables

Server Won't Start

Diagnose a server stuck on the Starting up screen, read container logs, and recover from a failed startup

Collecting Diagnostics for Support

Gather the right logs and details before opening a support case