-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from epics-containers/dev
add notes on ibek YAML
- Loading branch information
Showing
2 changed files
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Updating and Testing ibek-defs | ||
============================== | ||
|
||
TODO: this is draft | ||
TODO: this uses a Diamond internal repo as an example | ||
|
||
The ibek-defs repository contains ibek support yaml. Here is an example | ||
procedure for local testing of changes to support yaml in ibek-defs | ||
along side IOC yaml that uses it. | ||
|
||
(Suggest you do this inside a dev-e7 workspace devcontainer) | ||
|
||
.. code-block:: bash | ||
cd my-workspace-folder | ||
# clone ibek-defs | ||
git clone git@github.com:epics-containers/ibek-defs.git | ||
# clone an example domain repo with example IOC yaml | ||
git clone git@gitlab.diamond.ac.uk:controls/containers/accelerator/acc-psc.git | ||
# get latest ibek installed | ||
pip install ibek | ||
cd acc-psc/iocs/sr25a-ioc-01 | ||
ibek build-startup config/ioc.boot.yaml ../../../ibek-defs/*/*.yaml | ||
This will get ibek generate a startup script and database generation script | ||
in the config folder. It uses config/ioc.boot.yaml as the description of | ||
the IOC 'entities' to instantiate and all of the support yaml files | ||
in ibek-defs as a source of the definitions of the classes of entities | ||
available. | ||
|
||
The example currently uses the timingtemplates definitions only. | ||
|
||
Note that at present ibek generates a script of msi invocations instead | ||
of a substitution file. This will be changed in the future. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,6 +42,7 @@ side-bar. | |
how-to/own_tools | ||
how-to/useful_k8s | ||
how-to/update_templated | ||
how-to/ibek-defs | ||
|
||
+++ | ||
|
||
|