Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 4.33 KB

README.md

File metadata and controls

96 lines (68 loc) · 4.33 KB
Raw

devGaido

Overview | Services | License

Overview

devGaido provides a guided learning experience through the Web Development ecosystem by providing those new to the craft with predefined paths to aid in achieving web development skills. For experienced developers it provides a a means of filling in skill gaps around specific technologies, libraries, and languages.

You can find devGaido at www.devgaido.com and the devGaido application repo.

Services

DevOps services are defined as any function which externally supports the application. In other words, any support function that operates outside the main application, like database backups.

The devops services used to support the devGaido app include:

DevOps Service Directory Purpose
App runtime runtime Application runtime configuration
DevOps automation runtime Automation scripts and configuration
Documentation docs App and DevOps documentation

Issues should be reported on the main GitHub repo for the devGaido App sto consolidate all issues in one location. Similarly, wiki entries should be created on the main repo for the same reason.

Directory Structure

The devGaido project folder is organized in the following manner:

/devgaido_devops - devGaido devops files including documentation, Docker files, and Bash scripts
  /docs          - Application documentation files
  /runtime       - Application runtime files
    /dglbackups  - File backups. Excluded from Git to preserve security and confidentiality
    /docker      - Docker configuration files
      /dgapp     - devGaido application Docker configuration files
      /dgops     - devGaido DevOps Docker configuration files
  /scripts       - devGaido DevOps automation scripts
  .gitignore     - Contains the list of directories and file to be excluded from Git
  README.md      - This readme file

Application Runtime

devGaido Runtime Architecture

Built With

devGaido's runtime architecture leverages the following to achieve performance, availability, and ease of deployment:

  • CDN: A content delivery network (CDN) is used to reduce the amount of time necessary to serve up images and other static content.
  • Nginx: Is a web server providing security (HTTPS), compression, and load balancing.
  • Docker: Docker containers house devGaido's application components that make devGaido easier to deploy and manage.
  • Bash: Bash scripts are used to automate devops operations such as backups, monitoring, and administrator alerting and notification.

New Release Checklist

  • Pull changes into the develoment branch
  • Perform a final test using the development branch
  • Update release notes
  • Post the start of maintenance notification on Twitter and in the Chingu Slack channels
  • Logon to the devGaido Vultr console and enter the following commands:
    • sh dglbackup.sh
    • docker-compose stop
    • docker-compose build --no-cache
    • docker-compose up
  • Logon to the Cloudflare CDN and purge the cache
  • Bring up devGaido in your browser and test to ensure the changes were successfully promoted to production
  • Post the end of maintenance notification on Twitter and in the Chingu Slack channels
  • Commit the updated release notes
  • Pull development branch to master
  • Create new YouTube video describing changes and bug fixes included in the release

Backup & Recovery

devGaido Backup Architecture

Documentation

All documentation files and diagrams are stored in this repo so as not to pollute the main application repo. The purpose is to keep the generated application bundle size as small as possible.

License

MIT