cluster-docs

git clone git://archive.git.mtrnord.blog/MTRNord/cluster-docs.git
Log | Files | Refs

.template.adoc (1935B)


      1 = {APPLICATION_NAME} Template
      2 :author: MTRNord
      3 :revnumber: 1.0
      4 :revdate: 2025-03-20
      5 
      6 The description of the application goes here.
      7 
      8 == Application Overview
      9 
     10 - **Git Repository**: [Insert repository URL] - The Git repository where the Project is available at.
     11 - **Deployed Version**: [Insert version] - The version of the application deployed in the cluster.
     12 - **Namespace**: [Insert namespace] - The Kubernetes namespace where the application is deployed.
     13 - **Helm Chart**: [Insert chart name or path] - If applicable, the Helm chart used to deploy the application.
     14 - **Address**: [Insert application URL] - The URL where the application can be accessed.
     15 - **Monitoring**: [Insert monitoring URL] - The URL where the monitoring dashboard can be accessed.
     16 - **Are Alerts setup?**: [Insert yes/no] - If alerts are setup for the application.
     17 - **Backups**: [Insert backup strategy] - The backup strategy used for the application.
     18 
     19 == Application Components
     20 
     21 === Volumes
     22 
     23 [cols="2,2,2,2"]
     24 |===
     25 | Name | Size | Storageclass | Description 
     26 | [Insert volume name] | [Insert volume size] | [Insert volume type] | [Insert volume description]
     27 | [Insert volume name] | [Insert volume size] | [Insert volume type] | [Insert volume description]
     28 |===
     29 
     30 === Databases
     31 
     32 [cols="2,2,2,2"]
     33 |===
     34 | Name | Table | User | Description
     35 | [Insert database name] | [Insert database version] | [Insert database type] | [Insert database description]
     36 | [Insert database name] | [Insert database version] | [Insert database type] | [Insert database description]
     37 |===
     38 
     39 === Other Components it uses
     40 
     41 [cols="2,2,2,2"]
     42 |===
     43 | Name | Version | Type | Description
     44 | [Insert component name] | [Insert component version] | [Insert component type] | [Insert component description]
     45 | [Insert component name] | [Insert component version] | [Insert component type] | [Insert component description]
     46 |===
     47 
     48 == Recovery Procedures
     49 
     50 How to recover the application in case of failure.