Improve devops documentation

Author: SteveViss

README.md

@@ -43,14 +43,15 @@ gcloud run jobs create sync-bird-metadata \
 Set the schedule
 
 ```r
-gcloud scheduler jobs create http sync-bird-metadata-scheduled \
-    --project nunatsiavut-birds \
+gcloud scheduler jobs create http sync-data-gulls-scheduled \
+    --project=nunatsiavut-birds \
     --oauth-service-account-email=run-scheduled-jobs@nunatsiavut-birds.iam.gserviceaccount.com \
     --schedule="0 9 1 * *" \
     --uri="https://us-central1-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/nunatsiavut-birds/jobs/sync-data-gulls:run" \
     --http-method=POST \
     --headers="Content-Type=application/json" \
-    --location=us-central1
+    --location=us-east1 \
+    --time-zone="America/Toronto"
 ```
 
 ## Bird locations synchronization task
@@ -133,13 +134,14 @@ gcloud run jobs create sync-data-gulls \
 
 ```sh
 gcloud scheduler jobs create http sync-data-gulls-scheduled \
-    --project nunatsiavut-birds \
+    --project=nunatsiavut-birds \
     --oauth-service-account-email=run-scheduled-jobs@nunatsiavut-birds.iam.gserviceaccount.com \
     --schedule="0 9 1 * *" \
     --uri="https://us-central1-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/nunatsiavut-birds/jobs/sync-data-gulls:run" \
     --http-method=POST \
     --headers="Content-Type=application/json" \
-    --location=us-central1
+    --location=us-east1 \
+    --time-zone="America/Toronto"
 ```
 
 #### Declare Eiders sync job
@@ -160,15 +162,20 @@ gcloud run jobs create sync-data-eiders \
 
 ```sh
 gcloud scheduler jobs create http sync-data-eiders-scheduled \
-    --project nunatsiavut-birds \
+    --project=nunatsiavut-birds \
     --oauth-service-account-email=run-scheduled-jobs@nunatsiavut-birds.iam.gserviceaccount.com \
     --schedule="0 9 1 * *" \
     --uri="https://us-central1-run.googleapis.com/apis/run.googleapis.com/v1/namespaces/nunatsiavut-birds/jobs/sync-data-eiders:run" \
     --http-method=POST \
     --headers="Content-Type=application/json" \
-    --location="us-central1"
+    --location=us-east1 \
+    --time-zone="America/Toronto"
 ```
 
+### DevOps sequence diagram
+
+![](inst/puml/devops.puml)
+
 ### Contributing
 
 Please follow the guidelines described [here](https://github.com/inSilecoInc/iseShinyTemplate?tab=readme-ov-file#code-convention).

inst/puml/devops.png

@@ -0,0 +1,47 @@
+@startuml
+title CI/CD Workflow for Google Cloud Run, Scheduler, and Shiny App
+
+actor Developer as Dev
+participant "GitHub Repository" as Repo
+participant "GitHub Actions" as Actions
+participant "Google Artifact Registry" as Artifactory
+participant "Google Cloud Run" as CloudRun
+participant "Google Cloud Scheduler" as CloudScheduler
+database "Bird Metadata Bucket\n(bird-metadata)" as MetadataBucket
+database "Bird Locations Bucket\n(bird-locations)" as LocationsBucket
+participant "Shiny App\nhttps://insileco-inc.shinyapps.io/nunatsiavutBirdTracker/" as ShinyApp
+
+Dev -> Repo: Push code to main branch
+Repo -> Actions: Trigger CI/CD pipeline
+Actions -> Actions: Build Docker image
+Actions -> Actions: Inject secrets
+Actions -> Artifactory: Push Docker image
+
+note over Artifactory, CloudRun
+  Deploying the Docker image to Cloud Run
+  is a **manual operation** triggered by the developer.
+end note
+
+Artifactory -> CloudRun: Deploy Docker image (manual)
+CloudRun -> CloudScheduler: Configure scheduled tasks
+
+note right of CloudScheduler
+  Scheduling details:
+  - sync-bird-metadata-scheduled: Every Monday at 9:00 AM
+  - sync-data-gulls-scheduled: 1st of every month at 9:00 AM
+  - sync-data-eiders-scheduled: 1st of every month at 9:00 AM
+end note
+
+CloudScheduler -> CloudRun: Trigger Job: sync-bird-metadata-scheduled
+CloudRun -> MetadataBucket: Store metadata
+MetadataBucket -> ShinyApp: Expose metadata
+
+CloudScheduler -> CloudRun: Trigger Job: sync-data-gulls-scheduled
+CloudRun -> LocationsBucket: Store locations
+LocationsBucket -> ShinyApp: Expose locations
+
+CloudScheduler -> CloudRun: Trigger Job: sync-data-eiders-scheduled
+CloudRun -> LocationsBucket: Store locations
+LocationsBucket -> ShinyApp: Expose locations
+
+@enduml