deploy: 4214c89

epics-containers · Oct 26, 2023 · 666b685 · 666b685
1 parent b62805d
commit 666b685
Show file tree

Hide file tree

Showing 65 changed files with 829 additions and 268 deletions.
diff --git a/dev/.buildinfo b/dev/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ba762b4eaf23c85d8b16a0961ea745ad
+config: 0a7577ae333bfcb6c5c34a439a3f3110
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle
diff --git a/dev/.doctrees/user/explanations/kubernetes_cluster.doctree b/dev/.doctrees/user/explanations/kubernetes_cluster.doctree
diff --git a/dev/.doctrees/user/how-to/ibek-support.doctree b/dev/.doctrees/user/how-to/ibek-support.doctree
diff --git a/dev/.doctrees/user/how-to/useful_k8s.doctree b/dev/.doctrees/user/how-to/useful_k8s.doctree
diff --git a/dev/.doctrees/user/index.doctree b/dev/.doctrees/user/index.doctree
diff --git a/dev/.doctrees/user/reference/ioc_helm_chart.doctree b/dev/.doctrees/user/reference/ioc_helm_chart.doctree
diff --git a/dev/.doctrees/user/tutorials/generic_ioc.doctree b/dev/.doctrees/user/tutorials/generic_ioc.doctree
diff --git a/dev/.doctrees/user/tutorials/ibek.doctree b/dev/.doctrees/user/tutorials/ibek.doctree
diff --git a/dev/.doctrees/user/tutorials/setup_k8s.doctree b/dev/.doctrees/user/tutorials/setup_k8s.doctree
diff --git a/dev/_sources/user/explanations/kubernetes_cluster.rst.txt b/dev/_sources/user/explanations/kubernetes_cluster.rst.txt
@@ -37,7 +37,7 @@ Three cluster topologies were considered for this project.
 Current Approach
 ----------------
 
-DLS is currently investigating Cluster per Beamline as the preferred topology. We
+DLS is using Cluster per Beamline as the preferred topology. We
 will continue to have a central cluster for shared services but in addition will
 have a cluster per beamline and a cluster for the accelerator.
 

diff --git a/dev/_sources/user/how-to/ibek-support.rst.txt b/dev/_sources/user/how-to/ibek-support.rst.txt
@@ -0,0 +1,38 @@
+Updating and Testing ibek-support
+=================================
+
+.. Warning::
+
+    This is draft only and out of date. It will be updated soon.
+
+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 [email protected]:epics-containers/ibek-defs.git
+    # clone an example domain repo with example IOC yaml
+    git clone [email protected]: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.
diff --git a/dev/_sources/user/how-to/useful_k8s.rst.txt b/dev/_sources/user/how-to/useful_k8s.rst.txt
@@ -11,7 +11,8 @@ The dashboard gives you a nice GUI for exploring and controlling your cluster.
 It is very useful for new users to get an understanding of what Kubernetes
 has to offer.
 
-These commands should be run INSIDE the devcontainer.
+These commands should be run after you have set up your Kubernetes cluster and
+setup the environment variables as described in `../tutorials/setup_k8s`.
 
 Execute this on your workstation:
 
@@ -48,10 +49,6 @@ Then create the admin user and role by executing the following:
 
 Get a token for the user and copy the token into your clipboard.
 
-On k3s v1.23 and older::
-
-    kubectl -n kubernetes-dashboard describe secret admin-user-token | grep '^token'
-
 On k3s v1.24 and newer::
 
     kubectl -n kubernetes-dashboard create token admin-user

diff --git a/dev/_sources/user/index.rst.txt b/dev/_sources/user/index.rst.txt
@@ -36,13 +36,11 @@ side-bar.
             :caption: How-to Guides
             :maxdepth: 1
 
-            how-to/run_iocs
             how-to/debug
             how-to/contributing
             how-to/own_tools
             how-to/useful_k8s
-            how-to/update_templated
-            how-to/ibek-defs
+            how-to/ibek-support
 
         +++
 
@@ -59,7 +57,6 @@ side-bar.
             explanations/kubernetes_cluster
             explanations/docs-structure
             explanations/repositories
-            explanations/repos
 
         +++
 

diff --git a/dev/_sources/user/reference/ioc_helm_chart.rst.txt b/dev/_sources/user/reference/ioc_helm_chart.rst.txt
@@ -1,6 +1,10 @@
 IOC Helm Chart Details
 ======================
 
+.. Warning::
+
+    This page is out of date and will be updated soon.
+
 IOC instances are described using a helm chart which in turn generates
 a Kubernetes manifest to tell Kubernetes what resources to create in order
 to run the IOC instance.

diff --git a/dev/_sources/user/tutorials/generic_ioc.rst.txt b/dev/_sources/user/tutorials/generic_ioc.rst.txt
@@ -57,9 +57,6 @@ using an ``ec`` command.
         git remote add origin [email protected]:<YOUR USER NAME>/ioc-adurl.git
         git push --set-upstream origin main
 
-Note that creating your project in this way means it is possible to
-synchronize changes from the original ioc-template project.
-See `../how-to/update_templated`.
 
 Prepare the New Repo for Development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -258,11 +255,6 @@ follows:
 ADCore and ADSupport already have ibek-defs files as they were previously created
 when making ``ioc-adsimdetector``.
 
-.. note::
-
-    The folder /repos is where all externally fetched source code is stored
-    inside our containers. For a detailed explanation see
-    `../explanations/repos`
 
 .. _CONFIG_SITE.local: https://areadetector.github.io/areaDetector/install_guide.html#edit-config-site-local-and-optionally-config-site-local-epics-host-arch
 

diff --git a/dev/_sources/user/tutorials/ibek.rst.txt b/dev/_sources/user/tutorials/ibek.rst.txt
@@ -66,7 +66,7 @@ TODO: this will become a concrete example for walking through as a tutorial with
 NOTE: these steps are for building and testing the example IOC that comes with
 the Generic ioc template. This will break the system test and that would need
 to be updated accordingly. To just work on ibek support files using an external
-ioc instance YAML file see `../how-to/ibek-defs` (I probably need to combine
+ioc instance YAML file see `../how-to/ibek-support` (I probably need to combine
 these two pages into something coherent).
 
 

diff --git a/dev/_sources/user/tutorials/setup_k8s.rst.txt b/dev/_sources/user/tutorials/setup_k8s.rst.txt
@@ -47,9 +47,6 @@ ready to test deployment of EPICS IOCs.
     standalone, or with other orchestration tools. e.g. In `ioc_changes`
     we will demonstrate running an IOC locally using podman alone.
 
-    If you want to take advantage of containers for IOCs but do not want to
-    take on Kubernetes then there are some hints as to how to achieve this
-    here: `../how-to/run_iocs`.
 
 Bring Your Own Cluster
 ----------------------

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.9.1.dev27+gd86f031',
+    VERSION: '0.9.1.dev28+g4214c89',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/dev/developer/explanations/decisions.html b/dev/developer/explanations/decisions.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Architectural Decision Records &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Architectural Decision Records &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/explanations/decisions/0001-record-architecture-decisions.html b/dev/developer/explanations/decisions/0001-record-architecture-decisions.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>1. Record architecture decisions &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>1. Record architecture decisions &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/explanations/decisions/0002-switched-to-pip-skeleton.html b/dev/developer/explanations/decisions/0002-switched-to-pip-skeleton.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>2. Adopt epics-containers.github.io for project structure &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>2. Adopt epics-containers.github.io for project structure &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/how-to/build-docs.html b/dev/developer/how-to/build-docs.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Build the docs using sphinx &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Build the docs using sphinx &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/how-to/contribute.html b/dev/developer/how-to/contribute.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Contributing to the project &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Contributing to the project &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/how-to/make-release.html b/dev/developer/how-to/make-release.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Make a release &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Make a release &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/how-to/update-tools.html b/dev/developer/how-to/update-tools.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Update the tools &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Update the tools &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/index.html b/dev/developer/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Developer Guide &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Developer Guide &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/reference/standards.html b/dev/developer/reference/standards.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Standards &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Standards &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/developer/tutorials/dev-install.html b/dev/developer/tutorials/dev-install.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Developer Contributing &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Developer Contributing &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="../../_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="../../_static/documentation_options.js?v=8b7d417c"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/genindex.html b/dev/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>Index &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="_static/documentation_options.js?v=8b7d417c"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/index.html b/dev/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>epics-containers &#8212; epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <title>epics-containers &#8212; epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="_static/documentation_options.js?v=8b7d417c"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/search.html b/dev/search.html
@@ -6,7 +6,7 @@
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - epics-containers.github.io 0.9.1.dev27+gd86f031 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - epics-containers.github.io 0.9.1.dev28+g4214c89 documentation</title>
 
 
 
@@ -36,7 +36,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
   <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>
 
-    <script src="_static/documentation_options.js?v=e8bf7a3e"></script>
+    <script src="_static/documentation_options.js?v=8b7d417c"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/dev/searchindex.js b/dev/searchindex.js