VSHN Knowledge Base
VSHN
Main website Handbook Knowledge Base Products Legal Portal Help APPUiO Cloud Docs Project Syn K8up

VSHN Application Catalog

    • Home
      • What is it?
      • Why does it exist?
      • Concept
      • Glossary
    • Service: PostgreSQL
      • Runbooks
        • PostgreSQLConnectionsCritical
        • Restore PostgreSQL by VSHN Database
    • Service: Redis
    • Service: MariaDB
    • Service: MinIO
    • Service: Forgejo / Codey
      • Architecture
    • Service: Exoscale DBaaS
      • Exoscale Price API
      • Runbooks
        • Manually Restore DBaaS Backup
    • CSP: Exoscale
      • Exoscale Marketplace Integration
    • CSP: APPUiO
      • Runbooks
        • Change AppCat service quota on APPUiO
    • CSP: SPKS
      • How to Investigate a Service
      • Redis
        • Redis Service Details
        • Redis Sentinel Load Balancing with HAProxy
        • Redis Fake Sentinel with HAProxy
        • Runbooks
          • How to Debug Redis Sentinel
          • How to Manually Perform a Redis Failover
          • Fix wrong/invalid leader after rollout/update
          • Alert rule: RedisClusterFlapping
          • Alert rule: RedisClusterDown
          • Alert rule: RedisDisconnectedSlaves
          • Alert rule: RedisDown
          • Alert rule: RedisKeyEviction
          • Alert rule: RedisMasterMissing
          • Alert rule: RedisMemoryHigh
          • Alert rule: RedisOutOfMemory
          • Alert rule: RedisReplicationBroken
          • Alert rule: RedisTooManyMasters
      • MariaDB Galera
        • HAProxy for MariaDB Galera Load Balancing
        • How to Access the HAPRoxy Stats Page
        • Runbooks
          • How to Debug MariaDB Galera
          • How to Find the Cluster for a Database Instance
          • How to Bootstrap a Cluster
          • Alert rule: MySQLGaleraClusterDown
          • Alert rule: MySQLGaleraClusterEvenNodes
          • Alert rule: MySQLGaleraClusterSmall
          • Alert rule: MySQLGaleraDonorFallingBehind
          • Alert rule: MySQLGaleraNotConnected
          • Alert rule: MySQLGaleraNotOperational
          • Alert rule: MySQLGaleraNotReady
          • Alert rule: MySQLGaleraOutOfSync
          • Alert rule: MySQLInnoDBLogWaits
      • Crossplane Service Broker Overview
        • Crossplane Service Broker
        • Crossplane Provider Mechanics
        • Install the Crossplane Service Broker
        • Install a Service Catalog
        • Prepare HTTP Bearer Token Authentication
        • Connect the Service Catalog to a Service Broker
        • Install Kube Token Refresher
        • Setup HTTP Basic authentication
        • How to Implement a new Service Offering
        • Setting up the Crossplane Service Broker
      • Vault
        • Vault: Auto Unseal
        • Vault: Backup and Restore
      • Enable Plan Upgrades
    • Framework
      • Framework Requirements
      • Service Maturity
      • CI/CD Processes
      • Working with Crossplane Functions
      • SLA Reports
      • Billing
        • Cloud Based AppCat Services
        • VSHN Based AppCat Services
        • Backfill Billing Data
      • AppCat Quality Requirements
        • Service Production Readiness Standards
        • Backups Can Be Exported
        • Reliability
          • Automatic Updates
          • Mandatory Updates
          • Minimum Backup Interval
        • Usability
          • Actionable Alerts
          • Declarative Configuration of Instances
          • Service Instance API Validation
          • Provisioning Time
          • Service Instance Logs
      • Runbooks
        • Alert rule: AppCatBackupJobError
        • Alert rule: GuaranteedUptimeTarget
        • Alert rule: AppCatHighAvailableStatefulsetWarning
        • Alert rule: AppCatHighAvailableDeploymentWarning
    • Control Plane
      • Central Control Plane (CCP)
      • Crossplane Split Architecture
      • SLI Prober
    • ADRs
      • Working with ADRs
      • ADR 0001 - Architecture Decision Records
      • ADR 0002 - Service Documentation
      • ADR 0003 - StackGres Operator for PostgreSQL
      • ADR 0004 - PostgreSQL Metrics Exporter
      • ADR 0005 - Automated PostgreSQL Service Upgrades
      • ADR 0006 - Bitnami Helm Chart for Redis
      • ADR 0007 - Automated Redis Service Upgrades
      • ADR 0008 - Bitnami Helm Chart for MariaDB
      • ADR 0009 - ProxySQL for MariaDB Clustering
      • ADR 0010 - MinIO for Local Object Storage
      • ADR 0011 - Monitor Object Bucket with Probe
      • ADR 0012 - Converged Service in Managed Namespace
      • ADR 0013 - Use Logging Facilities of Platform
      • ADR 0014 - Commodore Component to Deploy Compositions and XRDs
      • ADR 0015 - Metrics and Monitoring of Services
      • ADR 0016 - Service API Design
      • ADR 0017 - Handling of Capacity Alerts for Incident Prevention
      • ADR 0018 - SLA Reports Handling
      • ADR 0019 - Deletion Protection with Validating Webhook
      • ADR 0020 - User Management in Service Instances
      • ADR 0021 - Composition Function Error Handling
      • ADR 0022 - Replace API Server by Custom Resources
      • ADR 0023 - Releasee Process for AppCat Components
      • ADR 0024 - Product Choice for Secret Management
      • ADR 0025 - Nextcloud Deployment with Helm Chart
      • ADR 0026 - Deploy MongoDB with Operator
      • ADR 0027 - Keycloak Deployment with Helm Chart
      • ADR 0028 - SLI Prober for Object Storage
      • ADR 0029 - Converged Service Provisioning Implementation
VSHN Application Catalog master
  • APPUiO Cloud for System Engineers
    • master
  • APPUiO Managed Kubernetes Services
    • master
  • APPUiO Managed OpenShift 4
    • master
  • VSHN Application Catalog
    • master
  • VSHN AppOps and AppFlow for VSHNeers
    • master
  • VSHN Corporate Technology
    • master
  • VSHN Knowledge Base
    • master
  • VSHN Managed Service
    • master
  • VSHN Application Catalog
  • ADRs
  • ADR 0002 - Service Documentation
Edit this Page

ADR 0002 - Service Documentation

Author

Tobias Brunner

Owner

Schedar

Reviewers

Schedar

Date Created

2025-01-06

Date Updated

2025-01-06

Status

draft

Tags

processes
Summary

TODO

Context

Decision

Consequences

ADR 0001 - Architecture Decision Records ADR 0003 - StackGres Operator for PostgreSQL

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