https://github.com/choyiny/reliable_blog

A simple blog stack to demonstrate Google's Site Reliability Engineering principles.
https://github.com/choyiny/reliable_blog

angular ansible docker elasticsearch elk-stack hacktoberfest kibana kubernetes monitoring rails site-reliability-engineering

Last synced: 6 days ago
JSON representation

A simple blog stack to demonstrate Google's Site Reliability Engineering principles.

• Host: GitHub
• URL: https://github.com/choyiny/reliable_blog
• Owner: choyiny
• Archived: true
• Created: 2019-11-01T22:11:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-24T21:49:39.000Z (12 months ago)
• Last Synced: 2024-10-25T06:28:16.709Z (3 months ago)
• Topics: angular, ansible, docker, elasticsearch, elk-stack, hacktoberfest, kibana, kubernetes, monitoring, rails, site-reliability-engineering
• Language: Ruby
• Homepage: https://deployingreliable.software/
• Size: 645 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Deploying Reliable Software

A CSCD94 - Computer Science Project with Professor [Thierry Sans](https://github.com/thierrysans).

## Introduction

An extension to the existing “Programming on the Web” course at the University of Toronto Scarborough. This research project aims to follow the two books by Google, Site Reliability Engineering and Site Reliability Workbook. There are two main objectives:

- What is the Google way of deploying software used by millions of people?

- How to maintain high availability while allowing for frequent software updates?

## Services

- Main Website: https://deployingreliable.software

- Backend Service: https://backend.deployingreliable.software

- Kibana Dashboard: https://kibana.deployingreliable.software

- Elasticsearch: https://elastic.deployingreliable.software

## Development Setup

Prerequisites: Docker and Docker Compose installed in your system.

1. To start all servers in development mode, simply run

```

$ docker-compose up -d

```

## Production

- We use ansible scripts to push applications to our production servers hosted on Google Cloud. See `ansible/README.md`.

## Technologies

We try to use a range of technologies in this demo. Here are the list of technologies used at some time in this project.

### Deployment

"we want systems that are automatic, not just automated. In practice, scale and new features keep SREs on their toes."[\[1\]](https://landing.google.com/sre/sre-book/chapters/introduction/)

- [Github Packages](https://github.com/features/packages): Docker image repository

- [Github Actions](https://github.com/features/actions): Continuous integration and Deployment

- [Ansible](https://www.ansible.com/): Playbooks to automate deployment

- [Docker Swarm](https://docs.docker.com/engine/swarm/): Docker across many hosts

- [Kubernetes](https://kubernetes.io/): Container orchestration

### Application Stack

"To provide a model of how a service would hypothetically be deployed in the Google production environment"[\[2\]](https://landing.google.com/sre/sre-book/chapters/production-environment/#fig_production-environment_life-of-a-request)

- [Ruby](https://rubyonrails.org/) on Rails: Backend server REST framework

- [Angular 8](https://angular.io/): Frontend framework

- [PostgreSQL](https://www.postgresql.org/): Relational Database

- [nginx](https://www.nginx.com/): Reverse proxying for applications (Kubernetes Ingress)

### Packaging applications

- [Docker](https://www.docker.com/): Deploy applications cross-platform in a standardized environment

### Monitoring Stack

"The four golden signals of monitoring are latency, traffic, errors, and saturation. If you can only measure four metrics of your user-facing system, focus on these four."[\[3\]](https://landing.google.com/sre/sre-book/chapters/monitoring-distributed-systems/)

#### Prometheus-based

- [Grafana](https://grafana.com/): Dashboard to show statistics and alert if thresholds are exceeded.

- [Prometheus](https://prometheus.io/): A time series database to store data.

- [node_exporter](https://github.com/prometheus/node_exporter): A companion for Prometheus to export server statistics.

#### Elasticsearch-based

- [Kibana](https://www.elastic.co/kibana): Dashboard to visualize data from Elasticsearch

- [Elasticsearch](https://www.elastic.co/elasticsearch): Full text search engine to store log data

- [Elastic APM](https://www.elastic.co/apm): Application performance monitoring server (\*uses elastic-apm agent in Rails application)

#### Others

- [Sentry](https://sentry.io/): An external service to track application errors.