Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.89 KB

ARCHITECTURE.md

File metadata and controls

48 lines (31 loc) · 1.89 KB
Raw

Shore Architecture

Preface

This document contains a high-level overview of the terms & technologies in the Shore project.

Documents intentions

  1. Illustrate the project's architecture
  2. Explaining how the requirement described in the Product Requirements Document are implemented.
  3. Provide an overview for future contributors.

What to keep in mind while reading

  1. Shore is a Framework.
  2. Shore is a project based software.
  3. Shore is built to be extensible.

High Level Architecture Diagram

Architecture Diagram for Shore.

Core Architecture Docs

Shore Core

A codified boundary, used to differentiate the systems core components.

For more infromation please see shore-core

Shore CLI

An interface that expose shore-core through a cli

For more infromation please see shore-cli

Renderers

  1. Jsonnet Renderer - A Shore Renderer reference implementation that uses Jsonnet NOTE: If you'd like to "bring your own" pipeline and leverage Shore's testing, saving, and executing capabilities, please follow the bring your own pipeline tutorial.

Backends

  1. Spinnaker Backend - A Shore Backend reference implementation that integrates with Spinnaker