Skip to content

correct ansible docs and make clear that playbook needs to be run bef… #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rerpha wants to merge 3 commits into
base: master
Choose a base branch
from
Open

correct ansible docs and make clear that playbook needs to be run bef… #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4480091
correct ansible docs and make clear that playbook needs to be run bef…
rerpha Jan 23, 2026
a0a32d0
add note on deploy group prompt
rerpha Jan 23, 2026
cfa9728
expand on "this"
rerpha Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/deployment/Creating-a-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
3 changes: 3 additions & 0 deletions doc/deployment/deploy/Deployment-on-an-Instrument-Control-PC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ 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 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.

Copy link
Member

@FreddieAkeroyd FreddieAkeroyd Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where do you run this and if ndx do you need to install ansible first?

Copy link
Member

@FreddieAkeroyd FreddieAkeroyd Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you run this on your own computer just for the ndx you intend to target?

Copy link
Contributor Author

@rerpha rerpha Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You run it in your own WSL instance which has SSH key-based access to the instruments - i can add some notes to https://github.com/ISISComputingGroup/ansible-playbooks?tab=readme-ov-file#ansible-ndx to make this clearer

Copy link
Member

@FreddieAkeroyd FreddieAkeroyd Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think adding an example shownig use of --limit for a deploy would be helpful so we don't have multiple people accidentally deploying to e.g. all of ts1 at the same time

Copy link
Contributor Author

@rerpha rerpha Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/ISISComputingGroup/ansible-playbooks/pull/16

Copy link
Contributor Author

@rerpha rerpha Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think adding an example shownig use of --limit for a deploy would be helpful so we don't have multiple people accidentally deploying to e.g. all of ts1 at the same time

it prompts for this when you run it so you don't accidentally run it everywhere

Copy link
Contributor Author

@rerpha rerpha Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have also added note in a0a32d0

- 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.
Expand Down