You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/create_beamline.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ assets. See `../explanations/repositories`.
51
51
52
52
## Steps
53
53
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'.
55
55
56
56
If you are using an alternative to GitHub for your repositories then
57
57
see [these instructions] for an alternative approach.
@@ -61,7 +61,7 @@ assets. See `../explanations/repositories`.
61
61
```bash
62
62
pip install copier
63
63
# this will create the folder bl01t in the current directory
Copy file name to clipboardExpand all lines: docs/tutorials/create_ioc.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,20 +12,13 @@ across AreaDetector: <https://areadetector.github.io/master/index.html>.
12
12
13
13
## Create a New IOC Instance
14
14
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:
18
16
19
17
```{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>`_.
**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.
Copy file name to clipboardExpand all lines: docs/tutorials/deploy_example.md
+1-8Lines changed: 1 addition & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -164,14 +164,7 @@ bl01t-ea-test-01 2024.2.1 Up 4 seconds ghcr.io/epics-contai
164
164
165
165
### IMPORTANT: deploy-local vs deploy
166
166
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.
175
168
176
169
Always strive to have released versions of IOC instances deployed in your
177
170
environments. `deploy-local` is only for temporary testing purposes.
0 commit comments