Skip to content

Server Configuration

Jump to bottom
Joseph Nobes edited this page Jan 7, 2025 · 9 revisions

Operating and Configuring a Live odin-control Server on LOKI systems

Table of Contents:

Background

LOKI-based control systems provide their control interface using an instance of odin-control, a modular framework for control system development. This instance is brought up with an application-specific adapter, which will be developed as part of system integration with hardware. This guide assumes that the adapter has already been developed- odin-control adapter development is out of scope. See LOKI-based Adapter Creation.

By default, this adapter will run automatically on boot, and present a web interface on port 8888. The HTTP REST API can be accessed via the same port.

Warning

A LOKI unit must be connected to an isolated network; it is not a hardened device. You have been warned.

LOKI Device IP

By default, a LOKI unit is configured for a DHCP-obtained address. This means that either it must be plugged into a DHCP-enabled network shared with the machine intended to access the interface, or the controlling machine must provide DHCP in the case of a direct connection.

Alternatively, the unit can be configured with a static IP address.

Setting up a static IP address

Log into the LOKI unit, and as root (use su -):

# loki_set_static_ip <ip address>

Starting and Stopping the odin-control Service

The PetaLinux image produced for LOKI uses System V scripts to control services. Currently, it is only possible to control the service while logged in to the device over SSH or UART.

There are helper aliases to stop and restart the server (as root; use su -):

# loki_stop_app
# loki_restart_app

Alternatively, use the init script to start, stop, and restart the odin-control server directly (as root):

# /etc/init.d/loki-config.sh start
# /etc/init.d/loki-config.sh stop
# /etc/init.d/loki-config.sh restart

Accessing odin-control Logs

By default, the instance will output logs to /var/log/loki/detector.log. This file can be read by the loki user, and is accessible from a logged in terminal only (unless redirected to a network mounted location).

Control Host Configuration

What is a Control Host?

The LOKI system is able to function independently as a controller, with minimal reliance on an external machine to simply access the web interface for whatever detector is being controlled.

Warning

Once again: A LOKI unit must be connected to an isolated network; it is not a hardened device. You have been warned.

For mimimal operation (web interface access), requirements are:

  • A DHCP server on the connected network, or configured static IP
  • A machine on the same network with a web browser installed

For more advanced operation that allows for non-standard configuration, as well as the abilty to write files to network mounts on the host machine as well as edit sequences for odin-sequencer, we can connect a standardised control host.

Note

While the system is under active development, it is typical that any controlling machine should be a standardised control host, as we are almost always going to want to live-edit odin-sequencer sequence files at the very least. This may change in the future when sequences become more standardised, and we can rely on baked-in control.

Requirements of a Standardised Control Host:

  • DHCP server on isolated interface, which allows the LOKI unit to be plugged in directly
  • An exported NFS mount at /opt/export/loki, which will be writable by LOKI devices

Control Host Network Mount Layout

#TODO

Unique System Identifiers

#TODO

Binding Known Directories

#TODO

Using the System Identifier in Paths

#TODO

Overriding the odin-control config file

#TODO

Overriding the LOKI startup config file

#TODO

Remounting the Host Mountpoint

System V scripts are relatively primitive, and do not have dependencies. Therefore , you should stop the control service while you restart this one.

# loki_stop_app
# /etc/init.d/loki-connect-control-host.sh restart
# loki_restart_app

#TODO

  • Background; this is more aimed at general use
  • Unique system identifiers
  • Starting and stopping the odin-control server
  • Link to 'process for creating odin-control instance' wiki article
  • Control Host intention and functionality
  • odin-control hosted configuration file
  • Link to 'creating live virtual environments'

Clone this wiki locally