From 1c38b2883af6f08e6c614cb3b5cdfe77c114b2c4 Mon Sep 17 00:00:00 2001 From: riniangreani2 Date: Thu, 28 May 2026 11:13:32 +0800 Subject: [PATCH 1/2] update readme (remove canfar retries and update Prefect API URL description) --- automation/README | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/automation/README b/automation/README index f05a1a8..e2c7338 100644 --- a/automation/README +++ b/automation/README @@ -1,6 +1,6 @@ Config.env must be populated with Prefect details for CANFAR session to connect to Prefect: -PREFECT_API_URL : IP address of the Prefect server e.g. http://:4200/api +PREFECT_API_URL : API URL for the Prefect server PREFECT_API_AUTH_STRING : auth string to let us use the Prefect server in CANFAR The rest of the values in config.env are now optional. All the secrets including database details are stored in Prefect server. @@ -10,7 +10,7 @@ The rest of the values in config.env are now optional. All the secrets including HARBOR_PASSWORD : Harbor registry password to push images to run on Canfar HARBOR_USERNAME : Harbor username to push images PREFECT_API_AUTH_STRING : auth string to let us use the Prefect server in the code -PREFECT_API_URL : IP address of the Prefect server to bypass the OAuth Proxy (Github login) +PREFECT_API_URL : API URL for the Prefect server to bypass the OAuth Proxy (Github login). This is different from the Prefect UI URL for users to login with Github. 2. Prefect secrets (under Blocks): ---------------------------------- @@ -23,15 +23,6 @@ database-user | POSSUM database username possum-status-sheet | link to POSSUM status Google spreadsheet possum-status-token | Copy the content of the json token to access the possum-status-sheet above -3. Prefect variables (under Variables): ---------------------------------------- -Optional, only if you'd like to override these values: -canfar-num-retries | 2 | Number of retries when CANFAR session fails. -canfar-polling-interval-seconds | 60 | Polling interval (in seconds) to poll CANFAR sessions. - -We need to poll CANFAR periodically because sometimes the sessions silently terminate, and Prefect does not know about it. -Now we'll retry before giving up, and raising an error so to propagate as Prefect flow failure, and send Slack notification. - You can still use your own config.env as below to override the production secrets for testing purposes. 1. Rename config.env.example to config.env. 2. Enter ausSRC database details in the .env file. From 2ff2acf18b341fbe9a9d840f61b2d2426ca069cf Mon Sep 17 00:00:00 2001 From: Rini Angreani Date: Thu, 28 May 2026 11:28:46 +0800 Subject: [PATCH 2/2] Update README with Prefect configuration details Clarified Prefect API URL example and added notes on required secrets for Canfar sessions. --- automation/README | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/automation/README b/automation/README index e2c7338..5b76d76 100644 --- a/automation/README +++ b/automation/README @@ -1,12 +1,16 @@ Config.env must be populated with Prefect details for CANFAR session to connect to Prefect: -PREFECT_API_URL : API URL for the Prefect server +PREFECT_API_URL : API URL for the Prefect server, e.g. http://127.0.0.1:4200/api PREFECT_API_AUTH_STRING : auth string to let us use the Prefect server in CANFAR +The above are needed for Canfar sessions to connect to Prefect. + The rest of the values in config.env are now optional. All the secrets including database details are stored in Prefect server. 1. Github Actions Secrets: -------------------------- +These are needed for initial Prefect deployments. + HARBOR_PASSWORD : Harbor registry password to push images to run on Canfar HARBOR_USERNAME : Harbor username to push images PREFECT_API_AUTH_STRING : auth string to let us use the Prefect server in the code