Skip to content

Commit 4989a22

Browse files
gilesknapgilesknap
authored
Merge pull request #39 from epics-containers/dev
Add note about current developments
2 parents c86ea2e + d67540a commit 4989a22

File tree

7 files changed

+316
-0
lines changed

7 files changed

+316
-0
lines changed

‎docs/_static/.developer_environment/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎docs/_static/.developer_environment/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Empty Devcontainer Local Feature
2+
================================
3+
4+
These files define an empty devcontainer local feature which does nothing.
5+
6+
This is used to supply a placeholder for epics-containers projects
7+
that want to dynamically add user customization features to their devcontainers.
8+
9+
Because the inclusion of a feature is not configurable we need and empty
10+
placeholder for those users that do no supply their own custom feature.
11+
12+
See:
13+
https://github.com/epics-containers/.devcontainer/blob/main/devcontainer.json

‎docs/_static/.developer_environment/devcontainer-feature.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "Local developer environment configuration",
3+
"id": "developer_environment",
4+
"version": "1.0.0",
5+
"description": "Null feature - placeholder for user customization",
6+
"options": {}
7+
// ,
8+
// "installsAfter": [
9+
// "ghcr.io/devcontainers/features/common-utils"
10+
// ]
11+
}

‎docs/_static/.developer_environment/install.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/sh
2+
3+
echo "Null feature - placeholder for user customization"

‎docs/user/images/ibek-defs-notes.png

1.69 MB
Loading

‎docs/user/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ side-bar.
2727
tutorials/support_module
2828
tutorials/rtems_setup
2929
tutorials/rtems_ioc
30+
tutorials/ibek
3031

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

‎docs/user/tutorials/ibek.rst

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
Defining IOC Instances using IBEK
2+
=================================
3+
4+
.. warning::
5+
6+
This page is work in progress. It is currently just some loose notes.
7+
8+
TODO: do some of these titles belong in explanations or reference sections? If so then the tutorial will need to reference them at the start.
9+
10+
What is IBEK
11+
------------
12+
13+
- IOC Builder for EPICS on Kubernetes
14+
- uses Support YAML to define what each support module can supply
15+
- uses IOC YAML to instantiate instances of support features that make up an IOC instances
16+
17+
Why Use IBEK
18+
------------
19+
20+
- saves on typing of substitution files
21+
- provides a level of verification at build time
22+
- encapsulates knowledge of each support module within module
23+
- etc.
24+
25+
Alternatives
26+
------------
27+
28+
epics-containers supports out of the box dropping a startup script and
29+
substitution file into the config folder as an alternative to supplying
30+
ibek IOC YAML. But you can override start.sh and work in any way you choose
31+
at runtime.
32+
33+
ibek-defs
34+
---------
35+
36+
- defines the support modules YAML in a single place.
37+
- exists to avoid duplication of support module definitions
38+
- and to avoid working on multiple support modules while kicking off epics-containers
39+
- in future YAML could be supplied in each support module itself - but until epics-containers is widely used, this is a good way to get started
40+
- the ibek-defs repo is added as a git-submodule to every generic ioc (ioc-xxx) repo and in this ensures that a rebuild of a generic ioc will be with a consistent set of YAML files until a developer explicitly updates the submodule.
41+
42+
How to work on ibek-defs
43+
------------------------
44+
45+
Building a new generic ioc and making it compatible with ibek means creating ibek support YAML for all of its dependent support modules (where they do not already exist)
46+
47+
These steps assume you have a generic ioc for ADUrl based on ioc_template as discussed in `generic_ioc`.
48+
Your generic ioc has a default ioc instance used for testing.
49+
In ioc/config/st.cmd we have a default startup script for the example IOC.
50+
To work on ibek support we will remove this file and replace it with ``ioc.yaml``.
51+
We already have a git submodule for ibek-defs which we used for accessing patch files
52+
during build, this will also be used for creating and editing support yaml files.
53+
54+
TODO: this will become a concrete example for walking through as a tutorial with ioc-adurl.
55+
56+
NOTE: these steps are for building and testing the example IOC that comes with
57+
the generic ioc template. This will break the system test and that would need
58+
to be updated accordingly. To just work on ibek support files using an external
59+
ioc instance YAML file see `../how-to/ibek-defs` (I probably need to combine
60+
these two pages into something coherent).
61+
62+
63+
STEPS:
64+
65+
- remove ioc/config/st.cmd and create ioc/config/ioc.yaml
66+
- cd ibek-defs
67+
- git checkout -b my-working-branch
68+
- cd ..
69+
- add useful yaml definitions to ibek-defs/<a support module>/<a support module>.yaml
70+
- add some entities that use those definitions to ioc/config/ioc.yaml
71+
- TODO need to make dev launch mount ioc folder into the container - avoiding build step and giving us a tight inner dev loop
72+
- (whereas dev ioc-launch mounts in the config of an IOC instance - MAYBE this is confusing or these commands need better names?)
73+
- ec dev build
74+
- ec dev launch
75+
- inside the container:
76+
- cd /repos/epics/ioc
77+
- start.sh
78+
79+
.. figure:: ../images/ibek-defs-notes.png
80+
:align: center
81+
:width: 100%
82+
:alt: ibek-defs
83+
84+
ibek-defs
85+
86+
87+

0 commit comments

Comments
 (0)