Introduction

Introduction#

RDCT Good DevOps Practice

Research Data and Communication Technologies’ secure software development and IT operations discipline enables research at scale.


An Agile Foundation

Collaborate with colleagues, customers, and communities. Focus on consistent, incremental results. Plan ahead, but be responsive to change.

Project Management
Versioned, Immutable

Track changes to software products and system definitions.

Version Control
Continuous Integration

Shift left by automating software verification, system validation, and product packaging.

Continuous Integration
Continuous Delivery

Shift right with rolling releases that deploy (or update) accredited, validated capability at the speed of need.

Continuous Delivery

Conventions#

Guidance

Interpret the key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL as described in RFC 2119.

Authoritative guidance using these key words appear in admonitions titled “Guidance”, like above. An explanation of the rationale for the rule plus supporting material appears after in separate paragraphs, like this. Usually, each rule falls under its own subheading, which facilitates cross-referencing. Top-level headings provide a content summary or a quick reference.

Scope#

This document governs the life cycle of the RDCT Engineering team’s products or services. It incorporates material from several sources, including the following:

Audience#

Members of the RDCT Engineering team follow these standards and practices as they develop and operate accredited, validated systems for government, for research and education, and for commerce. This is not limited to pure software development activites and can include, for example, documentation or system integrations. This also includes company (internal) projects, which act as both on-the-job DevOps training activities and process quality controls.

Authoring#

This document is written using MyST Markdown, a strict superset of the CommonMark syntax specification that adds features focused on scientific and technical documentation authoring. Markdown is specifically designed to be readable across multiple devices in a variety of formats without requiring an online Internet connection. Formatting, collaborative editing, and publishing follows the same standards and practices described herein.

Structure#

This document contains three major sections. The frontmatter introduces the RDCT Engineering team’s DevOps strategy. The main body of the work provides instructions covering project management, version control, continuous integration, and continuous delivery as well as supplementary—but still authoritative—guidance for specific tool chains or techniques. Appendices organize key reference materials.