Skip to content

Commit 9e10ccd

Browse files
committed
tidy manage IOCs page
1 parent 0397d1d commit 9e10ccd

File tree

2 files changed

+44
-28
lines changed

2 files changed

+44
-28
lines changed

docs/tutorials/deploy_example.rst

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,23 @@ To deploy the helm chart into your cluster::
3636

3737
k8s-ioc deploy example 0.1
3838

39+
It may take a while for the first launch because Kubernetes needs to pull
40+
the generic IOC image from the repository. The following command will give
41+
details of the resources associated with the example IOC::
3942

40-
Learning about Helm and Kubernetes Manifests
41-
--------------------------------------------
42-
43-
It is instructive to see what helm is doing when you execute the above
44-
command.
45-
46-
Helm uses templates to generate a set of YAML resources and applies them
47-
to the cluster using kubectl.
48-
49-
We are using a helm library defined in
50-
https://github.com/epics-containers/helm-ioc-lib. You can see the templates
51-
it is using in its templates folder.
52-
53-
The example ioc folder itself has a templates folder containing the ioc.yaml
54-
template. This includes all of the templates from helm-ioc-lib and
55-
also generates a ConfigMap resource from the files in the config folder.
43+
k8s-ioc list example
5644

57-
To see the YAML that helm is generating you can use the following commands::
45+
When the output looks like this, your IOC is running::
5846

59-
cd bl00i
60-
helm dependency update iocs/example/
61-
helm template example iocs/example
47+
NAME READY STATUS RESTARTS AGE
48+
pod/example-6779d4dcf-g2cpm 1/1 Running 0 50s
6249

63-
This is using the helm chart in your local filesystem rather than the one
64-
that we pushed to the registry so this is useful for your inner dev loop
65-
testing. You can also deploy directly from the local copy with this
66-
command::
50+
NAME READY UP-TO-DATE AVAILABLE AGE
51+
deployment.apps/example 1/1 1 1 50s
6752

68-
helm upgrade --install example iocs/example
53+
NAME DESIRED CURRENT READY AGE
54+
replicaset.apps/example-6779d4dcf 1 1 1 50s
6955

70-
This is recommended for testing only since you won't easily be able to track
71-
versions deployed in this way.
7256

7357
Launching a GUI to interact with your IOC
7458
-----------------------------------------
@@ -97,3 +81,35 @@ The main screen of the edm OPI should look like this.
9781

9882
.. image:: ../images/edm_pco.png
9983
:align: center
84+
85+
Learning about Helm and Kubernetes Manifests
86+
--------------------------------------------
87+
88+
It is instructive to see what helm is doing when you deploy the example IOC.
89+
90+
Helm uses templates to generate a set of YAML resources and applies them
91+
to the cluster using kubectl.
92+
93+
We are using a helm library defined in
94+
https://github.com/epics-containers/helm-ioc-lib. You can see the templates
95+
it is using in its templates folder.
96+
97+
The example ioc folder itself has a templates folder containing the ioc.yaml
98+
template. This includes all of the templates from helm-ioc-lib and
99+
also generates a ConfigMap resource from the files in the config folder.
100+
101+
To see the YAML that helm is generating you can use the following commands::
102+
103+
cd bl00i
104+
helm dependency update iocs/example/
105+
helm template example iocs/example
106+
107+
This is using the helm chart in your local filesystem rather than the one
108+
that we pushed to the registry so this is useful for your inner dev loop
109+
testing. You can also deploy directly from the local copy with this
110+
command::
111+
112+
helm upgrade --install example iocs/example
113+
114+
This is recommended for testing only since you won't easily be able to track
115+
versions deployed in this way.

docs/tutorials/manage_iocs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To get the current logs for the example IOC::
5050

5151
k8s-ioc log example
5252

53-
Monitor your beamline IOCs
53+
Monitor your beamline IOCs::
5454

5555
k8s-ioc monitor blxxi
5656

0 commit comments

Comments
 (0)