Skip to content

Commit

Permalink
Merge pull request #148 from epics-containers/updates
Browse files Browse the repository at this point in the history
fixes for latest change to ioc-template
  • Loading branch information
gilesknap authored Aug 24, 2024
2 parents 93cb0ca + b128457 commit ed5e76f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
10 changes: 4 additions & 6 deletions docs/how-to/phoebus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@

Phoebus is a Java application that can be used to view operator interfaces.

epics-containers will support auto generation of engineering screens for
Phoebus using [PVI](https://github.com/epics-containers/pvi).
This is the initial target for epics-containers GUIs, other OPI
formats may be supported in the future.
epics-containers supports auto generation of engineering screens for Phoebus using [PVI](https://github.com/epics-containers/pvi). This is the initial target for epics-containers GUIs, other OPI formats may be supported in the future.

OPI file generation is work in progress and this page will be updated when
it is ready (est Feb 2024).
Auto-generation of engineering screens is now supported in generic IOCs.

See here for an example https://github.com/epics-containers/example-services.
6 changes: 4 additions & 2 deletions docs/how-to/update_generic_ioc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
This requires that you have copier in your path which you can do by activating a virtual environment and installing it.

```bash
python3 -m venv venv
source venv/bin/activate
pip install copier
```

Then you can run the following command to update your generic IOC to the latest template, this example for ioc-adaravis.
Then you can run the following commands to update your generic IOC to the latest template, this example for ioc-adaravis.

```bash
git clone ioc-adaravis --recursive
git clone [email protected]:epics-containers/ioc-adaravis --recursive
cd ioc-adaravis
git checkout -b update-template
copier update --trust
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/create_ioc.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ code .

Our new example IOC will be a simulation detector using the AreaDetector SimDetector. There is already a Generic IOC for the SimDetector, therefore to create an IOC Instance, we just need to refer to that Generic IOC container image and provide some configuration for it.

You can find the Generic IOC container source for SimDetector here: <https://github.com/epics-containers/ioc-adsimdetector>. This repository publishes its container image at: `ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.8.2`. Later tutorials will cover how to build and publish your own Generic IOC container images.
You can find the Generic IOC container source for SimDetector here: <https://github.com/epics-containers/ioc-adsimdetector>. This repository publishes its container image at: `ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.9.1`. Later tutorials will cover how to build and publish your own Generic IOC container images.

Edit the `compose.yml` file in the `bl01t-ea-cam-01` folder to reflect the new IOC name and to refer to the Generic IOC container image for the SimDetector:

- find and replace **replace_me** with **bl01t-ea-cam-01**
- replace **replace_with_image_uri** with **ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.8.2**
- replace **replace_with_image_uri** with **ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.9.1**

That's it for the `compose.yml` file. This file is essentially boilerplate and would look very similar for every IOC Instance you create. The two unique things that this file does are:
- determine the name of the IOC
Expand All @@ -60,7 +60,7 @@ services:
service: linux_ioc
file: ../../include/ioc.yml

image: ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.8.2
image: ghcr.io/epics-containers/ioc-adsimdetector-runtime:2024.9.1

labels:
version: 0.1.0
Expand All @@ -70,7 +70,7 @@ services:
IOC_NAME: bl01t-ea-cam-01

volumes:
- ../../opi/iocs/bl01t-ea-cam-01:/epics/opi
- ../../opiauto-generated/bl01t-ea-cam-01:/epics/opi

configs:
- source: bl01t-ea-cam-01_config
Expand Down

0 comments on commit ed5e76f

Please sign in to comment.