Skip to content

Update readme #7

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

Merged
Sebokolodi merged 2 commits into from
May 28, 2026
Merged

Update readme #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c38b28
update readme (remove canfar retries and update Prefect API URL descr…
riniangreani May 28, 2026
2ff2acf
Update README with Prefect configuration details
riniangreani May 28, 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
17 changes: 6 additions & 11 deletions automation/README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
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://<IP address>:4200/api
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
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):
----------------------------------
Expand All @@ -23,15 +27,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.
Expand Down
Loading