tidy readmes

README.md

@@ -3,12 +3,12 @@ BL47P Training Beamline
 
 Describes the K8S services that are deployed to the beamline local cluster.
 
-These should be deployed using k8s-containers-cli.
+These should be deployed using edge-containers-cli.
 
 For a manual deployment for test purposes:
 
 ```bash
 # this example for bl47p-ea-test-01
-rm $(find . -name *.lock) ;rm -r $(find . -name charts); helm dependency build helm/beamline/ ; helm dependency build services/bl47p-ea-test-01
-helm upgrade --install --version 0.1.1 bl47p-ea-test-01 services/bl47p-ea-test-01/
+./update-helm
+helm upgrade --install bl47p-ea-test-01 services/bl47p-ea-test-01/
 ```

environment.sh

@@ -57,3 +57,8 @@ if module --version &> /dev/null; then
 fi
 
 
+# enable shell completion for k8s tools
+source <(helm completion $(basename ${SHELL}))
+source <(kubectl completion $(basename ${SHELL}))
+
+

services/README.md

@@ -0,0 +1,20 @@
+Shared Services
+===============
+
+There are a number of helm charts that all domains will likely require. At present these are as follows:
+
+- **epics-pvcs**: sets up the PVCs that all IOCs may use. These should be set up once and not deleted as they hold data for IOCs. All of the PVCs have a folder hierarchy with the names of IOCs at the root.
+
+ - autosave data: for IOCs that support autosave. This is separate from IOC helm charts so that it can survive deletion and re-creation of an IOC.
+
+ - opis: all the OPI files for engineering screens that an IOC supplies are saved here. This is stored in a single PVC so that the opis service can publish them over http for access by an OPI client.
+
+- **epics-opis**: installs the web server that shares the engineering screens published by each IOC. The structure is two deep only: IOC names as folders at the root containing all the IOCs OPI files in a flat list.
+
+Deploy these charts to the beamline cluster using by setting up your cluster and namespace connection using environment.sh and then executing the following commands (requires that edge-containers-cli is installed):
+
+```bash
+ec list # lists the latest versions of all services
+ec deploy epics-pvcs VERSION
+ec deploy epics-opis VERSION
+```