Skip to content

devops_standards.md

Latest commit

 

History

History
179 lines (142 loc) · 3.89 KB

devops_standards.md

File metadata and controls

179 lines (142 loc) · 3.89 KB

DevOps Standards

As part of the Box of Autonomy teams are given a starting point for choices. This is a living and breathing set of standards.

The use of deprecrated will be denoted when something is no longer part of the standard but may be supported for period of time. Items that are deprecated should no longer be used for anything new. When possible efforts to move away from them should be done.

The use of obsolete will be denoted when something is no longer part of the standard and is no longer supported. Items that are obsolete should be prioritized where it makes sense to be moved to supported technologies.

Source Control

  • Github
  • Azure DevOps (obsolete)
  • TFS (obsolete)

REST API Standards

Pair Switching

  • git-duet fix

Platform As A Service (for all platforms, do not use their domain names (i.e azurewebsites.com or amazonaws.com) for any service)

  • AWS
  • Azure (deprecated)
  • GoogleCloud (deprecated)

Deployment container

  • Docker (with HTTP on port 3000 for HTTP services)

Continuous Integration/Deployment

  • Github Actions
  • Azure DevOps (obsolete)
  • TravisCI (obsolete)
  • Jenkins (obsolete)
  • TFS (obsolete)

Languages

  • Python >= 3.8
  • .NET (C#) >6
  • Ruby >3
  • Javascript >6
  • Typescript
  • .NET <6 (C#)(deprecated)
  • Ruby <3 (deprecated)
  • Python <3.8 (deprecated)
  • Javascript <6 (deprecated)
  • Rust (obsolete)
  • DNX (obsolete)

Ruby Gems

See Ruby Gems

Video/Audio/Chat Conferencing

  • Zoom
  • Slack
  • Discord (deprecated)
  • Teams (obsolete)

Front End Frameworks

  • React
  • Ionic
  • Blazor
  • Next.JS
  • Angular >12 (deprecated)
  • jQuery (deprecated)
  • Aurelia (obsolete)
  • Knockout (obsolete)
  • Breeze (obsolete)
  • Angular <12 (obsolete)

MVC Frameworks

  • Rails
  • Flask (deprecated)

CSS Frameworks

  • Tailwind CSS + Backpack UI (as Tailwind Plugin)
  • Bootstrap (obsolete)

CSS Language

  • LESS ?
  • SASS ?
  • SCSS ?

CSS Icon Sets

  • Font Awesome

Logging

  • Cloudwatch
  • App Insights
  • DataDog (obsolete)
  • Graylog (obsolete) 🔥

Exception Reporting

  • Sentry
  • App Insights
  • Stackify (obsolete)

Metrics

  • Cloudwatch
  • App Insights
  • Grafana

Infrastructure As Code

  • Pulumi
  • Vercel
  • Azure Resource Manager (?)
  • Serverless (deprecated)
  • Ansible (deprecated)
  • Terraform (deprecated)

Flow Visualization

  • Lucid Chart
  • Mermaid.js
  • Draw.io (obsolete)
  • GraphViz (obsolete)

Application URLs

  • -.strongmind.com for lower environments
  • .strongmind.com for production environments

IDE

  • JetBrains
    • For Pairing/Mobbing
    • Installed on Machine by Default

Databases

SQL

  • Postgres
  • SQL Server (deprecated)
  • CosmosDB (deprecrated)

Reporting

  • SnowFlake
  • SQL Server (deprecated)

Testing Tools

  • PyTest Describe (Python)
  • Jest (Javascript)
  • Rspec (Ruby)
  • xUnit (.NET)
  • nUnit (.NET)

Mocking Tools

Desktop Operating System (Machine Type Intel/M1)

Secret Credential Stores

  • AWS Secret Manager

Virtual Environment Manager (rbenv, pyenv,etc)

  • rbenv (ruby)
  • venv (python)
  • nvm (node)

Package Management

  • pypi.org (python)
    • Requires Makefile with a test and install option.
    • Package name prefix "strongmind-"
  • nuget.org (.net)
    • Package ID prefix "SM."
  • rubygems.org (ruby)

Web Packaging (npm, yarn, etc)

  • npm

Repo Naming

  • dashes not under scores

Repository Locations

  • Windows: C:\Users\<user>\Documents\GitHub
  • Mac: /Users/<user>/github
  • Linux: /home/<user>/github

Other Issues

  • Instructions for Installing Languages & Frameworks
  • Developer Setup
  • Deployment Standards
  • Terminal Config Settings
  • PR Process
  • Local Environment Variables