Skip to content

Commit 7a32b80

Browse files
esmith1729esmith1729
committed
Add template structure from DLS copier function
1 parent 8b5231b commit 7a32b80

27 files changed

Lines changed: 717 additions & 1 deletion

File tree

‎.copier-answers.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2+
_commit: 3.2.1
3+
_src_path: gh:epics-containers/ec-services-template
4+
beamline: bl01t
5+
cluster_namespace: local
6+
description: beamline bl01t IOC Instances and Services
7+
git_platform: github.com
8+
github_org: esmith1729
9+
repo_uri: git@github.com:esmith1729/bl01t.git
10+
type: beamline

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Look for updates to python and docker dependencies.
2+
3+
version: 2
4+
updates:
5+
- package-ecosystem: "docker"
6+
directory: "/"
7+
schedule:
8+
interval: "daily"
9+
- package-ecosystem: "pip"
10+
directory: "/"
11+
schedule:
12+
interval: "daily"

‎.github/workflows/ci_verify.sh‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/bin/bash
2+
3+
# CI to verify all the instances specified in this repo have valid configs.
4+
# The intention here is to verify that any mounted config folder will work
5+
# with the container image specified in values.yaml
6+
#
7+
# At present this will only work with IOCs because it uses ibek. To support
8+
# other future services that don't use ibek, we will need to add a standard
9+
# entrypoint for validating the config folder mounted at /config.
10+
11+
ROOT=$(realpath $(dirname ${0})/../..)
12+
set -xe
13+
14+
# use docker if available else use podman
15+
if ! docker version &>/dev/null; then docker=podman; else docker=docker; fi
16+
17+
for service in ${ROOT}/services/*
18+
do
19+
# Skip if subfolder has no config to validate
20+
if [ ! -f "${service}/config/ioc.yaml" ]; then
21+
continue
22+
fi
23+
24+
# Get the container image that this service uses from values.yaml if supplied
25+
image=$(cat ${service}/values.yaml | sed -rn 's/^ +image: (.*)/\1/p')
26+
27+
if [ -n "${image}" ]; then
28+
echo "Validating ${service} with ${image}"
29+
30+
# This will fail and exit if the ioc.yaml is invalid
31+
$docker run --rm --entrypoint bash \
32+
-v ${service}/config:/config ${image} \
33+
-c 'ibek runtime generate /config/ioc.yaml /epics/ibek-defs/*'
34+
35+
fi
36+
done

‎.github/workflows/verify.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
on:
2+
push:
3+
pull_request:
4+
5+
jobs:
6+
verify_ioc_instances:
7+
runs-on: ubuntu-latest
8+
# pull requests are a duplicate of a branch push if within the same repo.
9+
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: run IOC checks
15+
run: |
16+
bash .github/workflows/ci_verify.sh

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**/*.tz
2+
**/*.tgz
3+
.history
4+
**/Chart.lock
5+
**/charts
6+
**/*.bob
7+
edm/bobs
8+
**/*copy

‎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 2021 Knap, Giles (DLSLtd,RAL,LSCI)
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.

‎README.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
1-
# bl01t
1+
# beamline bl01t IOC Instances and Services
2+
3+
This repository holds the a definition of beamline bl01t IOC Instances and services. Each sub folder of the `services` directory contains a helm chart for a specific service or IOC.
4+
5+
NOTE: in order to take advantage of version control, you must deploy these services using the edge-containers-cli. This will ensure that the services are deployed from a specific tag of this repository and that the version number is recorded in the cluster.
6+
7+
See https://github.com/epics-containers/edge-containers-cli for more information.
8+

‎environment.sh‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
#!/bin/bash
2+
3+
# a bash script to source in order to set up your command line to in order
4+
# to work with the bl01t IOCs and Services.
5+
6+
# check we are sourced
7+
if [ "$0" = "$BASH_SOURCE" ]; then
8+
echo "ERROR: Please source this script"
9+
exit 1
10+
fi
11+
12+
echo "Loading environment for beamline bl01t IOC Instances and Services ..."
13+
14+
#### SECTION 1. Environment variables ##########################################
15+
16+
# a mapping between generic IOC repo roots and the related container registry
17+
# use spaces or line breaks to separate multiple mappings by default this
18+
# inlcudes mappings for github and DLS gitlab, add your own here.
19+
export EC_REGISTRY_MAPPING_REGEX='
20+
.*github.com:(.*)\/(.*) ghcr.io/\1/\2
21+
.*gitlab.diamond.ac.uk.*\/(.*) gcr.io/diamond-privreg/controls/prod/ioc/\1
22+
'
23+
# the namespace to use for kubernetes deployments - use local for local docker/podman
24+
export EC_K8S_NAMESPACE=local
25+
# the git repo for this project
26+
export EC_SERVICES_REPO=git@github.com:esmith1729/bl01t.git
27+
# declare your centralised log server Web UI
28+
export EC_LOG_URL="https://graylog2.diamond.ac.uk/search?rangetype=relative&fields=message%2Csource&width=1489&highlightMessage=&relative=172800&q=pod_name%3A{service_name}*"
29+
# enforce a specific container cli - defaults to whatever is available
30+
# export EC_CONTAINER_CLI=podman
31+
# enable debug output in all 'ec' commands
32+
# export EC_DEBUG=1
33+
34+
35+
#### SECTION 2. Install ec #####################################################
36+
37+
# check if epics-containers-cli (ec command) is installed
38+
if ! ec --version &> /dev/null; then
39+
echo "ERROR: Please set up a virtual environment and: 'pip install edge-containers-cli'"
40+
return 1
41+
fi
42+
43+
# enable shell completion for ec commands
44+
source <(ec --show-completion ${SHELL})
45+
46+
47+
#### SECTION 3. Configure Kubernetes Cluster ###################################
48+
49+
50+
# no cofiguration in this section for local docker/podman deployments
51+
52+

‎helm/shared/Chart.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# A Helm Chart for deploying an IOC instance
2+
apiVersion: v2
3+
name: shared
4+
5+
version: 3.0.0
6+
7+
type: application
8+
9+
dependencies:
10+
- name: ioc-instance
11+
version: "3.0.0"
12+
repository: "oci://ghcr.io/epics-containers"
13+
#repository: "file:///scratch/hgv27681/work/ec-helm-charts/Charts/ioc-instance"

‎helm/shared/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Beamline or Accelerator Domain Helm Chart Template
2+
==================================================
3+
4+
The files in this folder are used to generate a helm chart for IOC instances
5+
on this repository's beamline or accelerator ioc.
6+
7+
We generate a new helm chart for each IOC instance deployment. This is
8+
primarily because helm cannot package the config folder at package time.
9+
This approach could therefore be reviewed once this PR is released:
10+
https://github.com/helm/helm/pull/10077
11+
12+
To deploy at IOC using beamline chart make sure you have epics-containers-cli
13+
installed and you are connected to the correct kubernetes cluster.
14+
15+
```bash
16+
source environment.sh
17+
ec ioc deploy <ioc_name> <ioc_version>
18+
```
19+
20+
see: [EPICS Containers CLI Repository](https://github.com/epics-containers/epics-containers-cli).
21+

0 commit comments

Comments
 (0)