docs(components): added review comments on PCEICIS-6732, terraform
This commit is contained in:
parent
64d7c77b6f
commit
1853f37f53
1 changed files with 18 additions and 29 deletions
|
|
@ -12,19 +12,21 @@ description: >
|
||||||
* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)
|
* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)
|
||||||
* **Assignee**: Martin
|
* **Assignee**: Martin
|
||||||
* **Status**: Draft
|
* **Status**: Draft
|
||||||
* **Last Updated**: 2025-11-19
|
* **Last Updated**: 2025-11-26
|
||||||
* **TODO**:
|
* **TODO**:
|
||||||
* [x] Add detailed component description
|
* [x] Add detailed component description
|
||||||
* [ ] Include usage examples and code samples
|
* [ ] Include usage examples and code samples
|
||||||
* [ ] Add architecture diagrams
|
* [ ] Add architecture diagrams
|
||||||
* [ ] Review and finalize content
|
* [ ] Review and finalize content
|
||||||
|
* **Review**:
|
||||||
|
* 2025-11-26: Review from Stephan inline
|
||||||
{{% /alert %}}
|
{{% /alert %}}
|
||||||
|
|
||||||
## Overview
|
## 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.
|
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.
|
`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
|
### Verification
|
||||||
|
|
||||||
|
> Stephan: 1. Typo: prod and non prod are the same domain name
|
||||||
|
> Stephan: 2. Pls provide a link into the config where <cluster-name> is specified
|
||||||
|
|
||||||
After the deploymenet completes, and a short startup time, you should be able to access your Forgejo instance at `<cluster-name>.buildth.ing` (production tenant) or `<cluster-name>.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).
|
After the deploymenet completes, and a short startup time, you should be able to access your Forgejo instance at `<cluster-name>.buildth.ing` (production tenant) or `<cluster-name>.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
|
#### Screens
|
||||||
|
|
||||||
* **[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]
|
|
||||||
|
|
||||||
|
> 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
|
## Configuration
|
||||||
|
|
||||||
|
> Stephan: perhaps another link to the READMEs how config is done?
|
||||||
|
|
||||||
[Key configuration options and how to set them]
|
[Key configuration options and how to set them]
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### [Common Issue 1]
|
### [Common Issue 1]
|
||||||
|
|
||||||
**Problem**: [Description]
|
> Stephan: are there problems left with versioning?
|
||||||
|
|
||||||
**Solution**: [How to fix]
|
|
||||||
|
|
||||||
### [Common Issue 2]
|
|
||||||
|
|
||||||
**Problem**: [Description]
|
**Problem**: [Description]
|
||||||
|
|
||||||
**Solution**: [How to fix]
|
**Solution**: [How to fix]
|
||||||
|
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
**Maturity**: [Production / Beta / Experimental]
|
**Maturity**: TRL-9
|
||||||
|
|
||||||
## Additional Resources
|
## Additional Resources
|
||||||
|
|
||||||
|
> Stephan: perhaps terraform/terragrunt links?
|
||||||
|
|
||||||
* [Link to external documentation]
|
* [Link to external documentation]
|
||||||
* [Link to community resources]
|
* [Link to community resources]
|
||||||
* [Link to related components]
|
* [Link to related components]
|
||||||
|
|
@ -123,3 +111,4 @@ After the deploymenet completes, and a short startup time, you should be able to
|
||||||
## Documentation Notes
|
## Documentation Notes
|
||||||
|
|
||||||
Unsure if remaining sections are useful.
|
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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue