Skip to content

Commit 599a6f1

Browse files
committed
tutorial fixes done up to "Create IOC Instance"
1 parent d8c2692 commit 599a6f1

File tree

6 files changed

+25
-37
lines changed

6 files changed

+25
-37
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,6 @@ lockfiles/
6868

6969
# ruff cache
7070
.ruff_cache/
71+
72+
# workspace files
73+
**/*.code-workspace

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
version = "1.0"
1515

1616
# General information about the project.
17-
project = "epics-containers.github.io"
17+
project = "epics-containers"
1818

1919
extensions = [
2020
# Use this for generating API docs

docs/tutorials/create_beamline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ assets. See `../explanations/repositories`.
5151

5252
## Steps
5353

54-
1. Go to your GitHub account home page. Click on 'Repositories' and then 'New', give your new repository the name `bl01t` plus a description, then click 'Create'.
54+
1. Go to your GitHub account home page. Click on 'Repositories' and then 'New', give your new repository the name `bl01t` plus a description, then click 'Create repository'.
5555

5656
If you are using an alternative to GitHub for your repositories then
5757
see [these instructions] for an alternative approach.
@@ -61,7 +61,7 @@ assets. See `../explanations/repositories`.
6161
```bash
6262
pip install copier
6363
# this will create the folder bl01t in the current directory
64-
copier copy gh:epics-containers/ec/services-template --trust bl01t
64+
copier copy gh:epics-containers/ec-services-template --trust bl01t
6565
```
6666
1. Answer the copier template questions as follows:
6767

docs/tutorials/create_ioc.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,13 @@ across AreaDetector: <https://areadetector.github.io/master/index.html>.
1212

1313
## Create a New IOC Instance
1414

15-
To create a new IOC Instance simply add a new folder to the `iocs` folder
16-
in your beamline repo. The name of the folder will be the name of the IOC.
17-
This folder needs to contain these two items:
15+
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 two items:
1816

1917
```{eval-rst}
20-
21-
:config:
22-
23-
a folder that contains the IOC configuration files. The configuration
24-
can take a number of forms
25-
`listed here <https://github.com/epics-containers/ibek/blob/ea9da7e1cfe88f2a300ad236f820221837dd9dcf/src/ibek/templates/ioc/config/start.sh>`_.
26-
27-
values.yaml
28-
~~~~~~~~~~~~~~~~~~~~~~~
18+
=================== =======================================================
19+
**config** A folder that contains the IOC configuration files. The configuration can take a number of forms [listed here](https://github.com/epics-containers/ioc-template/blob/main/ioc/start.sh).
20+
**values.yaml** A helm chart values override file. The only required field is ``image`` which determines which Generic IOC container the IOC Instance will run in. However, any other fields in the helm chart values file can be overridden on a per IOC instance basis in this file. See the shared values.yaml file in the ``helm/shared`` folder for a complete list of fields that can be overridden.
21+
=================== =======================================================
2922
```
3023

3124
### values.yaml
@@ -49,10 +42,10 @@ container. This container was built by the Generic IOC source repo here
4942
<https://github.com/epics-containers/ioc-adsimdetector>. The container has
5043
support for AreaDetector and ADSimDetector compiled into its IOC binary.
5144

52-
Generic IOCs have compiled IOC binaries and `dbd` files but no startup script or
45+
Generic services have compiled IOC binaries and `dbd` files but no startup script or
5346
EPICS database. The compiled IOC binary, `dbds` and support `lib` files
5447
are baked into the container at container build time. This means that the
55-
code for making IOCs for a given class of device need only be compiled once
48+
code for making services for a given class of device need only be compiled once
5649
and can be reused for many IOC Instances.
5750

5851
A startup script and EPICS Database are provided by the IOC Instance at
@@ -304,7 +297,7 @@ the c2dv viewer showing an image from the example IOC
304297

305298
Above we looked at some ibek *Support yaml* and created an *IOC yaml* file.
306299
The details of where *Support yaml* files come from and how to create your
307-
own are covered in later tutorials on creating Generic IOCs.
300+
own are covered in later tutorials on creating Generic services.
308301

309302
However, without looking into the set of *Support yaml* files that are
310303
inside a given Generic IOC we can still make a meaningful *IOC yaml* file.

docs/tutorials/deploy_example.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,7 @@ bl01t-ea-test-01 2024.2.1 Up 4 seconds ghcr.io/epics-contai
164164

165165
### IMPORTANT: deploy-local vs deploy
166166

167-
Be aware of the distinction of `deploy-local` vs `deploy`. Both of these
168-
commands create a running instance of the IOC in the target environment (currently
169-
your local machine - later on a Kubernetes Cluster). However, `deploy-local`
170-
gets the IOC instance description YAML direct from your local filesystem. This
171-
means it is not likely to be available for re-deployment later on. `deploy`
172-
gets the IOC instance description YAML from the GitHub repository with able
173-
specific tag and therefore is a known state that can be recovered at a later
174-
date.
167+
Be aware of the distinction of `deploy-local` vs `deploy`. Both of these commands create a running instance of the IOC in the target environment (currently your local machine - later on a Kubernetes Cluster). However, `deploy-local` gets the IOC instance description YAML direct from your local filesystem. This means it is not likely to be available for re-deployment later on. `deploy` gets the IOC instance description YAML from the GitHub repository with a specific tag and therefore is a known state that can be recovered at a later date.
175168

176169
Always strive to have released versions of IOC instances deployed in your
177170
environments. `deploy-local` is only for temporary testing purposes.

docs/tutorials/intro.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,16 @@ and should be possible to work through without any prior knowledge.
99
However, to get the most out of the tutorials it would be best to start with
1010
some background in the following topics.
1111

12-
- An introduction to containers <https://www.docker.com/resources/what-container/>
13-
- Managing containers on a workstation: introduction to docker
14-
<https://docs.docker.com/get-started/overview/>
15-
- Podman, a recommended docker alternative
16-
<https://docs.podman.io/en/latest/Introduction.html>
17-
- Orchestrating containers in a cluster with Kubernetes
18-
<https://kubernetes.io/docs/concepts/overview/>
19-
- Managing packages in a Kubernetes Cluster with Helm
20-
<https://helm.sh/docs/intro/quickstart/>
21-
- Introduction to EPICS
22-
<https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html>
12+
```{eval-rst}
13+
================================================================ ================
14+
**An introduction to containers** <https://www.docker.com/resources/what-container/>
15+
**Managing containers on a workstation: introduction to docker** <https://docs.docker.com/get-started/overview/>
16+
**Podman, a recommended docker alternative** <https://docs.podman.io/en/latest/Introduction.html>
17+
**Orchestrating containers in a cluster with Kubernetes** <https://kubernetes.io/docs/concepts/overview/>
18+
**Managing packages in a Kubernetes Cluster with Helm** <https://helm.sh/docs/intro/quickstart/>
19+
**Introduction to EPICS** <https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html>
20+
================================================================ ================
21+
```
2322

2423
With the above background in hand you should then read the overview of
2524
epics-containers architecture here: {any}`../explanations/introduction`

0 commit comments

Comments
 (0)