From 1853f37f539424bebfdba1285e4bc6b9a3711abd Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 26 Nov 2025 23:08:46 +0100 Subject: [PATCH] docs(components): added review comments on PCEICIS-6732, terraform --- .../orchestration/infrastructure/terraform.md | 47 +++++++------------ 1 file changed, 18 insertions(+), 29 deletions(-) diff --git a/content/en/docs/components/orchestration/infrastructure/terraform.md b/content/en/docs/components/orchestration/infrastructure/terraform.md index f341d07..bfb835e 100644 --- a/content/en/docs/components/orchestration/infrastructure/terraform.md +++ b/content/en/docs/components/orchestration/infrastructure/terraform.md @@ -12,19 +12,21 @@ description: > * **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732) * **Assignee**: Martin * **Status**: Draft -* **Last Updated**: 2025-11-19 +* **Last Updated**: 2025-11-26 * **TODO**: * [x] Add detailed component description * [ ] Include usage examples and code samples * [ ] Add architecture diagrams * [ ] Review and finalize content +* **Review**: + * 2025-11-26: Review from Stephan inline {{% /alert %}} ## Overview The [infra-deploy](https://edp.buildth.ing/DevFW/infra-deploy) and [infra-catalogue](https://edp.buildth.ing/DevFW/infra-catalogue) repositories work together to provide a framework for deploying Edge Developer Platform instances. -`infra-catalogue` contains individual, atomic infrastructure components: `terraform` modules and `terragrunt` [units](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/units) and [stacks](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/stacks), such as [Kubernetes cluster](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/modules/kubernetes)s and [Postgres database](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/units/postgres/terragrunt.hcl)s. +`infra-catalogue` contains individual, atomic infrastructure components: `terraform` modules and `terragrunt` [units](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/units) and [stacks](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/stacks), such as [Kubernetes clusters](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/modules/kubernetes) and [Postgres databases](https://edp.buildth.ing/DevFW/infra-catalogue/src/branch/main/units/postgres/terragrunt.hcl). `infra-deploy` then contains full [definitions](https://edp.buildth.ing/DevFW/infra-deploy/src/branch/main/prod) of stacks built using these components - such as the production site at [edp.buildth.ing](https://edp.buildth.ing/DevFW/infra-deploy/src/branch/main/prod/edp). It also includes [scripts](https://edp.buildth.ing/DevFW/infra-deploy/src/branch/main/scripts) with which to deploy these stacks. @@ -68,54 +70,40 @@ Alternatively, manually trigger automated [deployment pipeline](https://edp.buil ### Verification +> Stephan: 1. Typo: prod and non prod are the same domain name +> Stephan: 2. Pls provide a link into the config where is specified + After the deploymenet completes, and a short startup time, you should be able to access your Forgejo instance at `.buildth.ing` (production tenant) or `.buildth.ing` (non-prod tenant). For example, the primary production cluster is called [edp](https://edp.buildth.ing/DevFW/infra-deploy/src/branch/main/prod/edp) and can be accessed at [edp.buildth.ing](https://edp.buildth.ing). -## Integration Points - -* **[Component A]**: [How it integrates] -* **[Component B]**: [How it integrates] -* **[Component C]**: [How it integrates] - -## Architecture - -[Optional: Add architectural diagrams and descriptions] - -### Component Architecture (C4) - -[Add C4 Container or Component diagrams showing the internal structure] - -### Sequence Diagrams - -[Add sequence diagrams showing key interaction flows with other components] - -### Deployment Architecture - -[Add infrastructure and deployment diagrams showing how the component is deployed] +#### Screens +> Stephan: Perhaps some significant screenshots here from the CLI, OTC (during deployment), pipeline logs ... otherweise we will forget what it looked like on our machines in 2025 ;-) + ## Configuration +> Stephan: perhaps another link to the READMEs how config is done? + [Key configuration options and how to set them] ## Troubleshooting ### [Common Issue 1] -**Problem**: [Description] - -**Solution**: [How to fix] - -### [Common Issue 2] +> Stephan: are there problems left with versioning? **Problem**: [Description] **Solution**: [How to fix] + ## Status -**Maturity**: [Production / Beta / Experimental] +**Maturity**: TRL-9 ## Additional Resources +> Stephan: perhaps terraform/terragrunt links? + * [Link to external documentation] * [Link to community resources] * [Link to related components] @@ -123,3 +111,4 @@ After the deploymenet completes, and a short startup time, you should be able to ## Documentation Notes Unsure if remaining sections are useful. +> Stephan: I removed sections which I also don't see useful, and added hints/ideas for content to the rest