ibek

IOC builder for EPICS and Kubernetes

ibek is the epics-containers IOC builder. It declaratively defines EPICS IOC instances for containers and Kubernetes, separating a generic IOC image (which bundles a set of EPICS support modules) from an IOC instance (a YAML description of what that image should run). From that YAML, ibek generates the IOC startup script (st.cmd) and EPICS database that the container runs. Recent versions also add ibek pattern for vendoring runtime-support patterns into a services repo. See the documentation for the overview and tutorials.

Source	epics-containers/ibek
PyPI	pip install ibek
Documentation	https://epics-containers.github.io/ibek
Releases	epics-containers/ibek

How the documentation is structured

Documentation is split into four categories, also accessible from links in the top bar.

• Tutorials
  • Installation
  • Build your first IOC instance

Tutorials for installation and typical usage. New users start here.

• How-to Guides
  • Vendor runtime-support patterns into a services repo
  • Contribute to the project

Practical step-by-step guides for the more experienced user.

• Explanations
  • Overview: what ibek is and its core concepts
  • Architecture and data flow
  • Architectural Decision Records

Explanations of how it works and why it works that way.

• Reference
  • CLI reference
  • Support module YAML reference (*.ibek.support.yaml)
  • IOC instance YAML and schemas reference
  • Jinja template context reference
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.