diff --git a/.copier-answers.yml b/.copier-answers.yml new file mode 100644 index 0000000..136c37c --- /dev/null +++ b/.copier-answers.yml @@ -0,0 +1,10 @@ +# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY +_commit: 3.0.0 +_src_path: gh:epics-containers/ec-services-template +beamline: bl01t +cluster_namespace: local +description: beamline bl01t IOC Instances and Services +git_platform: github.com +github_org: danielmaclaren +repo_uri: git@github.com:danielmaclaren/bl01t.git +type: beamline diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..5c6e6ec --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# Look for updates to python and docker dependencies. + +version: 2 +updates: + - package-ecosystem: "docker" + directory: "/" + schedule: + interval: "daily" + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/ci_verify.sh b/.github/workflows/ci_verify.sh new file mode 100755 index 0000000..2b71890 --- /dev/null +++ b/.github/workflows/ci_verify.sh @@ -0,0 +1,36 @@ +#!/bin/bash + +# CI to verify all the instances specified in this repo have valid configs. +# The intention here is to verify that any mounted config folder will work +# with the container image specified in values.yaml +# +# At present this will only work with IOCs because it uses ibek. To support +# other future services that don't use ibek, we will need to add a standard +# entrypoint for validating the config folder mounted at /config. + +ROOT=$(realpath $(dirname ${0})/../..) +set -xe + +# use docker if available else use podman +if ! docker version &>/dev/null; then docker=podman; else docker=docker; fi + +for service in ${ROOT}/services/* +do + # Skip if subfolder has no config to validate + if [ ! -f "${service}/config/ioc.yaml" ]; then + continue + fi + + # Get the container image that this service uses from values.yaml if supplied + image=$(cat ${service}/values.yaml | sed -rn 's/^ +image: (.*)/\1/p') + + if [ -n "${image}" ]; then + echo "Validating ${service} with ${image}" + + # This will fail and exit if the ioc.yaml is invalid + $docker run --rm --entrypoint bash \ + -v ${service}/config:/config ${image} \ + -c 'ibek runtime generate /config/ioc.yaml /epics/ibek-defs/*' + + fi +done diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml new file mode 100644 index 0000000..8d07daf --- /dev/null +++ b/.github/workflows/verify.yml @@ -0,0 +1,16 @@ +on: + push: + pull_request: + +jobs: + verify_ioc_instances: + runs-on: ubuntu-latest + # pull requests are a duplicate of a branch push if within the same repo. + if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository + + steps: + - uses: actions/checkout@v4 + + - name: run IOC checks + run: | + bash .github/workflows/ci_verify.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a37600f --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +**/*.tz +**/*.tgz +.history +**/Chart.lock +**/charts +**/*.bob +edm/bobs +**/*copy diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..506438f --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Knap, Giles (DLSLtd,RAL,LSCI) + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d354327 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# beamline bl01t IOC Instances and Services + +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. + +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. + +See https://github.com/epics-containers/edge-containers-cli for more information. + diff --git a/environment.sh b/environment.sh new file mode 100755 index 0000000..1a30985 --- /dev/null +++ b/environment.sh @@ -0,0 +1,52 @@ +#!/bin/bash + +# a bash script to source in order to set up your command line to in order +# to work with the bl01t IOCs and Services. + +# check we are sourced +if [ "$0" = "$BASH_SOURCE" ]; then + echo "ERROR: Please source this script" + exit 1 +fi + +echo "Loading environment for beamline bl01t IOC Instances and Services ..." + +#### SECTION 1. Environment variables ########################################## + +# a mapping between generic IOC repo roots and the related container registry +# use spaces or line breaks to separate multiple mappings by default this +# inlcudes mappings for github and DLS gitlab, add your own here. +export EC_REGISTRY_MAPPING_REGEX=' +.*github.com:(.*)\/(.*) ghcr.io/\1/\2 +.*gitlab.diamond.ac.uk.*\/(.*) gcr.io/diamond-privreg/controls/prod/ioc/\1 +' +# the namespace to use for kubernetes deployments - use local for local docker/podman +export EC_K8S_NAMESPACE=local +# the git repo for this project +export EC_SERVICES_REPO=git@github.com:danielmaclaren/bl01t.git +# declare your centralised log server Web UI +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}*" +# enforce a specific container cli - defaults to whatever is available +# export EC_CONTAINER_CLI=podman +# enable debug output in all 'ec' commands +# export EC_DEBUG=1 + + +#### SECTION 2. Install ec ##################################################### + +# check if epics-containers-cli (ec command) is installed +if ! ec --version &> /dev/null; then + echo "ERROR: Please set up a virtual environment and: 'pip install edge-containers-cli'" + return 1 +fi + +# enable shell completion for ec commands +source <(ec --show-completion ${SHELL}) + + +#### SECTION 3. Configure Kubernetes Cluster ################################### + + +# no cofiguration in this section for local docker/podman deployments + + diff --git a/helm/configmap/Chart.yaml b/helm/configmap/Chart.yaml new file mode 100644 index 0000000..07db43f --- /dev/null +++ b/helm/configmap/Chart.yaml @@ -0,0 +1,7 @@ +# A Helm Chart for adding arbitrary configuration to a service instance +apiVersion: v2 +name: configmap + +version: 2.0.0 + +type: application diff --git a/helm/configmap/services b/helm/configmap/services new file mode 120000 index 0000000..50ea7b2 --- /dev/null +++ b/helm/configmap/services @@ -0,0 +1 @@ +../../services \ No newline at end of file diff --git a/helm/configmap/templates/configmap.yaml b/helm/configmap/templates/configmap.yaml new file mode 100644 index 0000000..51474e2 --- /dev/null +++ b/helm/configmap/templates/configmap.yaml @@ -0,0 +1,16 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ .Release.Name }}-config + labels: + app: {{ .Release.Name }} +data: + +{{- $configPath := printf "services/%s/config/**" .Release.Name }} + +{{- if eq (.Files.Glob $configPath | len) 0 }} +{{- fail (printf "%s %s" "no files found in the ioc instance config folder" $configPath) }} +{{- end }} + +# contents of the ioc instance config folder +{{ (.Files.Glob $configPath).AsConfig | indent 2 }} diff --git a/helm/shared/Chart.yaml b/helm/shared/Chart.yaml new file mode 100644 index 0000000..a571e6e --- /dev/null +++ b/helm/shared/Chart.yaml @@ -0,0 +1,13 @@ +# A Helm Chart for deploying an IOC instance +apiVersion: v2 +name: shared + +version: 2.0.0 + +type: application + +dependencies: + - name: ioc-instance + version: "2.0.0" + repository: "oci://ghcr.io/epics-containers" + #repository: "file:///scratch/hgv27681/work/ec-helm-charts/Charts/ioc-instance" diff --git a/helm/shared/README.md b/helm/shared/README.md new file mode 100644 index 0000000..a842cd0 --- /dev/null +++ b/helm/shared/README.md @@ -0,0 +1,21 @@ +Beamline or Accelerator Domain Helm Chart Template +================================================== + +The files in this folder are used to generate a helm chart for IOC instances +on this repository's beamline or accelerator ioc. + +We generate a new helm chart for each IOC instance deployment. This is +primarily because helm cannot package the config folder at package time. +This approach could therefore be reviewed once this PR is released: +https://github.com/helm/helm/pull/10077 + +To deploy at IOC using beamline chart make sure you have epics-containers-cli +installed and you are connected to the correct kubernetes cluster. + +```bash + source environment.sh + ec ioc deploy +``` + +see: [EPICS Containers CLI Repository](https://github.com/epics-containers/epics-containers-cli). + diff --git a/helm/shared/values.yaml b/helm/shared/values.yaml new file mode 100644 index 0000000..20d6b7e --- /dev/null +++ b/helm/shared/values.yaml @@ -0,0 +1,85 @@ +# default values for all IOCs on bl47p beamline +ioc-instance: + + # the beamline name - only set for beamlines + beamline: bl01t + # the location where the IOCs will run - same as beamline for beamlines + ioc_group: bl01t + # the name of the repository in which the IOC is grouped + location: bl01t + + # typically use the default service account in the namespace. + # If you need to specify an alternative then uncomment below + # serviceAccountName: k8s-p38-iocs + + # useHostNetwork - use host network for IOC - required for Channel Access + # to work outside of the cluster + hostNetwork: true + + # useAffinity - only run on nodes with label beamline: + # or location: + # Comment out useAffiniity for dedicated cluster, set to true for shared cluster + + + # root folder for ioc source/binaries inside generic IOC container + iocFolder: /epics/ioc + iocConfig: /epics/ioc/config + # scripts for controlling the IOC + start: /epics/ioc/start.sh + stop: /epics/ioc/stop.sh + liveness: /epics/ioc/liveness.sh + + # The following are added to the pod's environment + # Add any environment variables as needed + globalenv: + - name: "EXAMPLE_ENV" + value: "example" + + # defaults for securityContext + # Usually override runAsXXX in the individual IOC values.yaml. + # At DLS the IOCs that write to the shared data directory must use + # iXXdetector user/group IDs + securityContext: + allowPrivilegeEscalation: false + # runAsUser: 37887 + # runAsGroup: 37887 + + ######################################################################################## + # The following values are expected to be overridden in individual IOC values.yaml + ######################################################################################## + + # This value is the only mandatory override. You must declare the image for the + # Generic IOC in the values.yaml for each IOC instance. + image: + + # a volume to mount for writing data to. This can be a PVC or a hostPath + # the PVC + dataVolume: + # Create a PVC called {.Chart.Name}-data when true + pvc: true + # A path on the host machine to write data into. Also used as the path that the + # pvc or hostPath will be mounted at so that users need not be confused about + # inside/outside container paths. + + # This should be a hostPath to the shared data directory for IOCs that + # need to write to the shared data directory - at DLS this must be + # /dls/iXX/data (writing data to the host also needs 'pvc: false') + hostPath: /data + + # use the shared PVC for publishing opi files over http (see services/opis) + opisClaim: bl01t-opi-claim + # use the shared PVC for publishing opi files over http (see services/opis) + runtimeClaim: bl01t-runtime-claim + # use the shared PVC autosave files (comment out for no autosave) + autosaveClaim: bl01t-autosave-claim + + # default resource limits + resources: + limits: + cpu: 500m + memory: 256Mi + requests: + cpu: 100m + memory: 64M + + # extra tolerations as required diff --git a/include/iocs/Chart.yaml b/include/iocs/Chart.yaml new file mode 100644 index 0000000..cb175fa --- /dev/null +++ b/include/iocs/Chart.yaml @@ -0,0 +1,24 @@ +# A Helm Chart for an IOC instance +apiVersion: v2 +name: ioc-instance + +# This chart is to be shared by all IOC instances in the services folder +# via a symlink. When changes are made to the dependent charts, it is +# necessary to update the version number here so that all IOC instances +# show a change in the next commit. +version: 2.0.0 + +# When we deploy with the edge-containers-cli we override this on the command line. +# Direct deployment with Helm will use the default beta value.This value should +# be left as beta always, as it gets used when deploying manually with Helm. +appVersion: 0.0.1b1 + +type: application + +dependencies: + - name: configmap + version: "2.0.0" + repository: file://../../helm/configmap + - name: shared + version: "2.0.0" + repository: file://../../helm/shared diff --git a/services/bl01t-ea-test-01/Chart.yaml b/services/bl01t-ea-test-01/Chart.yaml new file mode 120000 index 0000000..a7be5a8 --- /dev/null +++ b/services/bl01t-ea-test-01/Chart.yaml @@ -0,0 +1 @@ +../../include/iocs/Chart.yaml \ No newline at end of file diff --git a/services/bl01t-ea-test-01/config/ioc.db b/services/bl01t-ea-test-01/config/ioc.db new file mode 100644 index 0000000..f9716cf --- /dev/null +++ b/services/bl01t-ea-test-01/config/ioc.db @@ -0,0 +1,26 @@ +record(calc, "bl01t:IBEK:SUM") { + field(DESC, "Sum A and B") + field(CALC, "A+B") + field(INPA, "bl01t:IBEK:A") + field(INPB, "bl01t:IBEK:B") +} + +record(ao, "bl01t:IBEK:A") { + field(DESC, "A voltage") + field(PREC, "3") + field(EGU, "Volts") + field(DRVL, "-10") + field(DRVH, "+10") + field(VAL, "0.000") + field(FLNK, "bl01t:IBEK:SUM") +} + +record(ao, "bl01t:IBEK:B") { + field(DESC, "B voltage") + field(PREC, "3") + field(EGU, "Volts") + field(DRVL, "-10") + field(DRVH, "+10") + field(VAL, "0.000") + field(FLNK, "bl01t:IBEK:SUM") +} \ No newline at end of file diff --git a/services/bl01t-ea-test-01/config/ioc.yaml b/services/bl01t-ea-test-01/config/ioc.yaml new file mode 100644 index 0000000..8554f28 --- /dev/null +++ b/services/bl01t-ea-test-01/config/ioc.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://github.com/epics-containers/ioc-template/releases/download/2024.1.1/ibek.ioc.schema.json + +ioc_name: "{{ __utils__.get_env('IOC_NAME') }}" + +description: Very generic instance for testing generic IOCs + +entities: + - type: epics.EpicsEnvSet + name: EPICS_TZ + value: "GMT0BST" + + - type: devIocStats.iocAdminSoft + IOC: "{{ ioc_name | upper }}" + + - type: epics.StartupCommand + command: dbLoadRecords("/epics/ioc/config/ioc.db") + + - type: epics.dbpf + pv: bl01t:IBEK:A + value: "2.54" + + - type: epics.dbpf + pv: bl01t:IBEK:B + value: "2.61" + + - type: epics.PostStartupCommand + command: | + dbgf bl01t:IBEK:SUM diff --git a/services/bl01t-ea-test-01/values.yaml b/services/bl01t-ea-test-01/values.yaml new file mode 100644 index 0000000..fe23f21 --- /dev/null +++ b/services/bl01t-ea-test-01/values.yaml @@ -0,0 +1,4 @@ +# latest container image for GigE cameras from the GitHub Container Registry +shared: + ioc-instance: + image: ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2024.2.1 diff --git a/services/epics-opis/Chart.yaml b/services/epics-opis/Chart.yaml new file mode 100644 index 0000000..c1dba63 --- /dev/null +++ b/services/epics-opis/Chart.yaml @@ -0,0 +1,17 @@ +# A Helm Chart for an IOC instance +apiVersion: v2 +name: epics-opis + +version: 2.0.0 + +# When we deploy with the edge-containers-cli we override this on the command line. +# Direct deployment with Helm will use the default beta value. +appVersion: 0.0.1b1 + +type: application + +dependencies: + - name: epics-opis + version: "2.0.0" + #repository: "file:///scratch/hgv27681/work/ec-helm-charts/Charts/epics-opis" + repository: "oci://ghcr.io/epics-containers" diff --git a/services/epics-opis/README.md b/services/epics-opis/README.md new file mode 100644 index 0000000..8e2eeed --- /dev/null +++ b/services/epics-opis/README.md @@ -0,0 +1,16 @@ +epics-opis Helm Chart +===================== + +Installs the web server that shares the engineering screens published by each IOC. The structure is two deep only: IOC names as folders at the root containing all the IOCs OPI files in a flat list. + +Deploy this chart to the cluster by setting up your cluster namespace connection using environment.sh and then executing +the following commands: + +```bash +# lists the latest versions of all services +ec list +# deploy the latest version of the epics-pvcs which includes an opis volume +ec deploy epics-pvcs VERSION +# deploy the latest version of the epics-opis service +ec deploy epics-opis VERSION +``` diff --git a/services/epics-opis/values.yaml b/services/epics-opis/values.yaml new file mode 100644 index 0000000..1d8fe4a --- /dev/null +++ b/services/epics-opis/values.yaml @@ -0,0 +1,16 @@ +epics-opis: + + + # the beamline name - only set for beamlines + beamline: bl01t + # the location where the IOCs will run - same as beamline for beamlines + ioc_group: bl01t + # the name of the repository in which the IOC is grouped + location: bl01t + + # useAffinity - only run on nodes with label beamline: + # or location: + # Comment out useAffiniity for dedicated cluster, set to true for shared cluster + + + # extra toleration for the shared cluster training rigs \ No newline at end of file diff --git a/services/epics-pvcs/Chart.yaml b/services/epics-pvcs/Chart.yaml new file mode 100644 index 0000000..4fb9747 --- /dev/null +++ b/services/epics-pvcs/Chart.yaml @@ -0,0 +1,17 @@ +# A Helm Chart for an IOC instance +apiVersion: v2 +name: epics-pvcs + +version: 2.0.0 + +# When we deploy with the edge-containers-cli we override this on the command line. +# Direct deployment with Helm will use the default beta value. +appVersion: 0.0.1b1 + +type: application + +dependencies: + - name: epics-pvcs + version: "2.0.0" + # repository: "file:///scratch/hgv27681/work/ec-helm-charts/Charts/epics-pvcs" + repository: "oci://ghcr.io/epics-containers" diff --git a/services/epics-pvcs/README.md b/services/epics-pvcs/README.md new file mode 100644 index 0000000..6b006da --- /dev/null +++ b/services/epics-pvcs/README.md @@ -0,0 +1,20 @@ +epics-pvcs Helm Chart +===================== + +This is the first service that should be installed in a namespace because it creates the Volumes that hold shared data for IOCs. + +Sets up the PVCs that all IOCs may use. These should be set up once and not deleted as they hold data for IOCs. All of the PVCs have a folder hierarchy with the names of IOCs at the root. + + - autosave data: for IOCs that support autosave. This is separate from IOC helm charts so that it can survive deletion and re-creation of an IOC. + + - opis: all the OPI files for engineering screens that an IOC supplies are saved here. This is stored in a single PVC so that the opis service can publish them over http for access by an OPI client. + +Deploy this chart to the cluster by setting up your cluster namespace connection using environment.sh and then executing +the following commands: + +```bash +# lists the latest versions of all services +ec list +# deploy the latest version of the epics-pvcs +ec deploy epics-pvcs VERSION +``` diff --git a/services/epics-pvcs/values.yaml b/services/epics-pvcs/values.yaml new file mode 100644 index 0000000..b3d960b --- /dev/null +++ b/services/epics-pvcs/values.yaml @@ -0,0 +1,8 @@ +epics-pvcs: + + # the beamline name - only set for beamlines + beamline: bl01t + # the location where the IOCs will run - same as beamline for beamlines + ioc_group: bl01t + # the name of the repository in which the IOC is grouped + location: bl01t diff --git a/update-helm b/update-helm new file mode 100755 index 0000000..9dca7f4 --- /dev/null +++ b/update-helm @@ -0,0 +1,19 @@ +#!/bin/bash + +# force refresh all helm dependencies ############# + +THIS=$(realpath $(dirname $0)) + +# remove all locks and chart caches +for i in $(find ${THIS} -name *.lock) $(find ${THIS} -name charts); do + rm -r $i +done + +# rebuild dependencies (depth first) +for i in helm/* services/*; do + if [ -f $i/Chart.yaml ]; then + echo "Updating helm dependencies for $i" + # filter out the noisy "found symbolic link" messages + helm dependency build $i |& sed "/found symbolic/d" + fi +done