Merge pull request #94 from epics-containers/md

tidy up new-k8s-beamline tutorial

Author: gilesknap

docs/reference/ioc_helm_chart.md

@@ -33,7 +33,7 @@ in this folder and what you would need to change in your new IOC instance:
 - `values.yaml` - this is the helm values file. It contains the values that
   are substituted in to the helm templates when the helm chart is built. Most
   of the values that go into an IOC instance chart will be drawn from
-  domain defaults which can be found in the folder `beamline-chart`. Values
+  repository defaults which can be found in the folder `helm/shared`. Values
   you need to supply here are:
 
   - `base_image` - the Generic IOC image to use for this IOC instance. A

docs/reference/k8s_resources.md

@@ -16,9 +16,9 @@ ec template services/bl01t-ea-ioc-01
 ```
 
 This is expanding the local helm chart in the `services/bl01t-ea-ioc-01` folder and using
-its `templates/ioc.yaml` plus the templates in `helm-ioc-lib`. These templates
+its `config/ioc.yaml` plus the templates in `helm-ioc-lib`. These templates
 are expanded using the values in the `services/bl01t-ea-ioc-01/values.yaml` file and also
-`beamline-chart/values.yaml` and finally the default `values.yaml` file
+`helm/shared/values.yaml` and finally the default `values.yaml` file
 from the helm-ioc-lib.
 
 For a description of the key resources we create in this Kubernetes manifest

docs/tutorials/create_ioc.md

@@ -10,6 +10,7 @@ For this tutorial some familiarity with the EPICS AreaDetector framework
 is useful. Take a look at this documentation if you have not yet come
 across AreaDetector: <https://areadetector.github.io/master/index.html>.
 
+(create-new-ioc-instance)=
 ## Create a New IOC Instance
 
 To create a new IOC Instance simply add a new folder to the `services` folder in your beamline repo. The name of the folder will be the name of the IOC. This folder needs to contain these items:

docs/tutorials/deploy_example.md

@@ -77,6 +77,7 @@ source $HOME/ec-venv/bin/activate # DLS users don't need this step
 source bl01t
 ```
 
+(deploy-example-instance)=
 ## Deploy the Example IOC Instance
 
 For this section we will be making use of the epics-containers-cli tool.

docs/tutorials/dev_container.md

@@ -19,7 +19,7 @@ which appear in the `iocs` folder of an {any}`ec-services-repo`. e.g.:
 - for Kubernetes: the values.yaml can override any settings used by helm
   so these can also be adjusted on a per IOC instance basis.
 - for Kubernetes: changes to the global values.yaml
-  file found in `beamline-chart`, these affect all IOCs in the repository.
+  file found in `helm/shared`, these affect all IOCs in the repository.
 
 (changes_2)=
 ### Changing the Generic IOC

docs/tutorials/setup_k8s_new_beamline.md

@@ -87,7 +87,7 @@ DLS Users: These instructions are for the BL46P beamline. This beamline is a tra
 
 # Review the New Beamline Repository
 
-The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template.
+The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template to talk to the p46-iocs namespace on pollux cluster. If you believe your repo is already configured to talk to your cluster then you could jump ahead to [](create-test-ioc-k8s).
 
 
 ## Cluster Topologies
@@ -231,10 +231,9 @@ For this reason most IOC instances only need supply the `image` setting
 which specifies the Generic IOC container image to use.
 
 Before making the first IOC instance we need to set up the beamline defaults.
-These are all held in the file `beamline-chart/values.yaml`.
+These are all held in the file `helm/shared/values.yaml`.
 
-Open this file and make the following changes depending on your beamline
-type.
+Open this file and make the following changes depending on your beamline type. (Note that the new `ec-services-template` will have already set up the values below for you, assuming you are looking at one of the cluster types supported by it.)
 
 ### All cluster types
 
@@ -281,12 +280,12 @@ dataVolume:
   # point at the shared filesystem data folder for the beamline
   hostPath: /dls/p46/data
 ```
-
+(create-test-ioc-k8s)=
 # Create a Test IOC to Deploy
 
-TODO: WIP (but this looks just like it did in the first IOC deployment tutorial).
+TODO: This is work in progress (but essentially just repeat what we did in [](deploy-example-instance)).
 
-Essentially you should be able to deploy `bl01t-ea-test-02` to the k3s cluster with the same command as before:
+You should be able to deploy `bl01t-ea-test-02` IOC that you made in [](create-new-ioc-instance) to the k3s cluster with the same command as before:
 
 ```bash
 cd bl01t