From 4a540fbecbb35d08a3c165d5b0e8e99be9783d3a Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Wed, 28 Aug 2024 13:59:02 +0100 Subject: [PATCH 1/2] final readme changes --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e9400b5..1df5edd 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ mkdir -p ~/.local/share/bash-completion/completions podman completion bash > ~/.local/share/bash-completion/completions/podman ``` -## Local Developer Testing Environment +## Local Testing Environment -To launch a development environment on a workstation, including phoebus perform the following steps: +To launch a test environment on a workstation, including phoebus perform the following steps: ```bash git clone https://github.com/epics-containers/example-services.git @@ -40,12 +40,12 @@ This will launch the following containers: - ca-gateway - phoebus - a motor simulation IOC -- a area detector simulation IOC +- an area detector simulation IOC - an additional simple example IOC ## Experimenting -You can now use: +You can now try the following (we use `ec` as a short alias for `docker compose`): ```bash # use caget/put locally @@ -57,7 +57,7 @@ ec exec bl01t-ea-test-01 bash export EPICS_CA_ADDR_LIST=127.0.0.1 caget BL01T-DI-CAM-01:DET:Acquire_RBV -# attach to logs of a service +# attach to logs of a service (-f follows the logs, use ctrl-c to exit) ec logs bl01t-di-cam-01 -f # stop a service ec stop bl01t-di-cam-01 From 6ac7df522e3cb7ba601bc4c646c9324c19a1beb3 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Wed, 28 Aug 2024 14:19:09 +0100 Subject: [PATCH 2/2] caveat deploy profile --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1df5edd..f69c2a0 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,9 @@ ec down ``` # Deploy To Beamline Servers + +TODO: this is work in progress - we have not yet created appropriate ca-gateway settings for this. + To deploy IOCs to a server, clone this repo and run the following command from the repo root: ```bash