Skip to content

Commit a1acdaf

Browse files
committed
add beamline resources section
1 parent 961da9a commit a1acdaf

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

docs/user/tutorials/setup_k8s_new_beamline.rst

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ on a node unless the pod has a matching toleration.
125125
For example the test beamline p46 at DLS has the following ``taints`` and
126126
``labels``:
127127

128-
.. code block::
128+
.. code-block::
129129
130130
Labels: beamline=bl46p
131131
nodetype=test-rig
@@ -165,12 +165,12 @@ but here we will configure it to use the beamline cluster.
165165
For the detail of what goes into ``environment.sh`` see
166166
`../reference/environment`.
167167

168-
edit ``environment.sh`` make changes as follows:
168+
Now edit ``environment.sh`` make changes as follows:
169169

170170
Section 1
171171
~~~~~~~~~
172172

173-
to set the following variables:
173+
Change this section to set the following variables:
174174

175175
.. code-block:: bash
176176
@@ -193,6 +193,9 @@ useful to set up command line completion up. The simplest way to do this is:
193193
set -e # exit on error
194194
source <(ec --show-completion ${SHELL})
195195
196+
For a review of how to set up the epics-containers-cli tool ``ec`` see
197+
`python_setup` and `ec`.
198+
196199
Section 3
197200
~~~~~~~~~
198201

@@ -225,8 +228,9 @@ will be asked for your credentials if required.
225228
Setting up the Beamline Helm Chart Defaults
226229
-------------------------------------------
227230

228-
The beamline helm chart is used to deploy IOCs to the cluster. Each IOC
229-
gets to override any of the settings available in the chart. However, all
231+
The beamline helm chart is used to deploy IOCs to the cluster. Each IOC instance
232+
gets to override any of the settings available in the chart. This is done
233+
in ``iocs/<iocname>/values.yaml`` for each IOC instance. However, all
230234
settings except ``image`` have default values supplied at the beamline level.
231235
For this reason most IOC instances only need supply the ``image`` setting
232236
which specifies the Generic IOC container image to use.
@@ -287,6 +291,25 @@ DLS real beamlines
287291
# point at the shared filesystem data folder for the beamline
288292
hostPath: /dls/p46/data
289293
294+
Set Up The One Time Only Beamline Resources
295+
-------------------------------------------
296+
297+
There are two scripts in the ``services`` directory that set up some initial
298+
resources. You should run each of these in order:
299+
300+
- ``services/install-pvcs.sh``: this sets up some persistent volume claims for
301+
the beamline. PVCS are Kubernetes managed chunks of storage that can be
302+
shared between pods if required. The 3 PVCS created here relate to the
303+
``Claim`` entries in the ``beamline-chart/values.yaml`` file. These are
304+
places to store:
305+
- autosave files
306+
- runtime generated startup scripts and EPICS database files
307+
- OPI screens (usually auto generated)
308+
- ``services/install-opi.sh``: this sets up an nginx web server for the
309+
beamline. It serves the OPI screens from the ``opisClaim`` PVC. Each IOC
310+
instance will place its OPI screens in a subdirectory of this PVC.
311+
OPI clients like phoebus can then retrieve these files via HTTP.
312+
290313
Create a Test IOC to Deploy
291314
---------------------------
292315

0 commit comments

Comments
 (0)