SAD¶

Table of Content:

• SAD
• Overview
• SAD - System architechture design
  • Techstack
  • Logical View
  • Physical View
  • Deployment
  • Security
  • Service Accounts Permission
• Source Reference
• Appendix
  • Appendix A: Record of Changes

Overview¶

Inno notification is a serverless notification service in data platform

SAD - System architechture design¶

Techstack¶

[+] Programing Language: Python, Bash

[+] Notication Channels:

• Email: Gmail by Sendgrid

• Slack: Slack application

• GitHub

[+] Deployment notification service:

• Serverless: Cloud Run

• CICD: CloudBuild, GitHub Actions

• Secret: Secret Manager

• Development: docker, docker-compose

• Ratelimit: Cloud Tasks Queue

• Client: Workflows, Cloud Scheduler, GitHub

Logical View¶

The logical view method of notification service

flowchart LR

  %% Component
  client[Client]

  subgraph gcp[Google Cloud Platform]

    subgraph rate-limit[Rate Limit Service]
      workflow[Queue]
    end

    subgraph crun[Google Cloud Run]
      app[Notification Service]
    end

    event_hub

    workflow --> app
  end

  subgraph notification_channel[Notification Channel]
    gh[GitHub]
    slack[Slack server]
    email[SMTP server]
    sms[SMS service]
    discord[Discord Channel]
  end

  %% Flow
  client -- request --> workflow
  client -- publish event --> event_hub[Event Hub] -- dispatch --> app
  client -- direct API call --> app
  app --> slack & email & sms & gh & discord

Physical View¶

Following is the deployed services that matching on notification service

flowchart LR

  %% Service in Cloud Platform
  subgraph Google Cloud Platform

    cbuild[Cloud Build]
    lb[Load Balancing]
    iap[Cloud IAP]
    secret[Cloud Secret Manager]
    logging[Cloud Logging]
    iam[Cloud IAM]
    artifact[Cloud Artifact]

    subgraph notification[Notification Service]
      run[Cloud Run]
    end
  end

  subgraph gh[GitHub]
    repository[Repository]
  end

  %% Flow
  lb -- navigate --> iap -- handle authentication --> run
  gh <-- sync/trigger --> cbuild -- deploy --> run
  secret <-. mount .-> run
  iam -- control access --> cbuild
  cbuild -- store images --> artifact
  run -- yield logs --> logging

  %% Targeted
  run -- notification --> notification

Deployment¶

There are 3 deployment environments: development, staging, production

Security¶

Service Accounts Permission¶

For the deployment of builder related to inno-notification will in charge by:

sa-natures-prophet: Project builder:

Service account: sa-natures-prophet@$PROJECT_ID.iam.gserviceaccount.com

Alias: sa-natures-prophet

sa-techies: Deploy service into Cloud Run:

Service account: sa-techies@$PROJECT_ID.iam.gserviceaccount.com

Alias: sa-techies

sa-terrorblade: Deploy workflow notification:

Service account: sa-terrorblade@$PROJECT_ID.iam.gserviceaccount.com

Alias: sa-terrorblade

sa-slardar: Deploy notification task declare:

Service account: sa-slardar@$PROJECT_ID.iam.gserviceaccount.com

Alias: sa-slardar

Source Reference¶

• [1] Call Cloud run by Worfklows

• [2] Call Scheduler jobs run by Workflows

• [3] Get secret keys in Workflows

• [4] Send grid api services send mail

• [5] Bigquery Load data from DataFrame

• [6] PubSub messages returned subscribe-build-notifications

Appendix¶

Appendix A: Record of Changes¶

Table: Record of changes