From 885c5c9ac024c3073d6537f7973c1190cdc55354 Mon Sep 17 00:00:00 2001 From: Martin McCaffery Date: Fri, 19 Dec 2025 15:43:07 +0100 Subject: [PATCH] Fix broken links throughout docs --- content/en/docs/edgeconnect/_index.md | 6 +-- .../en/docs/edgeconnect/edgeconnect-client.md | 4 +- .../en/docs/edgeconnect/edgeconnect-sdk.md | 6 +-- .../en/docs/edgeconnect/terraform-provider.md | 2 +- .../infrastructure/stacks/_index.md | 17 ++------ content/en/docs/edp/forgejo/actions/_index.md | 14 +++---- .../edp/forgejo/actions/runners/_index.md | 16 +++----- .../docs/edp/forgejo/actions/runners/garm.md | 41 ++----------------- content/en/docs/edp/forgejo/project-mgmt.md | 6 +-- 9 files changed, 30 insertions(+), 82 deletions(-) diff --git a/content/en/docs/edgeconnect/_index.md b/content/en/docs/edgeconnect/_index.md index 97cc64c..4c419d3 100644 --- a/content/en/docs/edgeconnect/_index.md +++ b/content/en/docs/edgeconnect/_index.md @@ -10,7 +10,7 @@ description: > EdgeConnect is a custom cloud provided by the project as a whole. It has several goals, including retaining sovereign control over cloud compute resources, and supporting sustainability-aware infrastructure choices. -While EdgeConnect is managed outwith our Edge Developer Platform, we have produced a number of tools to facilitate its use and broaden its applicability. These are an [SDK](/docs/components/deployments/edgeconnect/edgeconnect-sdk/), command-line [client](/docs/components/deployments/edgeconnect/edgeconnect-client/), bespoke [provider](/docs/components/orchestration/infrastructure/provider/) for [Terraform](https://developer.hashicorp.com/terraform), and tailor-made [Forgejo Actions](/docs/edgeconnect/edgeconnect-actions/). +While EdgeConnect is managed outwith our Edge Developer Platform, we have produced a number of tools to facilitate its use and broaden its applicability. These are an [SDK](/docs/edgeconnect/edgeconnect-sdk/), command-line [client](/docs/edgeconnect/edgeconnect-client/), bespoke [provider](/docs/edgeconnect/terraform-provider/) for [Terraform](https://developer.hashicorp.com/terraform), and tailor-made [Forgejo Actions](/docs/edgeconnect/edgeconnect-actions/). {{< likec4-view view="edgeconnect-context" project="architecture" title="EdgeConnect Context View: Users, Tooling and Control Plane" >}} @@ -24,8 +24,8 @@ EDP appears here as an external consumer: it can automate provisioning and deplo * Managed by the broader project, not specifically by EDP * Focus on sovereignty and sustainability -* Utilities such as [CLI](/docs/components/deployments/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/components/orchestration/infrastructure/provider/) encourage widespread platform use -* [EDP](/docs/edp/) products such as [Forgejo](/docs/components/forgejo/) are hosted on [OTC](/docs/components/deployments/otc/) rather than EdgeConnect +* Utilities such as [CLI](/docs/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/edgeconnect/terraform-provider/) encourage widespread platform use +* [EDP](/docs/edp/) products such as [Forgejo](/docs/edp/forgejo/) are hosted on [OTC](/docs/edp/deployment/otc/) rather than EdgeConnect ## Purpose in EDP diff --git a/content/en/docs/edgeconnect/edgeconnect-client.md b/content/en/docs/edgeconnect/edgeconnect-client.md index 1e254ea..5e1aeb1 100644 --- a/content/en/docs/edgeconnect/edgeconnect-client.md +++ b/content/en/docs/edgeconnect/edgeconnect-client.md @@ -8,7 +8,7 @@ description: > ## Overview -The EdgeConnect Client is a command-line tool for managing EdgeConnect applications and instances. It is built using our Golang [SDK](/docs/components/deployments/edgeconnect/edgeconnect-sdk/), and supports functionality to create, destroy, describe and list various resources. +The EdgeConnect Client is a command-line tool for managing EdgeConnect applications and instances. It is built using our Golang [SDK](/docs/edgeconnect/edgeconnect-sdk/), and supports functionality to create, destroy, describe and list various resources. The tool provides both imperative commands (for direct resource management) and declarative workflows (using YAML configuration files) to deploy applications across multiple edge cloudlets. It supports different EdgeConnect deployment environments through an API version selector. @@ -240,7 +240,7 @@ spec: ## Additional Resources -* [EdgeConnect SDK Documentation](/docs/components/deployments/edgeconnect/edgeconnect-sdk/) +* [EdgeConnect SDK Documentation](/docs/edgeconnect/edgeconnect-sdk/) * **Edge Cloud**: [Console](https://hub.apps.edge.platform.mg3.mdb.osc.live/) | [API Docs](https://swagger.edge.platform.mg3.mdb.osc.live/) * **Orca Cloud**: [Console](https://hub.apps.orca.platform.mg3.mdb.osc.live/) | [API Docs](https://swagger.orca.platform.mg3.mdb.osc.live/) * [Source Code Repository](https://edp.buildth.ing/DevFW-CICD/edge-connect-client) diff --git a/content/en/docs/edgeconnect/edgeconnect-sdk.md b/content/en/docs/edgeconnect/edgeconnect-sdk.md index 013eec1..7b8046b 100644 --- a/content/en/docs/edgeconnect/edgeconnect-sdk.md +++ b/content/en/docs/edgeconnect/edgeconnect-sdk.md @@ -8,7 +8,7 @@ description: > ## Overview -The EdgeConnect SDK is a Go library which provides a simple method for interacting with Edge Connect within programs. It is designed to be used by other tools, such as the [EdgeConnect Client](/docs/components/deployments/edgeconnect/edgeconnect-client/) or [Terraform provider](/docs/components/orchestration/infrastructure/provider/), +The EdgeConnect SDK is a Go library which provides a simple method for interacting with Edge Connect within programs. It is designed to be used by other tools, such as the [EdgeConnect Client](/docs/edgeconnect/edgeconnect-client/) or [Terraform provider](/docs/edgeconnect/terraform-provider/), ## Key Features @@ -18,7 +18,7 @@ The EdgeConnect SDK is a Go library which provides a simple method for interacti ## Purpose in EDP -No system can be considered useful unless it is actually, in practice, used. While the Edge Connect [console](https://hub.apps.edge.platform.mg3.mdb.osc.live/) and [API](https://swagger.edge.platform.mg3.mdb.osc.live/) are essential tools to allow the platform to be used by developers, there are numerous use cases for interaction that is automated but simpler to use than an API. These include a [command-line tool](/docs/components/deployments/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/components/orchestration/infrastructure/provider/). +No system can be considered useful unless it is actually, in practice, used. While the Edge Connect [console](https://hub.apps.edge.platform.mg3.mdb.osc.live/) and [API](https://swagger.edge.platform.mg3.mdb.osc.live/) are essential tools to allow the platform to be used by developers, there are numerous use cases for interaction that is automated but simpler to use than an API. These include a [command-line tool](/docs/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/edgeconnect/terraform-provider/). While each such tool could simply independently wrap existing endpoints, this is generally too low-level for sustainable development. It would involve extensive boilerplate code in each such package, plus small changes to API endpoints or error handling may require constant rework. @@ -51,7 +51,7 @@ To avoid this, the Edge Connect SDK aims to provide a common library for interac ## Usage Examples -See [README](https://edp.buildth.ing/DevFW-CICD/edge-connect-client/src/branch/main/sdk#examples) for simple code examples, or repositories for [EdgeConnect Client](/docs/components/deployments/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/components/orchestration/infrastructure/provider/) for full projects relying on it. +See [README](https://edp.buildth.ing/DevFW-CICD/edge-connect-client/src/branch/main/sdk#examples) for simple code examples, or repositories for [EdgeConnect Client](/docs/edgeconnect/edgeconnect-client/) and [Terraform provider](/docs/edgeconnect/terraform-provider/) for full projects relying on it. ## Troubleshooting diff --git a/content/en/docs/edgeconnect/terraform-provider.md b/content/en/docs/edgeconnect/terraform-provider.md index b6bc371..5dbbd4c 100644 --- a/content/en/docs/edgeconnect/terraform-provider.md +++ b/content/en/docs/edgeconnect/terraform-provider.md @@ -22,7 +22,7 @@ Interacting with infrastructure is a complex process, with many parameters and c Instead, automations are possible through APIs and SDKs. Working directly with an API (e.g. via `curl`) inevitably tends to involve large amounts of boilerplate code to manage authentication, rarely-changing configuration such as region/tenant selection, and more. When one resource (say, a web server) must interact with another (say, a DNS record), the cross-references further increase this complexity. -An SDK mitigates this complexity when coding software, by providing library functions which interact with the API in abstracted ways which require a minimum of necessary information. Our SDK for Edge Connect is described in a [separate section](/docs/components/deployments/edgeconnect/edgeconnect-sdk/). +An SDK mitigates this complexity when coding software, by providing library functions which interact with the API in abstracted ways which require a minimum of necessary information. Our SDK for Edge Connect is described in a [separate section](/docs/edgeconnect/edgeconnect-sdk/). However, when simply wanting to deploy infrastructure in isolation - say, updating the status of a Kubernetes or App resource after a change in configuration - an SDK is still an overly complicated tool. diff --git a/content/en/docs/edp/deployment/infrastructure/stacks/_index.md b/content/en/docs/edp/deployment/infrastructure/stacks/_index.md index a7a9dcb..d4b44fb 100644 --- a/content/en/docs/edp/deployment/infrastructure/stacks/_index.md +++ b/content/en/docs/edp/deployment/infrastructure/stacks/_index.md @@ -6,17 +6,6 @@ description: > Platform-level component provisioning via Stacks --- -{{% alert title="Draft" color="" %}} -**Editorial Status**: This page is currently being developed. - -* **Jira Ticket**: [TICKET-6729](https://jira.telekom-mms.com/browse/IPCEICIS-6729) -* **Assignee**: Stephan -* **Status**: Waiting for Review -* **Last Updated**: 2025-11-30 -* **TODO**: - * [ ] Review and finalize content -{{% /alert %}} - ## Overview The `stacks` and `stacks-instances` repositories form the core of a GitOps-based system for provisioning Edge Developer Platforms (EDP). They implement a template-instance pattern that enables the deployment of reusable platform components across different environments. The concept of "stacks" originates from the CNOE.io project (Cloud Native Operational Excellence), which can be traced through the evolutionary development from `edpbuilder` (derived from CNOE.io's `EDPbuilder`) to `infra-deploy`. @@ -117,7 +106,7 @@ A 'stack' is the declarative description for the platform provisionning in an ED ## Repository -**Code**: +**Code**: * [Stacks Templates Repo](https://edp.buildth.ing/DevFW-CICD/stacks) * [Stacks Instances Repo, used for ArgoCD Gitops](https://edp.buildth.ing/DevFW-CICD/stacks-instances) * [EDP Stacks Deployment mechanism](https://edp.buildth.ing/DevFW/infra-deploy) @@ -262,7 +251,7 @@ Terragrunt Stacks provision: The script `scripts/edp-install.sh` executes the following steps: -1. **Template Hydration**: +1. **Template Hydration**: - Checkout of the `stacks` repository - Execution of Gomplate to resolve template variables - Generation of environment-specific manifests @@ -508,7 +497,7 @@ So imagine, you want to to the stacks 'core,observability' on your local machine kind delete clusters --all ./scripts/ensure-kind-cluster.sh -r -# provide some emnv vars +# provide some emnv vars export TERRAFORM=/bin/bash export LOADBALANCER_ID=ABC export DOMAIN=ABC diff --git a/content/en/docs/edp/forgejo/actions/_index.md b/content/en/docs/edp/forgejo/actions/_index.md index 6faf101..7dbf9ed 100644 --- a/content/en/docs/edp/forgejo/actions/_index.md +++ b/content/en/docs/edp/forgejo/actions/_index.md @@ -5,11 +5,9 @@ weight: 10 description: GitHub Actions-compatible CI/CD automation --- - - ## Overview -Forgejo Actions is a built-in CI/CD automation system that enables developers to define and execute workflows directly within their Forgejo repositories. As a continuous integration and continuous deployment platform, Forgejo Actions automates software development tasks such as building, testing, packaging, and deploying applications whenever specific events occur in your repository. +[Forgejo Actions](https://forgejo.org/docs/next/user/actions/reference/) is a built-in CI/CD automation system that enables developers to define and execute workflows directly within their Forgejo repositories. As a continuous integration and continuous deployment platform, Forgejo Actions automates software development tasks such as building, testing, packaging, and deploying applications whenever specific events occur in your repository. Forgejo Actions provides [GitHub Actions similarity](https://forgejo.org/docs/latest/user/actions/github-actions/), allowing teams to easily adapt existing GitHub Actions workflows and marketplace actions with minimal or no modifications. This compatibility significantly reduces migration effort for teams transitioning from GitHub to Forgejo, while maintaining familiar syntax and workflow patterns. @@ -35,7 +33,7 @@ Since Forgejo Actions is natively integrated into Forgejo, EDP provides this cri ### Prerequisites * Installed Forgejo -* Installed Forgejo runner (see [Runner Installation Quick Start](/docs/components/forgejo/actions/runner/#quick-start)) +* Installed Forgejo runner (see [Runner Installation Quick Start](/docs/edp/forgejo/actions/runners/#quick-start)) ### Quick Start @@ -125,10 +123,10 @@ jobs: ## Status -**Maturity**: [Production / Beta / Experimental] +**Maturity**: Production ## Additional Resources -* [Link to external documentation] -* [Link to community resources] -* [Link to related components] +* [Forgejo Actions](https://forgejo.org/docs/next/user/actions/reference/) +* [GitHub Actions](https://github.com/features/actions) +* [GitHub Actions similarity](https://forgejo.org/docs/latest/user/actions/github-actions/) diff --git a/content/en/docs/edp/forgejo/actions/runners/_index.md b/content/en/docs/edp/forgejo/actions/runners/_index.md index c66f4c2..f54a8e4 100644 --- a/content/en/docs/edp/forgejo/actions/runners/_index.md +++ b/content/en/docs/edp/forgejo/actions/runners/_index.md @@ -18,9 +18,9 @@ This document explores different runner architectures, examining their security ## Key Features -* [Feature 1] -* [Feature 2] -* [Feature 3] +* Consistent environment for Forgejo Actions +* Primary location to execute code e.g. deployments +* Good [security practices](/docs/edp/forgejo/actions/runners/garm/) essential due to broad remit ## Purpose in EDP @@ -155,11 +155,11 @@ Alternatives to `docker` are [`lxc`](https://forgejo.org/docs/latest/admin/actio ## Troubleshooting -### In containerized environments, i want to build container images +### In containerized environments, I want to build container images **Problem**: In containerized environment, containers usually do not have many privileges. To start or build containers additional privleges, usually root is required inside of the kernel, the container runtime needs to manage linux namespaces and cgroups. -**Solution**: A partial solution for this is `buildkitd` utilizing `rootlesskit`. This allows containers to be **built** in a non root environment. You can find examples here: [Examples](https://github.com/moby/buildkit/tree/master/examples/kubernetes). +**Solution**: A partial solution for this is `buildkitd` utilizing `rootlesskit`. This allows containers to be **built** (but not run) in a non root environment. Several examples can be found in the [official buildkit repo](https://github.com/moby/buildkit/tree/master/examples/kubernetes). ***Rootless vs User namespaces:*** @@ -169,14 +169,10 @@ Rootless is considered the more secure version, as the executable is mapped to a ## Status -**Maturity**: [Production / Beta / Experimental] +**Maturity**: Beta ## Additional Resources * [Forgejo Runner installation guide](https://forgejo.org/docs/latest/admin/actions/runner-installation) * [Static Runners on Kubernetes](https://edp.buildth.ing/DevFW-CICD/stacks/src/branch/main/template/stacks/forgejo/forgejo-runner/dind-docker.yaml) * [Runner Orchestartion using GARM on Edge Connect](../runner-orchestration) - -## Documentation Notes - -[Instructions for team members filling in this documentation - remove this section once complete] diff --git a/content/en/docs/edp/forgejo/actions/runners/garm.md b/content/en/docs/edp/forgejo/actions/runners/garm.md index 1c0c1b5..75e1896 100644 --- a/content/en/docs/edp/forgejo/actions/runners/garm.md +++ b/content/en/docs/edp/forgejo/actions/runners/garm.md @@ -29,8 +29,6 @@ A custom edge-connect provider was implemented for GARM to enable infrastructure - [GARM deploy script](https://edp.buildth.ing/DevFW/infra-deploy/src/branch/main/scripts/local-helm.sh) - [GARM deploy manifests](https://edp.buildth.ing/DevFW/garm-deploy.git) -**Documentation**: [Link to component-specific documentation] - ## Getting Started ### Prerequisites @@ -95,22 +93,6 @@ The diagram below shows how a trigger of an action results in deployment of a ru {{}} -[Add infrastructure and deployment diagrams showing how the component is deployed] - -TODO c4 - -- Garm Container in OTC Kubernetes -- Garm-Provider in Garm Container -- Garm in Garm container -- EDP in OTC Kubernetes -- Forgejo Runner in Edge Connect -- EDP --notifies with webhook--> Garm -- Garm --calls--> EDP -- Garm --calls--> garm provider -- garm provider --provisions instance--> Forgejo runner -- Forgejo runner --retrieves bootstrap information-->Garm -- Forgejo runner --picks up job--> EDP - ## Configuration ### Provider Setup @@ -184,28 +166,11 @@ garm-cli gitea credentials add \ Now, connect to the WebUI, use `GARM_ADMIN_USERNAME` and `GARM_ADMIN_PASSWORD` as credentials to authenticate. Click on repositories and -## Troubleshooting - -### [Common Issue 1] - -**Problem**: [Description] - -**Solution**: [How to fix] - -### [Common Issue 2] - -**Problem**: [Description] - -**Solution**: [How to fix] - ## Status -**Maturity**: [Production / Beta / Experimental] +**Maturity**: Beta ## Additional Resources -* [Using GARM](https://github.com/cloudbase/garm/blob/main/doc/using_garm.md) - -## Documentation Notes - -[Instructions for team members filling in this documentation - remove this section once complete] +* [GARM repository](https://github.com/cloudbase/garm) + * [How to use](https://github.com/cloudbase/garm/blob/main/doc/using_garm.md) diff --git a/content/en/docs/edp/forgejo/project-mgmt.md b/content/en/docs/edp/forgejo/project-mgmt.md index 702bd66..01fb113 100644 --- a/content/en/docs/edp/forgejo/project-mgmt.md +++ b/content/en/docs/edp/forgejo/project-mgmt.md @@ -1,9 +1,9 @@ --- -title: "Project Management" -linkTitle: "Forgejo Project Mgmt" +title: Project Management in Forgejo +linkTitle: Project Management weight: 50 description: > - Organization-level project and issue management (discontinued feature) + Organization-level project and issue management --- {{% alert title="Discontinued Feature" color="warning" %}}