Skip to content

docs(runbooks): add API, queue/jobs, and payments operational guides#1479

Merged
jimmypalelil merged 1 commit intobcgov:mainfrom
jimmypalelil:1442-document-runbooks
Apr 1, 2026
Merged

docs(runbooks): add API, queue/jobs, and payments operational guides#1479
jimmypalelil merged 1 commit intobcgov:mainfrom
jimmypalelil:1442-document-runbooks

Conversation

@jimmypalelil
Copy link
Copy Markdown
Collaborator

@jimmypalelil jimmypalelil commented Mar 31, 2026

Issue:

Description of changes:

  • Add runbook documentation for strr-api operations, including health endpoints, configuration pitfalls, auth/role handling, common startup failures, and production troubleshooting guidance.
  • Add runbook documentation for queue services and Cloud Run jobs, covering strr-pay, strr-email, permit validation listeners, trigger flows, logs, retries, and diagnostics.
  • Add a payments runbook describing end-to-end payment flow, API touchpoints, status transitions, reconciliation pointers, and triage steps for failed/missing updates.
  • Update ignore rules for examiner web generated artifacts.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the BC Registry and Digital Services BSD 3-Clause License

@bcregistry-sre
Copy link
Copy Markdown
Collaborator

Temporary Url for review: https://strr-examiner-dev--pr-1479-nof6it87.web.app

@thorwolpert
Copy link
Copy Markdown
Collaborator

You could also create these as Jupyter notebooks, the queries can be run in the page.
Examples are here:
https://github.com/bcgov-c/hous-str/tree/main/notebooks

@jimmypalelil
Copy link
Copy Markdown
Collaborator Author

jimmypalelil commented Mar 31, 2026

You could also create these as Jupyter notebooks, the queries can be run in the page. Examples are here: https://github.com/bcgov-c/hous-str/tree/main/notebooks

@thorwolpert I thought about adding notebooks in this repo itself but thought it might be overkill for the scope of the task. also is there a reason why those notebooks are in a different secure org (bcgov-c) repo hous-str? We could have just added them in this repo right since its str related?


On another note I am thinking of putting up the GCP log queries with gcloud cli using this extension:

%load_ext pshnb
%%bash
gcloud logging read "resource.type=cloud_run_revision AND resource.labels.service_name=strr-api-dev" --format="table(timestamp, textPayload)" --limit=10 --freshness=1h

But it can be planned for a later time I suppose.

@thorwolpert
Copy link
Copy Markdown
Collaborator

Yep, although we have a different audience in the "confidential" org, so if they happen to save things they shouldn't by accident it's not the same blast-radius as it is in the public repo

@jimmypalelil jimmypalelil requested review from dimak1 and removed request for thorwolpert April 1, 2026 17:01
@dimak1 dimak1 requested a review from JazzarKarim April 1, 2026 17:56
Copy link
Copy Markdown
Collaborator

@dimak1 dimak1 left a comment

Choose a reason for hiding this comment

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

LGTM!

@jimmypalelil jimmypalelil force-pushed the 1442-document-runbooks branch from ca28d13 to 69ecf9b Compare April 1, 2026 23:20
@bcregistry-sre
Copy link
Copy Markdown
Collaborator

Temporary Url for review: https://strr-examiner-dev--pr-1479-nof6it87.web.app

@jimmypalelil jimmypalelil force-pushed the 1442-document-runbooks branch from 69ecf9b to 9b66001 Compare April 1, 2026 23:27
@Jacky-Pham
Copy link
Copy Markdown
Collaborator

Look good to me!

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 1, 2026

@bcregistry-sre
Copy link
Copy Markdown
Collaborator

Temporary Url for review: https://strr-examiner-dev--pr-1479-nof6it87.web.app

@jimmypalelil jimmypalelil merged commit a96b719 into bcgov:main Apr 1, 2026
14 checks passed
@dimak1 dimak1 mentioned this pull request Apr 8, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants