Merge pull request #27 from epics-containers/dev

Clarify types of change to IOCs

Author: gilesknap

docs/user/tutorials/debug_generic_ioc.rst

@@ -4,6 +4,9 @@ Debugging Generic IOC Builds
 This tutorial is a continuation of `generic_ioc`. Here we will look into
 debugging failed builds and fix the issue we saw in the  previous tutorial.
 
+This also comes under the category of type 2. change from the list
+at `ioc_change_types`.
+
 There are two ways to debug a failed build:
 
 - Keep changing the Dockerfile and rebuilding the container until the build

docs/user/tutorials/generic_ioc.rst

@@ -4,6 +4,8 @@ Create a Generic IOC
 In this tutorial we will learn how to create a generic IOC container image and
 test our changes locally before deploying it.
 
+This is a type 2. change from the list at `ioc_change_types`.
+
 The example IOC used ADSimDetector, we will make a similar IOC that uses
 ADUrl to get images from a web cam.
 

docs/user/tutorials/ioc_changes.rst

@@ -1,6 +1,7 @@
 Testing Changes to IOC Instances
 ================================
 
+.. _ioc_change_types:
 
 Types of Changes
 ----------------

docs/user/tutorials/rtems_ioc.rst

@@ -130,14 +130,44 @@ Edit the file
 
 .. code-block:: yaml
 
-If you are not at DLS you will need to change the above to match the
-parameters of your RTEMS IOC. The environment variables are:
+    base_image: ghcr.io/epics-containers/ioc-template-rtems-runtime:23.4.2
+
+    env:
+    # This is used to set EPICS_IOC_ADDR_LIST in the liveness probe client
+    # It is only needed if auto addr list discovery would fail
+    - name: K8S_IOC_ADDRESS
+        value: 172.23.250.15
+
+    # RTEMS console connection details
+    - name: RTEMS_VME_CONSOLE_ADDR
+        value: ts0001.cs.diamond.ac.uk
+    - name: RTEMS_VME_CONSOLE_PORT
+        value: "7007"
+    - name: RTEMS_VME_AUTO_REBOOT
+        value: true
+    - name: RTEMS_VME_AUTO_PAUSE
+        value: true
 
-:K8S_IOC_ADDRESS: The IP address of the IOC (mot-/dev/enet0-cipa above)
-:RTEMS_VME_CONSOLE_ADDR: Address of terminal server for console access
-:RTEMS_VME_CONSOLE_PORT: Port of terminal server for console access
-:RTEMS_VME_AUTO_REBOOT: true to reboot the hard IOC when the IOC container changes
-:RTEMS_VME_AUTO_PAUSE: true to pause/unpause when the IOC container stops/starts
+If you are not at DLS you will need to change the above to match the
+parameters of your RTEMS Crate. The environment variables are:
+
+
+.. list-table:: RTEMS Environment Variables
+    :widths: 30 70
+    :header-rows: 1
+
+    * - Variable
+      - Description
+    * - K8S_IOC_ADDRESS
+      - The IP address of the IOC (mot-/dev/enet0-cipa above)
+    * - RTEMS_VME_CONSOLE_ADDR
+      - Address of terminal server for console access
+    * - RTEMS_VME_CONSOLE_PORT
+      - Port of terminal server for console access
+    * - RTEMS_VME_AUTO_REBOOT
+      - true to reboot the hard IOC when the IOC container changes
+    * - RTEMS_VME_AUTO_PAUSE
+      - true to pause/unpause when the IOC container stops/starts
 
 Edit the file ``iocs/bl01t-ea-ioc-02/Chart.yaml`` and change the 1st 4 lines
 to represent this new IOC (the rest of the file is boilerplate):

docs/user/tutorials/support_module.rst

@@ -1,6 +1,8 @@
 Working with Support Modules
 =============================
 
+This is a type 3. change from the list at `ioc_change_types`.
+
 If you are starting a new support module then the preceding tutorials
 have covered all of the skills you will need.