Overview

Overview#

Collaborative Organization for Resource and Trust Exchange (CORTEX)

Deploy, configure, and manage CORTEX resources in a Kubernetes cluster using Helm.

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 project manages the deployment and configuration of resources for the Collaborative Organization for Resource and Trust Exchange (CORTEX) on Kubernetes using Helm.

Audience#

This project is jointly maintained by the IBRSP Engineering and Infrastructure team and the RENU Software and DevOps team. Contributions are restricted to the project team.

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 readers to the project. The main body of the work describes the major components of CORTEX and explains how to deploy them. Appendices organize key reference materials.