From 44800914c93c5a60c5f6e3c9b63661a4ed755f29 Mon Sep 17 00:00:00 2001 From: Jack Harper Date: Fri, 23 Jan 2026 10:38:22 +0000 Subject: [PATCH 1/3] correct ansible docs and make clear that playbook needs to be run before deploys --- doc/deployment/Creating-a-release.md | 2 +- doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/deployment/Creating-a-release.md b/doc/deployment/Creating-a-release.md index 03889ba8e..2bb23f2d8 100644 --- a/doc/deployment/Creating-a-release.md +++ b/doc/deployment/Creating-a-release.md @@ -60,7 +60,7 @@ is recent enough to include the most recent changes in the 1. Do the same for the `EPICS32` 32-bit build, replacing `EPICS` with `EPICS32` everywhere in the commands above. 1. Check release is now listed in [`https://control-svcs.isis.cclrc.ac.uk/git/?a=project_list;pf=releases`](https://control-svcs.isis.cclrc.ac.uk/git/?a=project_list;pf=releases) -1. Run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. +1. Run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) on any test machines which will be used for manual system testing. {#creating_release_testing_steps} diff --git a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md index e24e8b95c..d839348c2 100644 --- a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md +++ b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md @@ -4,6 +4,8 @@ This document describes the steps necessary to install/upgrade IBEX on an Instru ## Preparatory Steps for Client and Server +Before starting any manual deployments, run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. + - Inform the instrument scientist that you are going to upgrade the instrument in 5 minutes so that they are not surprised when you remote desktop to the instrument, include a link to the release notes of the latest release in this email. Wait 5 minutes. - Make sure that `\\isis\shares\ISIS_Experiment_Controls_Public\ibex_utils` is pointing at `master` and is up to date (i.e. do git pull). - Take over the instrument with an RDP session - not VNC. From a0a32d0d6c18c364df87a076bbcbe7406a22c034 Mon Sep 17 00:00:00 2001 From: Jack Harper Date: Fri, 23 Jan 2026 11:01:53 +0000 Subject: [PATCH 2/3] add note on deploy group prompt --- doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md index d839348c2..6cfc1da3c 100644 --- a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md +++ b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md @@ -4,7 +4,7 @@ This document describes the steps necessary to install/upgrade IBEX on an Instru ## Preparatory Steps for Client and Server -Before starting any manual deployments, run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. +Before starting any manual deployments, run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. This should be run on the relevant deploy group - the playbook will prompt for this. As an example, to deploy to the winter group, enter `winter_deploy` (as specified in the [inventory file](https://github.com/ISISComputingGroup/ansible-playbooks/blob/main/hosts.yaml)). - Inform the instrument scientist that you are going to upgrade the instrument in 5 minutes so that they are not surprised when you remote desktop to the instrument, include a link to the release notes of the latest release in this email. Wait 5 minutes. - Make sure that `\\isis\shares\ISIS_Experiment_Controls_Public\ibex_utils` is pointing at `master` and is up to date (i.e. do git pull). From cfa97281b09f6554ba013aa175295f93dfee9afb Mon Sep 17 00:00:00 2001 From: Jack Harper Date: Fri, 23 Jan 2026 15:12:23 +0000 Subject: [PATCH 3/3] expand on "this" --- .../deploy/Deployment-on-an-Instrument-Control-PC.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md index 6cfc1da3c..5a2cde341 100644 --- a/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md +++ b/doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md @@ -4,7 +4,8 @@ This document describes the steps necessary to install/upgrade IBEX on an Instru ## Preparatory Steps for Client and Server -Before starting any manual deployments, run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. This should be run on the relevant deploy group - the playbook will prompt for this. As an example, to deploy to the winter group, enter `winter_deploy` (as specified in the [inventory file](https://github.com/ISISComputingGroup/ansible-playbooks/blob/main/hosts.yaml)). +Before starting any manual deployments, run the [`instrument_deploy.yaml` ansible playbook](https://github.com/ISISComputingGroup/ansible-playbooks/tree/main?tab=readme-ov-file#instrument_deployyaml) which currently installs the JDK on instruments. This should be run on the relevant deploy group - the playbook will prompt for the hosts to run it on to avoid accidentally deploying to all instruments. As an example, to deploy to the winter group, enter `winter_deploy` (as specified in the [inventory file](https://github.com/ISISComputingGroup/ansible-playbooks/blob/main/hosts.yaml)). +This playbook has been designed so it is idempotent, ie. if a step has already occurred such as deploying the JDK it will not be repeated. - Inform the instrument scientist that you are going to upgrade the instrument in 5 minutes so that they are not surprised when you remote desktop to the instrument, include a link to the release notes of the latest release in this email. Wait 5 minutes. - Make sure that `\\isis\shares\ISIS_Experiment_Controls_Public\ibex_utils` is pointing at `master` and is up to date (i.e. do git pull).