Merge pull request #111 from epics-containers/march-update

March update

Author: gilesknap

docs/tutorials/create_beamline.md

@@ -104,8 +104,8 @@ You can now give your repository a version tag like this:
 
 ```bash
 # open a terminal in vscode: Menu -> Terminal -> New Terminal
-git tag 2024.2.1
-git push origin 2024.2.1
+git tag 2024.3.1
+git push origin 2024.3.1
 ```
 
 We use `CalVer` version numbers for beamline repositories and Generic IOCs.
@@ -116,7 +116,7 @@ CalVer is described here: <https://calver.org/> and is used where semantic
 versioning is not appropriate because the repository contains a mix of
 dependencies and does not have a clear API.
 
-Note that 2024.2.1 represents the time that this tutorial was last updated.
+Note that 2024.3.1 represents the time that this tutorial was last updated.
 For completeness you could use the current year and month instead. You
 are also free to choose your own versioning scheme as this is not enforced by
 any of the epics-containers tools.

docs/tutorials/create_ioc.md

@@ -27,12 +27,11 @@ The Chart.yaml is a helm chart description file. We will use the same Chart.yaml
 
 | | |
 | --- | ---
-| **helm/shared** | A sub-chart that contains the default values.yaml file for all IOC instances in the beamline repository. It in turn references a further sub-chart that consumes these values: the `ioc-instance` chart that crafts up the Kubernetes manifest for deploying IOC instances |
-| **helm/configmap** | A sub-chart that transforms the IOC Instance's config folder files into a Kubernetes ConfigMap to be included in the manifest and mounted into the Generic IOC container at runtime.
+| **helm/shared** | A sub-chart that contains the default values.yaml file for all services in the beamline repository. It in turn references a further sub-chart that consumes these values: the `ioc-instance` chart that crafts up the Kubernetes manifest for deploying IOC instances |
+| **include/iocs** | A sub-chart that transforms the IOC Instance's config folder files into a Kubernetes ConfigMap to be included in the manifest and mounted into the Generic IOC container at runtime.
 
 Because all IOC Instances in the beamline repository share the same Chart.yaml file, we will create a soft-link to it in the IOC Instance folder. This is so that updates to the Chart.yaml file will propagate to all IOC Instances in the beamline. To do this run the following command:
 
-
 ```bash
 cd bl01t # if not already there
 # create the new IOC Instance folder
@@ -51,9 +50,10 @@ code services/bl01t-ea-test-02/values.yaml
 ```
 
 You will now have vscode and open and editing the values.yaml file. Add the following:
-
 ```yaml
-image: ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2024.2.2
+shared:
+  ioc-instance:
+    image: ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2024.2.1
 ```
 
 This tells the IOC Instance to run in the `ioc-adsimdetector-linux-runtime`
@@ -187,7 +187,7 @@ entities:
 
 :::{note}
 If you are unfamiliar with YAML then you could take a look at
-the YAML spec here: <https://yaml.org/spec/1.2/spec.html#id2759963>.
+the YAML spec here: <https://yaml.org/spec/1.2.2/>.
 
 Be aware that white space is significant. i.e. indentation represents
 nesting. Above we have a list of entities, each list item is denoted by

docs/tutorials/deploy_example.md

@@ -112,8 +112,9 @@ number to indicate that they are not permanent.
 You can now see the beta IOC instance running with:
 
 <pre>$ ec ps
-            name          version   state                                                             image
-bl01t-ea-test-01 2024.2.16-b15.11 running ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2024.2.1</pre>
+| name             | version       | running | restarts | deployed            |
+|------------------|---------------|---------|----------|---------------------|
+| bl01t-ea-test-01 | 2024.3.8e8b-b | true    | 0        | 2024-03-19 10:08:15 |</pre>
 
 At the end of the last tutorial we tagged the beamline repository with a
 `CalVer` version number and pushed it up to GitHub. This means that we
@@ -123,8 +124,9 @@ command lists all of the tagged versions of the IOC instance that are
 available in the GitHub repository.
 
 <pre>$ ec instances bl01t-ea-test-01
-Available instances for bl01t-ea-test-01:
-2024.2.1
+| version  |
+|----------|
+| 2024.3.1 |
 </pre>
 
 :::{note}
@@ -142,9 +144,8 @@ ec supports command line completion, which means that entering `<tab> <tab>` wil
 $ ec <tab> <tab>
 attach        deploy        exec          list          logs          start         template
 delete        deploy-local  instances     log-history   restart       stop          validate
-$ ec instances <tab> <tab>
-$ ec instances bl01t-ea-ioc-0 <tab> <tab>
-bl01t-ea-test-01  bl01t-ea-test-02
+$ ec instances b<tab> <tab>
+$ ec instances bl01t-ea-ioc-01
 ```
 
 To enable this behavior in your shell run the command `ec --install-completion`
@@ -155,12 +156,13 @@ This command will extract the IOC instance using the tag from GitHub and deploy
 it to your local machine:
 
 ```bash
-$ ec deploy bl01t-ea-test-01 2024.2.1
+$ ec deploy bl01t-ea-test-01 2024.3.1
 bdbd155d437361fe88bce0faa0ddd3cd225a9026287ac5e73545aeb4ab3a67e9
 
-$ ec ps
-IOC NAME            VERSION             STATUS              IMAGE
-bl01t-ea-test-01     2024.2.1           Up 4 seconds        ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2023.10.5
+$ ec ps -w
+| name             | version  | running | restarts | deployed            | image                                                             |
+|------------------|----------|---------|----------|---------------------|-------------------------------------------------------------------|
+| bl01t-ea-test-01 | 2024.3.1 | true    | 0        | 2024-03-19 11:10:53 | ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2024.2.1 |
 ```
 
 ### IMPORTANT: deploy-local vs deploy

docs/tutorials/ioc_changes1.md

@@ -35,7 +35,7 @@ Make the following changes in your test IOC config folder
    }
    ```
 
-2. Add the following lines to the end `ioc.yaml` (verify that the indentation
+2. Add the following lines to the end of `ioc.yaml` (verify that the indentation
    matches the above entry so that `- type:` statements line up):
 
    ```yaml
@@ -86,10 +86,10 @@ git add .
 git commit -m "Added extra.db"
 git push
 # tag a new version of the beamline repo
-git tag 2023.11.2
-git push origin 2023.11.2
+git tag 2024.3.2
+git push origin 2024.3.2
 # deploy the new version of the IOC to the local docker / podman instance
-ec deploy bl01t-ea-test-02 2023.11.2
+ec deploy bl01t-ea-test-02 2024.3.2
 ```
 
 You can now see that the versioned IOC instance is running and loading the extra.db by looking at its log with: