Project Syn
Tools
Commodore Commodore Components Hub Lieutenant API Lieutenant Operator Steward K8up
Main website Handbook Knowledge Base Products Legal Portal Help APPUiO Documentation
  GitHub

Project Syn

    • Home
  • About
    • Introduction
    • Features
    • Architecture
    • Roadmap
    • Community
    • Contribution Guide
    • Code of Conduct
    • Glossary
    • Comparison
    • Visual Design
  • Tutorials
    • Getting Started with Project Syn
    • Commodore
      • Writing a Component
      • Writing a Package
    • Lieutenant Operator
    • Lieutenant API
    • Steward
  • How-to guides
    • Release Process
    • List Lieutenant clusters
    • Compile a catalog
    • Change a parameter
    • Prepare component for template updates
    • Renovate version pins
    • Make a Commodore component multi-tenant aware
    • Commodore
      • Add a component to a cluster in local mode
      • Shell autocompletion
    • Lieutenant Operator
      • Installation
      • Vault Configuration
      • Running Operator locally
      • GitLab Connection
      • Set up the Commodore Compile Pipeline
      • Create a Tenant
      • Create a Cluster
      • Create a Git Repository
    • Lieutenant API
      • Deployment
      • GitLab Configuration
    • Steward
  • Technical reference
    • Style Guide
    • Review Guide
    • Labels Guide
    • Commodore
      • Concepts
      • Architecture
      • User interface
        • Commands
        • Command Line Options
      • Configuration hierarchy
        • Inventory Hierarchy
        • Commodore-managed inventory parameters
      • Feature deprecation
        • Deprecation policy
        • Deprecation notices
        • Component deprecation
      • commodore.libjsonnet API reference
      • kube.libjsonnet
    • Lieutenant Operator
      • CRDs
      • Configuration
    • Lieutenant API
      • OpenAPI Documentation
      • Configuration
      • API Personas
    • Steward
  • Explanation
    • Syn Design Documents
    • Commodore Component Best Practices
      • Container image versions
      • Major changes
      • User-provided Secrets
      • Using Helm charts
      • Using kustomizations
      • Conditionals in the parameters hierarchy
      • Custom Resource Defintions
      • Writing Prometheus Alert Rules
    • Commodore Packages Best Practices
    • Jsonnet Best Practices
    • Keep components in sync
    • ArgoCD multi-tenancy
    • Commodore
      • Local Mode
      • Manage Dependencies
      • Running Commodore
      • Migrating from Kapitan 0.29 to 0.30
      • Compilation metadata reporting
    • Lieutenant Operator
      • Operator Design
      • Object Deletion
      • Templating
      • Multi tenant access
      • CI/CD support
    • Lieutenant API
      • Authentication
      • Authorization
    • Steward
      • Authentication
      • Authorization
Project Syn master
  • Commodore Component Tutorial
    • master
  • floodgate
    • master
  • Lieutenant API
    • master
  • Lieutenant Operator
    • master
  • Project Syn
    • master
  • Project Syn: Commodore
    • master
  • Steward
    • master
  • Project Syn
  • Explanation
  • Syn Design Documents
Edit this Page

Syn Design Documents (SDDs)

A Syn Design Document is a working document to document, discuss and decide on design decisions in Project Syn. See SDD 0001 for a definition of the SDD itself.

The all are using the SDD Template.

List of SDDs

  • 0001 - SDD Definition

  • 0002 - Naming Scheme

  • 0006 - Commodore Configuration Catalog Compilation

  • 0007 - Lieutenant - Management API

  • 0008 - Platform Configuration Management

  • 0009 - Steward Cluster Agent

  • 0015 - Secrets Management

  • 0017 - Maintenance with Renovate

  • 0019 - GitOps

  • 0020 - OpenShift Hive

  • 0021 - Cluster Catalog Compilation

  • 0022 - Managed Services in Cluster

  • 0023 - Managed Services Controller

  • 0024 - Project Syn Tools Naming Scheme v2

  • 0025 - Commodore Component Instantiation

  • 0026 - Commodore Component Testing

  • 0027 - Dynamic Cluster Facts

  • 0028 - Reusable Commodore Component Configuration Packages

  • 0030 - Project Syn ArgoCD Multi-Tenant Support

  • 0031 - Central Component Version tracking

  • 0032 - Commodore Compile Pipeline

  • 0033 - Commodore Component Instance Versioning

API Personas Container image versions

Copyright © VSHN 2021 – All Rights Reserved. Privacy Policy, Imprint, and Contact.