Skip to content

Commit 5a2d0ed

Browse files
committed
move cluster info to explanations
1 parent 6cebee4 commit 5a2d0ed

File tree

7 files changed

+18
-8
lines changed

7 files changed

+18
-8
lines changed

docs/how-to/kubernetes_cluster.rst renamed to docs/explanations/kubernetes_cluster.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,29 @@ Cluster Options
66

77
Three cluster topology approaches were considered for this project.
88

9-
- **Separate Kubernetes cluster per beamline**. This could be as simple as
10-
a single server and the K3S installation described in
9+
:Cluster per beamline:
10+
This could be as simple as
11+
a single server: the K3S installation described in
1112
`setup_kubernetes` may be sufficient. The documentation at
1213
https://rancher.com/docs/k3s/ also details how to make a high availability
1314
cluster, requiring a minimum of 4 servers.
14-
15-
- **A Central Facility Cluster**. A central facility cluster that runs
15+
This approach keeps the configuration of the clusters quite straightforward
16+
but at the cost of having multiple separate clusters to maintain. Also
17+
it requires control plane servers for every beamline, whereas a centralized
18+
approach would only need a handful of control plane servers for the entire
19+
facility.
20+
21+
:Central Facility Cluster:
22+
A central facility cluster that runs
1623
all IOCs on its own nodes would keep everything centralized and provide
1724
economy of scale. However, there are significant issues with routing
1825
Channel Access, PVA and some device protocols to IOCs running in a
1926
different subnet to the beamline. DLS spent some time working around these
2027
issues but eventually abandoned this approach.
2128

22-
- **Central Cluster with Beamline nodes**. This approach uses the central
23-
cluster but adds beamline nodes that sit in the beamline itself,
29+
:Beamline Worker Nodes:
30+
This approach uses the central
31+
cluster but adds remote beamline nodes located in the beamline itself,
2432
connected to the beamline subnet. This has all the benefits of central
2533
management but is able to overcome the problems with protocol routing.
2634
The DLS argus cluster configuration described below is an example of

docs/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ About the documentation
5858
explanations/strategy
5959
explanations/whats_in
6060
explanations/net_protocols
61+
explanations/kubernetes_cluster
6162

6263
.. toctree::
6364
:caption: How-to Guides
@@ -67,7 +68,6 @@ About the documentation
6768
how-to/create_ioc
6869
how-to/generic_iocs
6970
how-to/debug
70-
how-to/kubernetes_cluster
7171

7272
.. rst-class:: no-margin-after-ul
7373

docs/reference/faq.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ IOC instance Helm Charts. However it is still possible to roll back an IOC
4040
version when the internet is not available.
4141

4242
That is because Helm keeps track of several versions of each chart it
43-
deploys, they are stored in the cluster itself.
43+
deploys, they are stored in the cluster itself (as ReplicaSets). By
44+
default the last 10 are saved.
4445

4546
It is also necessary Kubernetes to be able to pull the generic IOC image. If
4647
the beamline has only one Kubernetes worker node then the previous image will
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)