edge_containers_cli

About

Edge containers command line interface: a tool for deploying and managing IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around familiar command line tools such as git, kubectl, helm and argocd - and can be used to learn the underlying commands being used.

For detailed documentation on the framework that this supports see: https://epics-containers.github.io/

What	Where
Source	epics-containers/edge-containers-cli
PyPI	pip install edge-containers-cli
Docker	docker run ghcr.io/epics-containers/edge-containers-cli:latest
Documentation	https://epics-containers.github.io/edge-containers-cli
Releases	epics-containers/edge-containers-cli

To discover the CLI commands, create a python virtual environment, and perform the following:

pip install edge-containers-cli
ec --version

Monitor

Some commands of the tool are also exposed as a TUI which can additionally be served as a web application.

To demo the TUI as a web application:

pip install textual-dev
textual serve "ec -b DEMO monitor"

Dashboard:

IOC logs:

How the documentation is structured

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

• Tutorials
  • Installation

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

• How-to Guides
  • Contribute to the project
  • Run in a container

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

• Explanations
  • Architectural Decision Records

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

• Reference
  • Command line reference
  • Environment variables
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.