deploy: 769f1b4

epics-containers · Feb 19, 2024 · fcff4b0 · fcff4b0
1 parent 5117a5b
commit fcff4b0
Show file tree

Hide file tree

Showing 25 changed files with 25 additions and 25 deletions.
diff --git a/main/.doctrees/explanations/introduction.doctree b/main/.doctrees/explanations/introduction.doctree
diff --git a/main/.doctrees/explanations/kubernetes_cluster.doctree b/main/.doctrees/explanations/kubernetes_cluster.doctree
diff --git a/main/.doctrees/overview.doctree b/main/.doctrees/overview.doctree
diff --git a/main/.doctrees/reference/cli.doctree b/main/.doctrees/reference/cli.doctree
diff --git a/main/.doctrees/reference/ioc_helm_chart.doctree b/main/.doctrees/reference/ioc_helm_chart.doctree
diff --git a/main/.doctrees/reference/k8s_resources.doctree b/main/.doctrees/reference/k8s_resources.doctree
diff --git a/main/.doctrees/tutorials/create_ioc.doctree b/main/.doctrees/tutorials/create_ioc.doctree
diff --git a/main/.doctrees/tutorials/deploy_example.doctree b/main/.doctrees/tutorials/deploy_example.doctree
diff --git a/main/.doctrees/tutorials/dev_container.doctree b/main/.doctrees/tutorials/dev_container.doctree
diff --git a/main/.doctrees/tutorials/rtems_ioc.doctree b/main/.doctrees/tutorials/rtems_ioc.doctree
diff --git a/main/.doctrees/tutorials/setup_k8s_new_beamline.doctree b/main/.doctrees/tutorials/setup_k8s_new_beamline.doctree
diff --git a/main/_sources/reference/ioc_helm_chart.md.txt b/main/_sources/reference/ioc_helm_chart.md.txt
@@ -33,7 +33,7 @@ in this folder and what you would need to change in your new IOC instance:
 - `values.yaml` - this is the helm values file. It contains the values that
   are substituted in to the helm templates when the helm chart is built. Most
   of the values that go into an IOC instance chart will be drawn from
-  domain defaults which can be found in the folder `beamline-chart`. Values
+  repository defaults which can be found in the folder `helm/shared`. Values
   you need to supply here are:
 
   - `base_image` - the Generic IOC image to use for this IOC instance. A

diff --git a/main/_sources/reference/k8s_resources.md.txt b/main/_sources/reference/k8s_resources.md.txt
@@ -16,9 +16,9 @@ ec template services/bl01t-ea-ioc-01
 ```
 
 This is expanding the local helm chart in the `services/bl01t-ea-ioc-01` folder and using
-its `templates/ioc.yaml` plus the templates in `helm-ioc-lib`. These templates
+its `config/ioc.yaml` plus the templates in `helm-ioc-lib`. These templates
 are expanded using the values in the `services/bl01t-ea-ioc-01/values.yaml` file and also
-`beamline-chart/values.yaml` and finally the default `values.yaml` file
+`helm/shared/values.yaml` and finally the default `values.yaml` file
 from the helm-ioc-lib.
 
 For a description of the key resources we create in this Kubernetes manifest

diff --git a/main/_sources/tutorials/create_ioc.md.txt b/main/_sources/tutorials/create_ioc.md.txt
@@ -10,6 +10,7 @@ For this tutorial some familiarity with the EPICS AreaDetector framework
 is useful. Take a look at this documentation if you have not yet come
 across AreaDetector: <https://areadetector.github.io/master/index.html>.
 
+(create-new-ioc-instance)=
 ## Create a New IOC Instance
 
 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 items:

diff --git a/main/_sources/tutorials/deploy_example.md.txt b/main/_sources/tutorials/deploy_example.md.txt
@@ -77,6 +77,7 @@ source $HOME/ec-venv/bin/activate # DLS users don't need this step
 source bl01t
 ```
 
+(deploy-example-instance)=
 ## Deploy the Example IOC Instance
 
 For this section we will be making use of the epics-containers-cli tool.

diff --git a/main/_sources/tutorials/dev_container.md.txt b/main/_sources/tutorials/dev_container.md.txt
@@ -19,7 +19,7 @@ which appear in the `iocs` folder of an {any}`ec-services-repo`. e.g.:
 - for Kubernetes: the values.yaml can override any settings used by helm
   so these can also be adjusted on a per IOC instance basis.
 - for Kubernetes: changes to the global values.yaml
-  file found in `beamline-chart`, these affect all IOCs in the repository.
+  file found in `helm/shared`, these affect all IOCs in the repository.
 
 (changes_2)=
 ### Changing the Generic IOC

diff --git a/main/_sources/tutorials/setup_k8s_new_beamline.md.txt b/main/_sources/tutorials/setup_k8s_new_beamline.md.txt
@@ -87,7 +87,7 @@ DLS Users: These instructions are for the BL46P beamline. This beamline is a tra
 
 # Review the New Beamline Repository
 
-The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template.
+The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template to talk to the p46-iocs namespace on pollux cluster. If you believe your repo is already configured to talk to your cluster then you could jump ahead to [](create-test-ioc-k8s).
 
 
 ## Cluster Topologies
@@ -231,10 +231,9 @@ For this reason most IOC instances only need supply the `image` setting
 which specifies the Generic IOC container image to use.
 
 Before making the first IOC instance we need to set up the beamline defaults.
-These are all held in the file `beamline-chart/values.yaml`.
+These are all held in the file `helm/shared/values.yaml`.
 
-Open this file and make the following changes depending on your beamline
-type.
+Open this file and make the following changes depending on your beamline type. (Note that the new `ec-services-template` will have already set up the values below for you, assuming you are looking at one of the cluster types supported by it.)
 
 ### All cluster types
 
@@ -281,12 +280,12 @@ dataVolume:
   # point at the shared filesystem data folder for the beamline
   hostPath: /dls/p46/data
 ```
-
+(create-test-ioc-k8s)=
 # Create a Test IOC to Deploy
 
-TODO: WIP (but this looks just like it did in the first IOC deployment tutorial).
+TODO: This is work in progress (but essentially just repeat what we did in [](deploy-example-instance)).
 
-Essentially you should be able to deploy `bl01t-ea-test-02` to the k3s cluster with the same command as before:
+You should be able to deploy `bl01t-ea-test-02` IOC that you made in [](create-new-ioc-instance) to the k3s cluster with the same command as before:
 
 ```bash
 cd bl01t

diff --git a/main/objects.inv b/main/objects.inv
diff --git a/main/reference/ioc_helm_chart.html b/main/reference/ioc_helm_chart.html
@@ -522,7 +522,7 @@ <h2>Examine the Example IOC Instance<a class="headerlink" href="#examine-the-exa
 <li><p><code class="docutils literal notranslate"><span class="pre">values.yaml</span></code> - this is the helm values file. It contains the values that
 are substituted in to the helm templates when the helm chart is built. Most
 of the values that go into an IOC instance chart will be drawn from
-domain defaults which can be found in the folder <code class="docutils literal notranslate"><span class="pre">beamline-chart</span></code>. Values
+repository defaults which can be found in the folder <code class="docutils literal notranslate"><span class="pre">helm/shared</span></code>. Values
 you need to supply here are:</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">base_image</span></code> - the Generic IOC image to use for this IOC instance. A

diff --git a/main/reference/k8s_resources.html b/main/reference/k8s_resources.html
@@ -503,9 +503,9 @@ <h2>Learning about Helm and Kubernetes Manifests<a class="headerlink" href="#lea
 </pre></div>
 </div>
 <p>This is expanding the local helm chart in the <code class="docutils literal notranslate"><span class="pre">services/bl01t-ea-ioc-01</span></code> folder and using
-its <code class="docutils literal notranslate"><span class="pre">templates/ioc.yaml</span></code> plus the templates in <code class="docutils literal notranslate"><span class="pre">helm-ioc-lib</span></code>. These templates
+its <code class="docutils literal notranslate"><span class="pre">config/ioc.yaml</span></code> plus the templates in <code class="docutils literal notranslate"><span class="pre">helm-ioc-lib</span></code>. These templates
 are expanded using the values in the <code class="docutils literal notranslate"><span class="pre">services/bl01t-ea-ioc-01/values.yaml</span></code> file and also
-<code class="docutils literal notranslate"><span class="pre">beamline-chart/values.yaml</span></code> and finally the default <code class="docutils literal notranslate"><span class="pre">values.yaml</span></code> file
+<code class="docutils literal notranslate"><span class="pre">helm/shared/values.yaml</span></code> and finally the default <code class="docutils literal notranslate"><span class="pre">values.yaml</span></code> file
 from the helm-ioc-lib.</p>
 <p>For a description of the key resources we create in this Kubernetes manifest
 see the next heading.</p>

diff --git a/main/searchindex.js b/main/searchindex.js
diff --git a/main/tutorials/create_ioc.html b/main/tutorials/create_ioc.html
@@ -508,7 +508,7 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this h
 across AreaDetector: <a class="reference external" href="https://areadetector.github.io/master/index.html">https://areadetector.github.io/master/index.html</a>.</p>
 </section>
 <section id="create-a-new-ioc-instance">
-<h2>Create a New IOC Instance<a class="headerlink" href="#create-a-new-ioc-instance" title="Link to this heading">#</a></h2>
+<span id="create-new-ioc-instance"></span><h2>Create a New IOC Instance<a class="headerlink" href="#create-a-new-ioc-instance" title="Link to this heading">#</a></h2>
 <p>To create a new IOC Instance simply add a new folder to the <code class="docutils literal notranslate"><span class="pre">services</span></code> folder in your beamline repo. The name of the folder will be the name of the IOC. This folder needs to contain these items:</p>
 <table class="table">
 <thead>

diff --git a/main/tutorials/deploy_example.html b/main/tutorials/deploy_example.html
@@ -565,7 +565,7 @@ <h2>Set up Environment for BL01T Beamline<a class="headerlink" href="#set-up-env
 </div>
 </section>
 <section id="deploy-the-example-ioc-instance">
-<h2>Deploy the Example IOC Instance<a class="headerlink" href="#deploy-the-example-ioc-instance" title="Link to this heading">#</a></h2>
+<span id="deploy-example-instance"></span><h2>Deploy the Example IOC Instance<a class="headerlink" href="#deploy-the-example-ioc-instance" title="Link to this heading">#</a></h2>
 <p>For this section we will be making use of the epics-containers-cli tool.
 This command line entry point for the tool is <code class="docutils literal notranslate"><span class="pre">ec</span></code>. For more
 details see: <a class="reference internal" href="../reference/cli.html#cli"><span class="std std-ref">Command Line Interface for IOC Management</span></a> or try <code class="docutils literal notranslate"><span class="pre">ec</span> <span class="pre">--help</span></code>.</p>

diff --git a/main/tutorials/dev_container.html b/main/tutorials/dev_container.html
@@ -513,7 +513,7 @@ <h1>Developer Containers<a class="headerlink" href="#developer-containers" title
 <li><p>for Kubernetes: the values.yaml can override any settings used by helm
 so these can also be adjusted on a per IOC instance basis.</p></li>
 <li><p>for Kubernetes: changes to the global values.yaml
-file found in <code class="docutils literal notranslate"><span class="pre">beamline-chart</span></code>, these affect all IOCs in the repository.</p></li>
+file found in <code class="docutils literal notranslate"><span class="pre">helm/shared</span></code>, these affect all IOCs in the repository.</p></li>
 </ul>
 </section>
 <section id="changing-the-generic-ioc">

diff --git a/main/tutorials/setup_k8s_new_beamline.html b/main/tutorials/setup_k8s_new_beamline.html
@@ -577,7 +577,7 @@ <h2>Create a new beamline repository<a class="headerlink" href="#create-a-new-be
 </section>
 <section id="review-the-new-beamline-repository">
 <h1>Review the New Beamline Repository<a class="headerlink" href="#review-the-new-beamline-repository" title="Link to this heading">#</a></h1>
-<p>The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template.</p>
+<p>The following sections are just a review of what the template project created. Those of you who are outside of DLS can use this as a guide to what you need to set up in your own beamline repository to talk you your own cluster. DLS users will already have these things set up by the copier template to talk to the p46-iocs namespace on pollux cluster. If you believe your repo is already configured to talk to your cluster then you could jump ahead to <a class="reference internal" href="#create-test-ioc-k8s"><span class="std std-ref">Create a Test IOC to Deploy</span></a>.</p>
 <section id="cluster-topologies">
 <h2>Cluster Topologies<a class="headerlink" href="#cluster-topologies" title="Link to this heading">#</a></h2>
 <p>There are two supported topologies for beamline clusters:</p>
@@ -698,9 +698,8 @@ <h2>Setting up the Beamline Helm Chart Defaults<a class="headerlink" href="#sett
 For this reason most IOC instances only need supply the <code class="docutils literal notranslate"><span class="pre">image</span></code> setting
 which specifies the Generic IOC container image to use.</p>
 <p>Before making the first IOC instance we need to set up the beamline defaults.
-These are all held in the file <code class="docutils literal notranslate"><span class="pre">beamline-chart/values.yaml</span></code>.</p>
-<p>Open this file and make the following changes depending on your beamline
-type.</p>
+These are all held in the file <code class="docutils literal notranslate"><span class="pre">helm/shared/values.yaml</span></code>.</p>
+<p>Open this file and make the following changes depending on your beamline type. (Note that the new <code class="docutils literal notranslate"><span class="pre">ec-services-template</span></code> will have already set up the values below for you, assuming you are looking at one of the cluster types supported by it.)</p>
 <section id="all-cluster-types">
 <h3>All cluster types<a class="headerlink" href="#all-cluster-types" title="Link to this heading">#</a></h3>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">beamline</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bl46p</span>
@@ -750,9 +749,9 @@ <h3>DLS real beamlines<a class="headerlink" href="#dls-real-beamlines" title="Li
 </section>
 </section>
 <section id="create-a-test-ioc-to-deploy">
-<h1>Create a Test IOC to Deploy<a class="headerlink" href="#create-a-test-ioc-to-deploy" title="Link to this heading">#</a></h1>
-<p>TODO: WIP (but this looks just like it did in the first IOC deployment tutorial).</p>
-<p>Essentially you should be able to deploy <code class="docutils literal notranslate"><span class="pre">bl01t-ea-test-02</span></code> to the k3s cluster with the same command as before:</p>
+<span id="create-test-ioc-k8s"></span><h1>Create a Test IOC to Deploy<a class="headerlink" href="#create-a-test-ioc-to-deploy" title="Link to this heading">#</a></h1>
+<p>TODO: This is work in progress (but essentially just repeat what we did in <a class="reference internal" href="deploy_example.html#deploy-example-instance"><span class="std std-ref">Deploy the Example IOC Instance</span></a>).</p>
+<p>You should be able to deploy <code class="docutils literal notranslate"><span class="pre">bl01t-ea-test-02</span></code> IOC that you made in <a class="reference internal" href="create_ioc.html#create-new-ioc-instance"><span class="std std-ref">Create a New IOC Instance</span></a> to the k3s cluster with the same command as before:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>bl01t
 <span class="nb">source</span><span class="w"> </span>environment.sh
 ec<span class="w"> </span>local/deploy<span class="w"> </span>services/bl01t-ea-test-02