Skip to content

Commit

Permalink
Docs update (#172)
Browse files Browse the repository at this point in the history
Adds some information and screen shots for the monitor
  • Loading branch information
marcelldls authored Oct 15, 2024
1 parent d12db4f commit 1b5a1fa
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@

# edge_containers_cli

## About

Edge containers command line interface: a tool for deploying and managing
IOCs and services in a beamline or accelerator cluster.
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/
Expand All @@ -19,7 +23,25 @@ Releases | <https://github.com/epics-containers/edge-containers-cli/relea


To discover the CLI commands, create a python virtual environment,
and perform the following::
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:

![screenshot](docs/images/ec-web.png)

IOC logs:

![screenshot](docs/images/ec-logs.png)
Binary file added docs/images/ec-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ec-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b5a1fa

Please sign in to comment.