cloud-quickstart / reference-architecture

Reference Architecture | Code | DevOps | SRE artifacts and principles
Apache License 2.0
1 stars 1 forks source link

This is not an officially supported Google product.

see - https://github.com/ObrienlabsDev/biometric-backend

Reference Architecture | Code | DevOps | SRE artifacts and principles

Open this project in Google Cloud Shell

Introduction

This set of projects serve the combined purpose of providing a concrete hands on view and set of artifacts around a provisional set of services and associated development, architecture, design, deployment, slow, monitoring, change management, capacity planning, and provisioning.

Business Requirements

A set of services with a defined SLO

Sli1: availability of 99.95 Sli2: 90 of rest calls complete in 1ms, 99 in 10ms, 99.9 in 100ms Sli3: report extractions/exports within 60 sec (5Gb, 10 million records)

A phased set of progressive releases that exercise the provisioning pipeline

A maximum coverage yet minimum cost spanning tree of deployment artifacts

A useful business function like biometric tracking, event handling or routing functionality

Technical Requirements

DevOps

Developer Setup

Cloud Setup

Quickstart

Clone

Build

Commit/Push

Local Docker

Architecture

Design

Developer Guide

Create initial spring boot maven project

Create a new project via the spring initializr https://start.spring.io/ see https://spring.io/guides/gs/serving-web-content/

The following maven archetype will generate a submodule stub project around a single controller to start mvn archetype:generate -DgroupId=ca.cloudlift.reference -DartifactId=reference-nbi -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Add the root pom.xml

Add Swagger and OpenAPI 3

Configure IDEs for Development

Design Issues

CI/CD

SRE

SRE - Shadow CD Full / Clean Testing Deployment Testing

SRE - Phased Canary Production Deployment

Operations

Links

References

Source Code Headers

Apache header:

Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.