From f3c325fd485876e981e589d2a30c1f84f8031270 Mon Sep 17 00:00:00 2001 From: Dominic Oram Date: Mon, 3 Mar 2025 10:50:33 +0000 Subject: [PATCH 1/2] Update deployment docs based on deploying --- docs/how-to/edit-live.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/how-to/edit-live.md b/docs/how-to/edit-live.md index dabe45055..54a06f860 100644 --- a/docs/how-to/edit-live.md +++ b/docs/how-to/edit-live.md @@ -54,10 +54,19 @@ The helm chart can be configured to mount a scratch area from the host machine, include the following in your `values.yaml`: ```yaml - scratch: - hostPath: path/to/scratch/area # e.g. /dls_sw//software/blueapi/scratch + scratchHostPath: path/to/scratch/area # e.g. /dls_sw//software/blueapi/scratch ``` :::{note} If you do this then the value of `scratch.root` in your blueapi configuration is no longer particularly important, it only specifies where to mount the scratch area _inside_ the container. ::: + +The scratch folder that you're pointing to must exist, not already have a dodal deployment and have correct permissions e.g. + +``` +cd /dls_sw//software/blueapi/ +mkdir scratch +chmod o+wrX -R scratch +``` + +BlueAPI will then checkout the `main` branch of any specified repos into this scratch folder. From 4abe236e6a6a3ec403952cd41bcfb901d511a8b8 Mon Sep 17 00:00:00 2001 From: Dominic Oram Date: Mon, 3 Mar 2025 14:27:43 +0000 Subject: [PATCH 2/2] Update edit-live.md to be more general --- docs/how-to/edit-live.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/edit-live.md b/docs/how-to/edit-live.md index 54a06f860..e9015e481 100644 --- a/docs/how-to/edit-live.md +++ b/docs/how-to/edit-live.md @@ -61,7 +61,7 @@ host machine, include the following in your `values.yaml`: If you do this then the value of `scratch.root` in your blueapi configuration is no longer particularly important, it only specifies where to mount the scratch area _inside_ the container. ::: -The scratch folder that you're pointing to must exist, not already have a dodal deployment and have correct permissions e.g. +The scratch folder that you're pointing to must exist, not already have a copy of the repositories that will be cloned into it and have correct permissions e.g. ``` cd /dls_sw//software/blueapi/