#31 make PV names unique in tutorial IOC

Author: gilesknap

docs/user/tutorials/create_beamline.rst

@@ -87,16 +87,19 @@ repo in the future.
         mv iocs/blxxi-ea-ioc-01/ iocs/bl01t-ea-ioc-01
         mv opi/blxxi-ea-ioc-01/ opi/bl01t-ea-ioc-01
         # careful to use find *, NOT find . or you will change the .git folder
-        sed -i 's/BLXXI/BL01T/g' $(find * -type f)
-        sed -i 's/blxxi/bl01t/g' $(find * -type f)
+        sed -i s/blxxi/bl01t/g $(find * -type f)
+        # use your username as the prefix to all PV names
+        # this ensures multiple simultaneous users do not clash
+        sed -i s/BLXXI/$USER/g $(find * -type f)
 
     .. note::
 
         If you are sharing the bl01t namespace on a cluster with other users
-        (e.g. if you are at DLS) then consider changing the name of your IOC
+        (e.g. if you are at **DLS**) then change the name of your IOC
         to something unique. To do this rename the folder iocs/bl01t-ea-ioc-01
         to your unique name and edit the ``name:`` field at the top of
-        ``Chart.yaml`` to match the folder name.
+        ``Chart.yaml`` to match the folder name. The suggested name is your
+        username as the prefix e.g. hgv27681-ea-ioc-01.
 
         If you do this - remember to substitute in your own name in the
         following steps, replacing bl01t-ea-ioc-01.
@@ -115,7 +118,7 @@ repo in the future.
         git remote add origin [email protected]:<YOUR USER NAME>/bl01t.git
         git add .
         git commit -m "rename blxxi to bl01t"
-        git push origin main
+        git push --set-upstream origin main
 
     As this is your first commit you may find that you need to set your
     username and email address for git. If so, follow the instructions

docs/user/tutorials/debug_generic_ioc.rst

@@ -231,4 +231,4 @@ the image to a container registry so that it can run in Kubernetes.
 
 
 .. Once running:-
-.. caput -S BL01T-EA-TST-02:CAM:URL1
+.. caput -S $USER-EA-TST-02:CAM:URL1

docs/user/tutorials/deploy_example.rst

@@ -36,7 +36,9 @@ IOC Instance.
     point. For more information see `CLI` or try ``ec --help``.
 
 
-The following command will deploy the example IOC instance to your cluster:
+The following command will deploy the example IOC instance to your cluster
+(if you changed the ioc name in the previous tutorial then
+remember to change bl01t-ea-ioc-01 to your unique name here):
 
 .. code-block:: bash
 
@@ -91,7 +93,7 @@ You can now launch the client applications as follows:
 .. code-block:: bash
 
     ./blxxi-ea-ioc-01-gui.sh
-    c2dv --pv BL01T-EA-TST-01:IMAGE
+    c2dv --pv $USER-EA-TST-01:IMAGE
 
 Now make sure the AreaDetector is Acquiring by clicking Start if needed on
 the CAM screen. Next click on Auto to scale the

docs/user/tutorials/ioc_changes.rst

@@ -51,11 +51,12 @@ is working.
 Make the following changes in your test IOC config folder
 (``bl01t/iocs/bl01t-ea-ioc-01/config``):
 
-1. Add a file called ``extra.db`` with the following contents:
+1. Add a file called ``extra.db`` with the following contents.
+   IMPORTANT replace [$USER] with your username:
 
    .. code-block:: text
 
-      record(ai, "BL01T-EA-IOC-01:TEST") {
+      record(ai, "[$USER]-EA-IOC-01:TEST") {
          field(DESC, "Test record")
          field(DTYP, "Soft Channel")
          field(SCAN, "Passive")
@@ -91,7 +92,7 @@ from another terminal (VSCode menus -> Terminal -> New Terminal) like so:
 
 .. code-block:: bash
 
-   caget BL01T-EA-IOC-01:TEST
+   caget $USER-EA-IOC-01:TEST
 
 If you see the value 1 then your change is working.
 
@@ -156,7 +157,7 @@ from the above command):
 .. code-block:: bash
 
     export EPICS_CA_ADDR_LIST=192.168.0.32
-    caget BL01T-EA-IOC-01:TEST
+    caget $USER-EA-IOC-01:TEST
 
 Once you are happy with your changes you can push and tag your beamline repo.
 This will publish a new version of the IOC instance helm chart to the OCI helm

docs/user/tutorials/rtems_ioc.rst

@@ -229,6 +229,16 @@ runs, it deploys a kubernetes pod that manages the RTEMS IOC. It does contain
 the IOC's configuration and the IOC's binary code, which it will copy to the
 file-server on startup.
 
+Finally you will need to tell the IOC to mount the Persistent Volume Claim
+that the bl01t-ioc-files service is serving over NFS and TFTP. To do this
+add the following lines to ``iocs/bl01t-ea-ioc-02/values.yaml``:
+
+.. code-block:: yaml
+
+    # for RTEMS IOCS this is the PVC name for the filesystem where RTEMS
+    # IOCs look for their files - enable this in RTEMS IOCs only
+    nfsv2TftpClaim: bl01t-ioc-files-claim
+
 You are now ready to deploy the IOC instance to the cluster and test it out.