diff options
Diffstat (limited to 'templates/infrastructure')
| -rw-r--r-- | templates/infrastructure/cloud-architecture.org | 21 | ||||
| -rw-r--r-- | templates/infrastructure/infra-change-log.org | 14 | ||||
| -rw-r--r-- | templates/infrastructure/infra-doc-checklist.org | 12 | ||||
| -rw-r--r-- | templates/infrastructure/infra-inventory.org | 15 | ||||
| -rw-r--r-- | templates/infrastructure/network-diagram.org | 16 | ||||
| -rw-r--r-- | templates/infrastructure/system-architecture.org | 23 | ||||
| -rw-r--r-- | templates/infrastructure/terraform-module-doc.org | 24 |
7 files changed, 125 insertions, 0 deletions
diff --git a/templates/infrastructure/cloud-architecture.org b/templates/infrastructure/cloud-architecture.org new file mode 100644 index 0000000..e6725ee --- /dev/null +++ b/templates/infrastructure/cloud-architecture.org @@ -0,0 +1,21 @@ +#+TITLE: Cloud Architecture - [System or App] +#+DATE: %<%Y-%m-%d> +#+FILETAGS: :infra:cloud: + +* Overview +This document outlines the cloud setup for [System Name]. + +* AWS Resources +| Type | Name | Region | Notes | +|---------------+------------+------------+---------------| +| EC2 Instance | app-prod | us-west-1 | t3.micro | +| RDS | pg-main | us-west-1 | PostgreSQL 14 | + +* Networking +- VPC: vpc-123abc +- Subnets: Public / Private +- Security Groups: SG-web, SG-db + +* Monitoring / Observability +- CloudWatch +- Prometheus
\ No newline at end of file diff --git a/templates/infrastructure/infra-change-log.org b/templates/infrastructure/infra-change-log.org new file mode 100644 index 0000000..6ff2bc2 --- /dev/null +++ b/templates/infrastructure/infra-change-log.org @@ -0,0 +1,14 @@ +#+TITLE: Infrastructure Change Log +#+FILETAGS: :infra:changelog: + +* %<%Y-%m-%d> +** [Component] nginx config update +- Changed SSL certificate +- Reloaded nginx + +** [Component] Terraform apply on staging +- Added S3 bucket + +* %<%Y-%m-%d> +** [Component] PostgreSQL backup settings +- Enabled WAL archiving
\ No newline at end of file diff --git a/templates/infrastructure/infra-doc-checklist.org b/templates/infrastructure/infra-doc-checklist.org new file mode 100644 index 0000000..f844206 --- /dev/null +++ b/templates/infrastructure/infra-doc-checklist.org @@ -0,0 +1,12 @@ +#+TITLE: Infrastructure Documentation Checklist +#+FILETAGS: :infra:meta: + +* Checklist +- [ ] Architecture overview +- [ ] Diagrams +- [ ] Component breakdown +- [ ] Network layout +- [ ] Access controls +- [ ] Backup & recovery +- [ ] Change history +- [ ] Monitoring setup
\ No newline at end of file diff --git a/templates/infrastructure/infra-inventory.org b/templates/infrastructure/infra-inventory.org new file mode 100644 index 0000000..58068b9 --- /dev/null +++ b/templates/infrastructure/infra-inventory.org @@ -0,0 +1,15 @@ +#+TITLE: Infrastructure Inventory +#+DATE: %<%Y-%m-%d> +#+FILETAGS: :infra:inventory: + +* Servers +| Hostname | Role | IP Address | OS | Notes | +|---------------+----------+--------------+-----------+-------------| +| app01 | app | 192.168.1.10 | Ubuntu 22 | Production | +| db01 | database | 192.168.1.20 | Debian 11 | PostgreSQL | + +* Services +| Name | Port | Status | +|-----------+------+------------| +| nginx | 443 | running | +| postgres | 5432 | running |
\ No newline at end of file diff --git a/templates/infrastructure/network-diagram.org b/templates/infrastructure/network-diagram.org new file mode 100644 index 0000000..e22edd0 --- /dev/null +++ b/templates/infrastructure/network-diagram.org @@ -0,0 +1,16 @@ +#+TITLE: Network Diagram - [Environment Name] +#+FILETAGS: :infra:network: + +* Overview + +* Layout + +#+BEGIN_SRC dot :file network-diagram.png :exports results :cmdline -Tpng +graph G { + "Internet" -- "Load Balancer" + "Load Balancer" -- "App Servers" + "App Servers" -- "Database" +} +#+END_SRC + +* Notes
\ No newline at end of file diff --git a/templates/infrastructure/system-architecture.org b/templates/infrastructure/system-architecture.org new file mode 100644 index 0000000..6d1a24e --- /dev/null +++ b/templates/infrastructure/system-architecture.org @@ -0,0 +1,23 @@ +#+TITLE: System Architecture - [System Name] +#+DATE: %<%Y-%m-%d> +#+FILETAGS: :infra:architecture: + +* Overview +Brief description of the system or service. + +* Components +- Component A: Description +- Component B: Description + +* Data Flow + +#+BEGIN_SRC dot :file dataflow.png :exports results :cmdline -Tpng +digraph G { + Client -> API -> Worker -> DB; +} +#+END_SRC + +* Dependencies + +* Diagrams +Attach or link to diagrams here.
\ No newline at end of file diff --git a/templates/infrastructure/terraform-module-doc.org b/templates/infrastructure/terraform-module-doc.org new file mode 100644 index 0000000..016819a --- /dev/null +++ b/templates/infrastructure/terraform-module-doc.org @@ -0,0 +1,24 @@ +#+TITLE: Terraform Module Documentation - [Module Name] +#+FILETAGS: :infra:terraform: + +* Description + +* Input Variables +| Name | Type | Default | Description | +|-----------+--------+---------+------------------------| +| region | string | us-east-1 | AWS region | +| instance_type | string | t3.micro | EC2 instance type | + +* Outputs +| Name | Description | +|----------+---------------------| +| instance_id | ID of the EC2 instance | + +* Example Usage +#+BEGIN_SRC terraform +module "example" { + source = "./modules/example" + region = "us-west-1" + instance_type = "t3.micro" +} +#+END_SRC
\ No newline at end of file |