SAD¶

Overview¶

Introduction of system design on internal documentation

SAD - System architechture design¶

Logical View¶

The logical view for the internal documentation

flowchart LR

  %% Component
  internal-team[Internal Team ~ Devs, Stakeholders]
  url[internal.docs.data.innotech.vn]
  auth[Authentication Service]
  docs[Internal Documentation]

  %% Flow
  internal-team -- access endpoint --> url -- direct map --> auth -- verify authentication --> docs

Physical View¶

Tech Stack¶

• Static website framework: mkdocs on theme material

• For documentation:

• Content: based on markdown

• Diagram: Mermaid

• Serverless deployment: Cloud Run

• CICD: GitHub Actions, Cloud Build

• Load Balancer: Load Balancing

• Authentication: Google IAP

• Development: Docker, docker-compose

Flow¶

flowchart LR

  %% Component
  internal-gateway

  subgraph internal-access-point[Access Point]
    url[Website Endpoint]
  end

  subgraph gcp[Google Cloud Platform]
    lb[Load Balancer]
    iap[Google IAP]
    subgraph crun[Cloud Run]
      docs[Internal Documentation]
    end
  end

  %% Flow
  internal-gateway -- access endpoint --> url -- direct --> lb --> iap -- authentication --> docs

Deployment¶

Using CloudBuild to build execution based on trigger on push

Appendix¶

Appendix A: Record of Changes¶

Table: Record of changes