From 014d859f8a5406530ef81128ee18239eb249cd4e Mon Sep 17 00:00:00 2001 From: Conor Finn Date: Wed, 8 Feb 2023 18:03:57 +0000 Subject: [PATCH] Fix docs formatting RE #62 --- jenkins-node/mantid-builder-macos/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/jenkins-node/mantid-builder-macos/README.md b/jenkins-node/mantid-builder-macos/README.md index d0767be..f43f5be 100644 --- a/jenkins-node/mantid-builder-macos/README.md +++ b/jenkins-node/mantid-builder-macos/README.md @@ -49,19 +49,23 @@ The ansible scripts will set up the machine and connect it to the Jenkins contro 1. If you already have the `ansible-linode` repo and associated conda environment, activate it and skip to step 4. 2. Clone the [`mantidproject/ansible-linode`](https://github.com/mantidproject/ansible-linode) repo. 3. Navigate to the base of the cloned repo and run: - - `mamba create --prefix ./condaenv ansible` - - `mamba activate ./condaenv` - - Note: You can activate the environment from anywhere by providing the full path to the `condaenv` directory. + + 1. `mamba create --prefix ./condaenv ansible` + 2. `mamba activate ./condaenv` + 3. Note: You can activate the environment from anywhere by providing the full path to the `condaenv` directory. + 4. Clone the [`dockerfiles`](https://github.com/mantidproject/dockerfiles) repo and navigate to `jenkins-node/mantid-builder-macos/ansible`. 5. Install the required collections from Ansible Galaxy by running: - `ansible-galaxy install -r requirements.yml` 6. Time to use that secret you made a note of. Create an `inventory.txt` file with the details of the machines to deploy to (one per line): + ```ini [all] agent_name= agent_secret= agent_name= agent_secret= ``` -If you've forgotten the secret, it can be found under `Environment Variables` in the `System Information` section of the agent. + + If you've forgotten the secret, it can be found under `Environment Variables` in the `System Information` section of the agent. ### Running the Script to Deploy the Agent @@ -73,4 +77,4 @@ ansible-playbook -i inventory.txt jenkins-agent.yml -u mantidbuilder -K 2. When prompted, enter the agent's password that you made earlier. If you weren't the one who made the password, it should be in the `ISIS Jenkins Nodes` file on Keeper. 3. Wait for the play to complete and visit `https://builds.mantidproject.org/computer/NAME_OF_AGENT_ON_JENKINS`. The agent should be connected within five minutes. - - Note: The agent is kept connected to the controller by a crontab entry that runs on every 5th minute. This means that on first setup the note may not connect until a minute divisible by five has passed. + 1. Note: The agent is kept connected to the controller by a crontab entry that runs on every 5th minute. This means that on first setup the note may not connect until a minute divisible by five has passed.