Compare commits
No commits in common. "development" and "v1.1.0" have entirely different histories.
developmen
...
v1.1.0
346 changed files with 4189 additions and 23718 deletions
|
|
@ -1 +0,0 @@
|
|||
use flake
|
||||
10
.gitignore
vendored
10
.gitignore
vendored
|
|
@ -13,12 +13,6 @@ tmp/
|
|||
# devbox
|
||||
.devbox/
|
||||
|
||||
# Task cache
|
||||
.task/
|
||||
|
||||
# Generated build data
|
||||
data/
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
|
|
@ -35,7 +29,3 @@ Thumbs.db
|
|||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
### direnv ###
|
||||
.direnv
|
||||
.envrc
|
||||
|
|
|
|||
|
|
@ -5,20 +5,6 @@ IgnoreURLs:
|
|||
- "^https://example\\.docsy\\.dev"
|
||||
- "^https://example\\.com"
|
||||
- "^http://localhost"
|
||||
- "^/livereload\\.js"
|
||||
- "^https://cnoe\\.localtest\\.me"
|
||||
- "^https://technologyconversations\\.com"
|
||||
- "^https://developers\\.redhat\\.com"
|
||||
- "^https://platformengineering\\.org"
|
||||
- "^https://cnoe\\.io"
|
||||
- "^https://console\\.otc\\.t-systems\\.com"
|
||||
IgnoreInternalURLs:
|
||||
- "/docs-old/"
|
||||
- "/blog/"
|
||||
- "/docs/v1/"
|
||||
- "/docs/architecture/"
|
||||
- "/docs/documentation/"
|
||||
IgnoreInternalEmptyHashes: true
|
||||
IgnoreDirectoryMissingTrailingSlash: true
|
||||
IgnoreAltMissing: true
|
||||
CheckDoctype: true
|
||||
|
|
|
|||
|
|
@ -4,22 +4,7 @@
|
|||
"no-inline-style": "off",
|
||||
"require-sri": "off",
|
||||
"no-trailing-whitespace": "off",
|
||||
"void-style": "off",
|
||||
"wcag/h30": "off",
|
||||
"wcag/h32": "off",
|
||||
"wcag/h37": "off",
|
||||
"no-redundant-role": "off",
|
||||
"unique-landmark": "off",
|
||||
"no-multiple-main": "off",
|
||||
"no-dup-id": "off",
|
||||
"element-permitted-content": "off",
|
||||
"attr-quotes": "off",
|
||||
"empty-heading": "off",
|
||||
"element-required-content": "off",
|
||||
"long-title": "off",
|
||||
"no-raw-characters": "off",
|
||||
"valid-id": "off",
|
||||
"doctype-style": "off"
|
||||
"void-style": "off"
|
||||
},
|
||||
"elements": [
|
||||
"html5"
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
# Ignore v1 documentation (legacy content with pre-existing lint issues)
|
||||
content/en/docs/v1/**
|
||||
content/en/blog/**
|
||||
content/en/docs-old/**
|
||||
98
DOCKER.md
Normal file
98
DOCKER.md
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
# Docker Build
|
||||
|
||||
This project uses a multi-stage Docker build that matches the local devbox development environment.
|
||||
|
||||
## Version Management
|
||||
|
||||
All tool versions are defined in `.env.versions` as the single source of truth:
|
||||
|
||||
```bash
|
||||
NODE_VERSION=24.10.0
|
||||
GO_VERSION=1.25.1
|
||||
HUGO_VERSION=0.151.0
|
||||
```
|
||||
|
||||
These versions are used in:
|
||||
|
||||
- `devbox.json` - Local development environment
|
||||
- `Dockerfile` - Docker build arguments (with defaults)
|
||||
- `.github/workflows/ci.yaml` - CI/CD pipeline
|
||||
|
||||
**Important:** When updating versions, modify `.env.versions` and sync with `devbox.json`.
|
||||
|
||||
## Local Build
|
||||
|
||||
### Using Task (recommended)
|
||||
|
||||
The easiest way to build the OCI image:
|
||||
|
||||
```bash
|
||||
task build:oci-image
|
||||
```
|
||||
|
||||
This automatically:
|
||||
|
||||
- Loads versions from `.env.versions`
|
||||
- Builds the image with correct build arguments
|
||||
- Tags with `latest` and git commit hash
|
||||
|
||||
To build and test:
|
||||
|
||||
```bash
|
||||
task test:oci-image
|
||||
```
|
||||
|
||||
### Automatic version loading
|
||||
|
||||
Use the helper script to load versions from `.env.versions`:
|
||||
|
||||
```bash
|
||||
source scripts/get-versions.sh
|
||||
```
|
||||
|
||||
This will show you the Docker build command with the correct versions.
|
||||
|
||||
### Manual build
|
||||
|
||||
```bash
|
||||
docker build --network=host \
|
||||
--build-arg NODE_VERSION=24.10.0 \
|
||||
--build-arg GO_VERSION=1.25.1 \
|
||||
--build-arg HUGO_VERSION=0.151.0 \
|
||||
-t ipceicis-developerframework:latest .
|
||||
```
|
||||
|
||||
### Test the image
|
||||
|
||||
```bash
|
||||
docker run -d -p 8080:80 --name hugo-test ipceicis-developerframework:latest
|
||||
curl http://localhost:8080
|
||||
docker stop hugo-test && docker rm hugo-test
|
||||
```
|
||||
|
||||
## CI/CD Pipeline
|
||||
|
||||
The GitHub Actions workflow (`.github/workflows/ci.yaml`) automatically:
|
||||
|
||||
1. Extracts versions from devbox environment
|
||||
2. Builds multi-arch images (amd64 + arm64)
|
||||
3. Pushes to the container registry with appropriate tags
|
||||
|
||||
### Required Secrets
|
||||
|
||||
Configure these secrets in your GitHub repository:
|
||||
|
||||
- `PACKAGES_USER`: Container registry username
|
||||
- `PACKAGES_TOKEN`: Container registry token/password
|
||||
|
||||
## Image Structure
|
||||
|
||||
- **Build Stage**: Uses Node.js base image, installs Go and Hugo
|
||||
- **Runtime Stage**: Uses nginx:alpine to serve static content (~50MB)
|
||||
|
||||
The build process:
|
||||
|
||||
1. Installs npm dependencies
|
||||
2. Downloads Hugo modules
|
||||
3. Builds static site with `hugo --gc --minify`
|
||||
4. Copies built site to minimal nginx container
|
||||
112
LIKEC4-QUICKSTART.md
Normal file
112
LIKEC4-QUICKSTART.md
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
# LikeC4 Integration - Quick Start
|
||||
|
||||
Dieses Repository enthält jetzt die LikeC4-Architekturdokumentation aus edp-doc mit vollständiger Git-Historie.
|
||||
|
||||
## Was wurde gemacht?
|
||||
|
||||
1. ✅ **LikeC4-Modelle migriert** - `resources/likec4/` enthält alle C4-Modelle mit Git-Historie
|
||||
2. ✅ **Hugo-Integration erstellt** - CSS, JS und Loader-Scripte für Hugo/Docsy
|
||||
3. ✅ **Beispielseiten erstellt** - Dokumentation unter `content/en/docs/architecture/`
|
||||
4. ✅ **Konfiguration** - `hugo.toml` und Layout-Hooks konfiguriert
|
||||
|
||||
## Nächste Schritte
|
||||
|
||||
### 1. Webcomponent generieren
|
||||
|
||||
```bash
|
||||
cd resources/likec4
|
||||
|
||||
# Dependencies installieren (nur einmalig)
|
||||
npm install
|
||||
|
||||
# Webcomponent generieren
|
||||
npx likec4 codegen webcomponent \
|
||||
--webcomponent-prefix likec4 \
|
||||
--outfile ../../static/js/likec4-webcomponent.js
|
||||
```
|
||||
|
||||
Dies erzeugt `static/js/likec4-webcomponent.js` (~2-3 MB).
|
||||
|
||||
### 2. Hugo Server starten
|
||||
|
||||
```bash
|
||||
# Im Repository-Root
|
||||
hugo server -D
|
||||
|
||||
# Öffne http://localhost:1313/docs/architecture/highlevelarch/
|
||||
```
|
||||
|
||||
### 3. Änderungen committen
|
||||
|
||||
```bash
|
||||
git add resources/likec4/
|
||||
git add static/
|
||||
git add layouts/
|
||||
git add content/en/docs/architecture/
|
||||
git add hugo.toml
|
||||
git commit -m "feat: integrate LikeC4 architecture documentation from edp-doc"
|
||||
```
|
||||
|
||||
## Verfügbare Seiten
|
||||
|
||||
- `/docs/architecture/` - Architektur-Übersicht
|
||||
- `/docs/architecture/highlevelarch/` - High-Level Architektur mit interaktivem Diagramm
|
||||
- `/docs/architecture/setup/` - Setup und Verwendungs-Anleitung
|
||||
|
||||
## Workflow für Architektur-Änderungen
|
||||
|
||||
1. **Modelle bearbeiten**: `.c4` Dateien in `resources/likec4/models/` oder `views/`
|
||||
2. **Vorschau**: `cd resources/likec4 && npx likec4 start` (öffnet http://localhost:5173)
|
||||
3. **Generieren**: Webcomponent neu generieren (siehe oben)
|
||||
4. **Testen**: Hugo Server starten und Seiten prüfen
|
||||
5. **Committen**: Sowohl `.c4` Dateien als auch `static/js/likec4-webcomponent.js`
|
||||
|
||||
## Technische Details
|
||||
|
||||
### Integration-Komponenten
|
||||
|
||||
- `resources/likec4/` - LikeC4 Quellcode (migriert mit Git-Historie)
|
||||
- `static/js/likec4-loader.js` - Dynamischer Module Loader
|
||||
- `static/css/likec4-styles.css` - Styling inkl. Dark Mode
|
||||
- `layouts/partials/hooks/head-end.html` - Hugo Hook für JS/CSS Einbindung
|
||||
- `hugo.toml` - Konfiguration (`params.likec4.enable = true`)
|
||||
|
||||
### Verwendung in Markdown
|
||||
|
||||
```html
|
||||
<div class="likec4-container">
|
||||
<div class="likec4-header">
|
||||
Dein Diagramm-Titel
|
||||
</div>
|
||||
<likec4-view view-id="otc-faas" browser="true"></likec4-view>
|
||||
<div class="likec4-loading" id="likec4-loading">
|
||||
Loading...
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Verfügbare View-IDs finden
|
||||
|
||||
```bash
|
||||
cd resources/likec4
|
||||
grep -r "view\s\+\w" views/ models/ --include="*.c4"
|
||||
```
|
||||
|
||||
## Häufige View-IDs
|
||||
|
||||
- `otc-faas` - OTC FaaS Deployment
|
||||
- `edp` - EDP Übersicht
|
||||
- `landscape` - Developer Landscape
|
||||
- `edpbuilderworkflow` - Builder Workflow
|
||||
- `keycloak`, `forgejo`, `argoCD`, etc. - Komponenten-Views
|
||||
|
||||
## Migration von edp-doc
|
||||
|
||||
Dieses Repository ist jetzt die primäre Quelle für LikeC4-Architektur. Das edp-doc Repository kann diese Modelle bei Bedarf als Git Submodule referenzieren.
|
||||
|
||||
## Support
|
||||
|
||||
Bei Problemen siehe:
|
||||
- `resources/likec4/INTEGRATION.md` - Detaillierte Integration-Dokumentation
|
||||
- `content/en/docs/architecture/setup.md` - Setup-Anleitung
|
||||
- https://likec4.dev/ - LikeC4 Dokumentation
|
||||
|
|
@ -12,11 +12,7 @@ curl -fsSL https://get.jetify.com/devbox | bash
|
|||
### Setup
|
||||
|
||||
1. Clone the repository
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
task deps:install
|
||||
```
|
||||
3. Start devbox shell:
|
||||
2. Start devbox shell:
|
||||
```bash
|
||||
devbox shell
|
||||
```
|
||||
|
|
@ -29,8 +25,6 @@ Devbox automatically installs all required tools:
|
|||
- htmltest
|
||||
- go-task
|
||||
|
||||
> **Note:** For content contributors, see [README-technicalWriter.md](./README-technicalWriter.md) for a simplified guide.
|
||||
|
||||
## 📚 Technology Stack
|
||||
|
||||
### Hugo (v0.151.0+extended)
|
||||
|
|
@ -55,22 +49,6 @@ Key directories:
|
|||
- `assets/scss/` - Custom styles
|
||||
- `static/` - Static assets (images, etc.)
|
||||
|
||||
### LikeC4 (v1.43.0)
|
||||
|
||||
LikeC4 is used for interactive architecture diagrams:
|
||||
- C4 model-based architecture visualization
|
||||
- Web Components for embedding diagrams
|
||||
- Real-time preview during development
|
||||
|
||||
Architecture models:
|
||||
- `resources/edp-likec4/` - Platform architecture models
|
||||
- `resources/doc-likec4/` - Documentation platform models
|
||||
|
||||
LikeC4 tasks available:
|
||||
- `task likec4:generate` - Generate web components
|
||||
- `task likec4:validate` - Validate C4 models
|
||||
- `task likec4:update` - Update LikeC4 version
|
||||
|
||||
### Task (Taskfile)
|
||||
|
||||
Task is a task runner / build tool that replaces Makefiles. It uses `Taskfile.yml` for defining tasks.
|
||||
|
|
@ -112,140 +90,6 @@ task deps:install # Install all dependencies
|
|||
task deps:update # Update all dependencies
|
||||
```
|
||||
|
||||
#### LikeC4
|
||||
```bash
|
||||
task likec4:generate # Generate web components from C4 models
|
||||
task likec4:validate # Validate C4 model syntax
|
||||
task likec4:update # Update LikeC4 to latest version
|
||||
```
|
||||
|
||||
#### Build & Test OCI Image
|
||||
```bash
|
||||
task build:oci-image # Build Docker/OCI image
|
||||
task test:oci-image # Build and test image
|
||||
```
|
||||
|
||||
#### CI/CD
|
||||
```bash
|
||||
task ci # Run full CI pipeline locally
|
||||
```
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
This project uses multiple automated tests for quality assurance.
|
||||
|
||||
### Test Configuration Files
|
||||
|
||||
- `.htmltest.yml` - Link checker configuration
|
||||
- `.htmlvalidate.json` - HTML validation rules
|
||||
- `.markdownlint.json` - Markdown linting rules
|
||||
|
||||
### CI/CD Integration
|
||||
|
||||
GitHub Actions runs these tests automatically on every push/PR via `.github/workflows/test.yml`.
|
||||
|
||||
### Local Development Workflow
|
||||
|
||||
**Before commit:**
|
||||
```bash
|
||||
task test:quick
|
||||
```
|
||||
|
||||
**Before push:**
|
||||
```bash
|
||||
task test
|
||||
```
|
||||
|
||||
## 🐳 Docker / Container Build
|
||||
|
||||
### Version Management
|
||||
|
||||
All tool versions are defined in `.env.versions` as the single source of truth:
|
||||
|
||||
```bash
|
||||
NODE_VERSION=24.10.0
|
||||
GO_VERSION=1.25.1
|
||||
HUGO_VERSION=0.151.0
|
||||
```
|
||||
|
||||
These versions are used in:
|
||||
- `devbox.json` - Local development (manual sync required)
|
||||
- `Dockerfile` - Build arguments with defaults
|
||||
- `.github/workflows/ci.yaml` - CI/CD pipeline (automatic)
|
||||
|
||||
**Updating versions:**
|
||||
|
||||
1. Edit `.env.versions`
|
||||
2. Manually sync `devbox.json`:
|
||||
```json
|
||||
{
|
||||
"packages": [
|
||||
"hugo@0.151.0",
|
||||
"go@1.25.1",
|
||||
"nodejs@24.10.0"
|
||||
]
|
||||
}
|
||||
```
|
||||
3. Rebuild: `devbox shell --refresh`
|
||||
|
||||
### Local Build
|
||||
|
||||
**Using Task (recommended):**
|
||||
|
||||
```bash
|
||||
task build:oci-image # Build OCI image
|
||||
task test:oci-image # Build and test
|
||||
```
|
||||
|
||||
This automatically loads versions from `.env.versions` and tags with `latest` and git commit hash.
|
||||
|
||||
**Helper script for manual builds:**
|
||||
|
||||
```bash
|
||||
source scripts/get-versions.sh
|
||||
# Shows Docker build command with correct versions
|
||||
```
|
||||
|
||||
**Manual build:**
|
||||
|
||||
```bash
|
||||
docker build --network=host \
|
||||
--build-arg NODE_VERSION=24.10.0 \
|
||||
--build-arg GO_VERSION=1.25.1 \
|
||||
--build-arg HUGO_VERSION=0.151.0 \
|
||||
-t ipceicis-developerframework:latest .
|
||||
```
|
||||
|
||||
**Test the image:**
|
||||
|
||||
```bash
|
||||
docker run -d -p 8080:80 --name hugo-test ipceicis-developerframework:latest
|
||||
curl http://localhost:8080
|
||||
docker stop hugo-test && docker rm hugo-test
|
||||
```
|
||||
|
||||
### Image Structure
|
||||
|
||||
- **Build Stage**: Node.js base, installs Go and Hugo
|
||||
- **Runtime Stage**: nginx:alpine serves static content (~50MB)
|
||||
|
||||
Build process:
|
||||
1. Install npm dependencies
|
||||
2. Download Hugo modules
|
||||
3. Build static site (`hugo --gc --minify`)
|
||||
4. Copy to nginx container
|
||||
|
||||
### CI/CD Pipeline
|
||||
|
||||
`.github/workflows/ci.yaml` automatically:
|
||||
1. Extracts versions from devbox environment
|
||||
2. Builds multi-arch images (amd64 + arm64)
|
||||
3. Pushes to container registry
|
||||
|
||||
**Required GitHub Secrets:**
|
||||
- `PACKAGES_USER` - Registry username
|
||||
- `PACKAGES_TOKEN` - Registry token/password
|
||||
|
||||
#### CI/CD
|
||||
```bash
|
||||
task ci # Run full CI pipeline locally
|
||||
|
|
@ -284,27 +128,16 @@ hugo version
|
|||
│ └── en/ # English content
|
||||
│ ├── docs/ # Documentation
|
||||
│ └── blog/ # Blog posts
|
||||
├── resources/ # LikeC4 architecture models
|
||||
│ ├── edp-likec4/ # Platform architecture (C4 models)
|
||||
│ └── doc-likec4/ # Documentation platform architecture
|
||||
├── layouts/ # Custom HTML templates
|
||||
│ └── shortcodes/ # Custom shortcodes (e.g., likec4-view)
|
||||
├── static/ # Static files
|
||||
│ └── js/ # JavaScript (LikeC4 webcomponents)
|
||||
├── assets/ # Assets (SCSS, images)
|
||||
├── public/ # Generated site (not in Git)
|
||||
├── resources/ # Hugo cache (not in Git)
|
||||
├── hugo.toml # Hugo configuration
|
||||
├── go.mod # Hugo modules (Docsy theme)
|
||||
├── Taskfile.yml # Task definitions
|
||||
├── package.json # NPM dependencies & scripts
|
||||
├── devbox.json # Devbox configuration
|
||||
├── .env.versions # Version definitions (SSOT)
|
||||
├── Dockerfile # Multi-stage container build
|
||||
├── README.md # Main README
|
||||
├── README-developer.md # This file
|
||||
├── README-technicalWriter.md # Guide for content contributors
|
||||
├── README-likec4.md # LikeC4 architecture modeling guide
|
||||
└── RELEASE.md # Release process documentation
|
||||
└── devbox.json # Devbox configuration
|
||||
```
|
||||
|
||||
## 📝 Content Creation
|
||||
|
|
@ -364,18 +197,6 @@ Important information
|
|||
{{</* /alert */>}}
|
||||
```
|
||||
|
||||
#### LikeC4 Architecture Diagrams
|
||||
```markdown
|
||||
{{</* likec4-view view="overview" project="architecture" title="System Overview" */>}}
|
||||
```
|
||||
|
||||
Parameters:
|
||||
- `view` - View ID from C4 model
|
||||
- `project` - `"architecture"` or `"documentation-platform"`
|
||||
- `title` - Optional custom title
|
||||
|
||||
See [README-technicalWriter.md](./README-technicalWriter.md) for detailed LikeC4 workflow.
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
See [TESTING.md](TESTING.md) for detailed testing documentation.
|
||||
|
|
@ -464,15 +285,9 @@ devbox shell --refresh
|
|||
|
||||
- [Hugo Documentation](https://gohugo.io/documentation/)
|
||||
- [Docsy Documentation](https://www.docsy.dev/docs/)
|
||||
- [LikeC4 Documentation](https://likec4.dev/)
|
||||
- [Taskfile Documentation](https://taskfile.dev/)
|
||||
- [Devbox Documentation](https://www.jetify.com/devbox/docs/)
|
||||
|
||||
**Project-specific guides:**
|
||||
- [README-technicalWriter.md](./README-technicalWriter.md) - Content contributor guide
|
||||
- [TESTING.md](./TESTING.md) - Detailed testing documentation
|
||||
- [DOCUMENTOR-GUIDE.md](./DOCUMENTOR-GUIDE.md) - Quick reference for technicalWriters
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
1. Create a feature branch
|
||||
97
README.md
97
README.md
|
|
@ -1,33 +1,88 @@
|
|||
# EDP - Edge Developer Platform
|
||||
# IPCEICIS-DeveloperFramework Documentation
|
||||
|
||||
Documentation for the edgeDeveloperFramework (eDF) project and the resulting Edge Developer Platform (EDP) product suite.
|
||||
This repo contains business and architectural design and documentation of the DeveloperFramework subproject of IPCEI-CIS.
|
||||
|
||||
## Quick Start
|
||||
## How to read and contribute to this documentation locally
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
task deps
|
||||
The documentation is done in [Hugo-format](https://gohugo.io).
|
||||
|
||||
# Start local development server
|
||||
task serve
|
||||
Hugo is a static site renderer - so to get the documentation site presented you need a running Hugo processor. Therefore there is
|
||||
|
||||
# Run tests
|
||||
task test
|
||||
* either a Hugo [`.devcontainer`-definition](https://containers.dev/) - just run a devcontainer aware IDE or CLI, e.g. Visual Studio code
|
||||
* or a Hugo [`Devbox`-definition](https://www.jetify.com/devbox/) - in this case just run a devbox shell
|
||||
|
||||
# Build production site
|
||||
task build
|
||||
```
|
||||
## Local installation of the Hugo documentation system
|
||||
|
||||
## Documentation
|
||||
We describe two possible ways (one with devcontainer, one with devbox) to get the Hugo-documentation system locally running.
|
||||
|
||||
* [Developer Guide](doc/README-developer.md)
|
||||
* [Technical Writer Guide](doc/README-technical-writer.md)
|
||||
* [Release Notes](doc/RELEASE.md)
|
||||
For both prepare the following three steps:
|
||||
|
||||
## Project
|
||||
1. open a terminal on your local box
|
||||
2. clone this repo: `git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/website-and-documentation`
|
||||
3. change to the repo working dir: `cd website-and-documentation`
|
||||
|
||||
This is a Hugo-based documentation site for the Edge Developer Platform, built as part of the IPCEI-CIS project.
|
||||
### Possibility 1: Hugo in a devcontainer
|
||||
|
||||
**Website:** Access the documentation at the deployed URL or run locally with `task serve`
|
||||
[`devcontainers`](https://containers.dev/) are running containers as virtual systems on your local box. The defintion is in the `.devcontainer` folder.
|
||||
Thus as preliminary you need a container daemon running, e.g. Docker.
|
||||
|
||||
For detailed information, see the documentation in the `doc/` folder.
|
||||
There are several options to create and run the devcontainer - we present here two:
|
||||
|
||||
#### Option 1: Run the container triggered by and connected to an IDE, e.g. VS Code
|
||||
|
||||
1. open the repo in an [Devcontainer-aware tool/IDE](https://containers.dev/supporting) (e.g. `code .`)
|
||||
1. start the `devcontainer` (in VSC it's `F1 + Reopen in Devcontainer`)
|
||||
1. when the container is up & running just open your browser with `http://localhost:1313/`
|
||||
|
||||
#### Option 2: Run the container natively
|
||||
|
||||
An alternative to get the container image is the [devcontainer CLI](https://github.com/devcontainers/cli), then you can run the devcontainer without VS Code.
|
||||
Thus as preliminary you need to do the install steps of the devconatiner cli.
|
||||
|
||||
1. start the devcontainer by running: `devcontainer up --workspace-folder .`
|
||||
1. find out the IP address of the devconatiner by using `docker ps` and `docker inspect <id of container>`
|
||||
1. when the container is up & running just open your browser with `http://<DOCKER IP>:1313/`
|
||||
|
||||
### Possibility 2: Hugo in a devbox
|
||||
|
||||
[`Devboxes`](https://www.jetify.com/devbox/) are locally isolated environments, managed by the [Nix package manager](https://nix.dev/). So first [prepare the devbox](https://www.jetify.com/docs/devbox/installing_devbox/).
|
||||
|
||||
Then
|
||||
|
||||
1. ```devbox shell```
|
||||
1. In the shell: ```hugo serve```
|
||||
|
||||
|
||||
## Editing
|
||||
|
||||
### Documentation language
|
||||
|
||||
The documentation is done in [Docsy-Theme](https://www.docsy.dev/).
|
||||
|
||||
So for editing content just goto the `content`-folder and edit content arrording to the [Docsy documentation](https://www.docsy.dev/docs/adding-content/)
|
||||
|
||||
## Commiting
|
||||
|
||||
After having finished a unit of work commit and push.
|
||||
|
||||
# Annex
|
||||
|
||||
## Installation steps illustrated
|
||||
|
||||
When you run the above installation, the outputs could typically look like this:
|
||||
|
||||
### In Visual Studio Code
|
||||
|
||||
#### Reopen in Container
|
||||
|
||||
|
||||
|
||||
#### Hugo server is running and (typically) listens to localhost:1313
|
||||
|
||||
After some installation time you have:
|
||||
|
||||
|
||||
|
||||
### Final result in a web browser
|
||||
|
||||
|
||||
|
|
|
|||
62
TESTING.md
Normal file
62
TESTING.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# Hugo Site Testing
|
||||
|
||||
Dieses Projekt verwendet mehrere automatisierte Tests zur Qualitätssicherung.
|
||||
|
||||
## Verfügbare Tests
|
||||
|
||||
### 1. Build-Test
|
||||
```bash
|
||||
npm run test:build
|
||||
```
|
||||
Prüft ob die Hugo-Seite überhaupt baut und zeigt Warnungen/Fehler an.
|
||||
|
||||
### 2. Markdown-Linting
|
||||
```bash
|
||||
npm run test:markdown
|
||||
```
|
||||
Validiert Markdown-Dateien auf Stilprobleme und Best Practices.
|
||||
|
||||
### 3. HTML-Validierung
|
||||
```bash
|
||||
npm run test:html
|
||||
```
|
||||
Prüft die generierte HTML auf HTML5-Konformität.
|
||||
|
||||
### 4. Link-Checker
|
||||
```bash
|
||||
npm run test:links
|
||||
```
|
||||
Testet alle internen und externen Links auf Gültigkeit.
|
||||
|
||||
### Alle Tests ausführen
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
|
||||
### Schnelle Tests (ohne Link-Check)
|
||||
```bash
|
||||
npm run test:quick
|
||||
```
|
||||
|
||||
## Konfigurationsdateien
|
||||
|
||||
- `.htmltest.yml` - Link-Checker-Konfiguration
|
||||
- `.htmlvalidate.json` - HTML-Validierungs-Regeln
|
||||
- `.markdownlint.json` - Markdown-Linting-Regeln
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
GitHub Actions führt diese Tests automatisch bei jedem Push/PR aus:
|
||||
- `.github/workflows/test.yml`
|
||||
|
||||
## Lokale Entwicklung
|
||||
|
||||
Vor dem Commit empfohlen:
|
||||
```bash
|
||||
npm run test:quick # Schnelle Tests
|
||||
```
|
||||
|
||||
Vor dem Push:
|
||||
```bash
|
||||
npm test # Alle Tests inkl. Link-Check
|
||||
```
|
||||
109
Taskfile.yml
109
Taskfile.yml
|
|
@ -13,35 +13,16 @@ tasks:
|
|||
# Build tasks
|
||||
build:
|
||||
desc: Build Hugo site
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
- build:generate-info
|
||||
cmds:
|
||||
- "{{.HUGO_CMD}} --gc --minify"
|
||||
|
||||
build:dev:
|
||||
desc: Build Hugo site for development
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
- build:generate-info
|
||||
cmds:
|
||||
- "{{.HUGO_CMD}}"
|
||||
|
||||
build:generate-info:
|
||||
desc: Generate build information (git commit, version, etc.)
|
||||
sources:
|
||||
- .git/HEAD
|
||||
- .git/refs/**/*
|
||||
generates:
|
||||
- data/build_info.json
|
||||
cmds:
|
||||
- ./scripts/generate-build-info.sh
|
||||
|
||||
serve:
|
||||
desc: Start Hugo dev server
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
- build:generate-info
|
||||
cmds:
|
||||
- "{{.HUGO_CMD}} server"
|
||||
|
||||
|
|
@ -53,127 +34,43 @@ tasks:
|
|||
# Test tasks
|
||||
test:
|
||||
desc: Run all tests
|
||||
deps:
|
||||
- test:build
|
||||
- test:markdown
|
||||
- test:html
|
||||
- likec4:validate
|
||||
|
||||
test:hugo:
|
||||
desc: Run Hugo-only tests (markdown, HTML, build)
|
||||
deps:
|
||||
- test:build
|
||||
- test:markdown
|
||||
- test:html
|
||||
|
||||
test:full:
|
||||
desc: Run all tests including link check (may have errors in legacy content)
|
||||
deps:
|
||||
- test:build
|
||||
- test:markdown
|
||||
- test:html
|
||||
- test:links
|
||||
- likec4:validate
|
||||
|
||||
test:quick:
|
||||
desc: Run quick tests (without link check)
|
||||
deps:
|
||||
- test:build
|
||||
- test:markdown
|
||||
- likec4:validate
|
||||
|
||||
test:build:
|
||||
desc: Test Hugo build
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
- build:generate-info
|
||||
cmds:
|
||||
- "{{.HUGO_CMD}} --gc --minify --logLevel info"
|
||||
|
||||
test:markdown:
|
||||
desc: Lint markdown files
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
cmds:
|
||||
- "{{.NPM_CMD}} run test:markdown"
|
||||
|
||||
test:html:
|
||||
desc: Validate HTML
|
||||
deps:
|
||||
- deps:ensure-npm
|
||||
cmds:
|
||||
- "{{.NPM_CMD}} run test:html"
|
||||
|
||||
test:links:
|
||||
desc: Check links (skips legacy content)
|
||||
desc: Check links
|
||||
cmds:
|
||||
- |
|
||||
# Move legacy dirs outside public temporarily
|
||||
mkdir -p /tmp/htmltest-backup-$$
|
||||
if [ -d "public/docs-old" ]; then mv public/docs-old /tmp/htmltest-backup-$$/; fi
|
||||
if [ -d "public/blog" ]; then mv public/blog /tmp/htmltest-backup-$$/; fi
|
||||
if [ -d "public/_print/docs-old" ]; then mv public/_print/docs-old /tmp/htmltest-backup-$$/docs-old-print; fi
|
||||
|
||||
# Run htmltest
|
||||
htmltest || EXIT_CODE=$?
|
||||
|
||||
# Restore directories
|
||||
if [ -d "/tmp/htmltest-backup-$$/docs-old" ]; then mv /tmp/htmltest-backup-$$/docs-old public/; fi
|
||||
if [ -d "/tmp/htmltest-backup-$$/blog" ]; then mv /tmp/htmltest-backup-$$/blog public/; fi
|
||||
if [ -d "/tmp/htmltest-backup-$$/docs-old-print" ]; then mv /tmp/htmltest-backup-$$/docs-old-print public/_print/docs-old; fi
|
||||
rm -rf /tmp/htmltest-backup-$$
|
||||
|
||||
# Exit with the original exit code
|
||||
exit ${EXIT_CODE:-0}
|
||||
|
||||
# LikeC4 tasks
|
||||
likec4:generate:
|
||||
desc: Generate LikeC4 webcomponent (includes all architecture projects)
|
||||
cmds:
|
||||
- npx likec4 codegen webcomponent --webcomponent-prefix likec4 --outfile static/js/likec4-webcomponent.js resources/edp-likec4 resources/doc-likec4
|
||||
|
||||
likec4:validate:
|
||||
desc: Validate LikeC4 models
|
||||
cmds:
|
||||
- echo "Validating EDP architecture models..."
|
||||
- npx likec4 validate --ignore-layout resources/edp-likec4
|
||||
- echo "Validating Documentation platform models..."
|
||||
- npx likec4 validate --ignore-layout resources/doc-likec4
|
||||
- echo "✓ All LikeC4 models validated successfully"
|
||||
|
||||
likec4:validate:layout:
|
||||
desc: Validate LikeC4 models including layout
|
||||
cmds:
|
||||
- echo "Validating EDP architecture models (including layout)..."
|
||||
- npx likec4 validate resources/edp-likec4
|
||||
- echo "Validating Documentation platform models (including layout)..."
|
||||
- npx likec4 validate resources/doc-likec4
|
||||
- echo "✓ All LikeC4 models and layouts validated successfully"
|
||||
|
||||
likec4:update:
|
||||
desc: Update LikeC4 to latest version
|
||||
cmds:
|
||||
- npm update likec4 --prefix resources/edp-likec4
|
||||
- npm update likec4 --prefix resources/doc-likec4
|
||||
- echo "✓ LikeC4 updated in both projects"
|
||||
- htmltest
|
||||
|
||||
# Development tasks
|
||||
deps:ensure-npm:
|
||||
desc: Ensure npm dependencies are installed
|
||||
sources:
|
||||
- package.json
|
||||
- package-lock.json
|
||||
generates:
|
||||
- node_modules/.package-lock.json
|
||||
cmds:
|
||||
- "{{.NPM_CMD}} ci"
|
||||
status:
|
||||
- test -d node_modules
|
||||
|
||||
deps:install:
|
||||
desc: Install all dependencies
|
||||
cmds:
|
||||
- "{{.NPM_CMD}} ci"
|
||||
- "{{.NPM_CMD}} install"
|
||||
- "{{.HUGO_CMD}} mod get -u"
|
||||
- "{{.HUGO_CMD}} mod tidy"
|
||||
|
||||
|
|
|
|||
69
VERSIONS.md
Normal file
69
VERSIONS.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# Version Management
|
||||
|
||||
## Single Source of Truth: `.env.versions`
|
||||
|
||||
All tool versions are centrally managed in `.env.versions`:
|
||||
|
||||
```bash
|
||||
NODE_VERSION=24.10.0
|
||||
GO_VERSION=1.25.1
|
||||
HUGO_VERSION=0.151.0
|
||||
```
|
||||
|
||||
## Where are versions used?
|
||||
|
||||
1. **devbox.json** - Local development environment (manual sync required)
|
||||
2. **Dockerfile** - Build arguments with defaults
|
||||
3. **.github/workflows/ci.yaml** - CI/CD pipeline (automatic)
|
||||
4. **scripts/get-versions.sh** - Helper script for local builds
|
||||
|
||||
## Updating Versions
|
||||
|
||||
### Step 1: Update `.env.versions`
|
||||
|
||||
Edit the file with new versions:
|
||||
|
||||
```bash
|
||||
NODE_VERSION=24.12.0
|
||||
GO_VERSION=1.25.2
|
||||
HUGO_VERSION=0.152.0
|
||||
```
|
||||
|
||||
### Step 2: Update `devbox.json`
|
||||
|
||||
Manually sync the versions in `devbox.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"packages": [
|
||||
"hugo@0.152.0",
|
||||
"go@1.25.2",
|
||||
"nodejs@24.12.0",
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Step 3: Rebuild devbox environment
|
||||
|
||||
```bash
|
||||
devbox shell --refresh
|
||||
```
|
||||
|
||||
### Step 4: Test Docker build
|
||||
|
||||
```bash
|
||||
source scripts/get-versions.sh
|
||||
# Follow the printed docker build command
|
||||
```
|
||||
|
||||
## Why not automatic devbox sync?
|
||||
|
||||
- devbox.json uses a different version format (e.g., `@latest` vs specific versions)
|
||||
- devbox package names may differ from Docker image names
|
||||
- Keeps devbox.json simple and readable
|
||||
- Manual sync ensures intentional version updates
|
||||
|
||||
## CI/CD
|
||||
|
||||
The GitHub Actions workflow automatically loads versions from `.env.versions` - no manual intervention needed.
|
||||
|
|
@ -406,34 +406,6 @@ table {
|
|||
}
|
||||
}
|
||||
|
||||
// Lead blocks with primary color background
|
||||
.td-block--primary,
|
||||
section[class*="bg-primary"],
|
||||
section[class*="color-primary"] {
|
||||
background-color: var(--color-primary) !important;
|
||||
|
||||
* {
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6, p, a, .lead {
|
||||
color: #FFFFFF !important;
|
||||
text-shadow: 0 1px 3px rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
// Prevent white background on hover
|
||||
&:hover,
|
||||
*:hover {
|
||||
background-color: transparent !important;
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #FFFFFF !important;
|
||||
text-decoration: underline;
|
||||
}
|
||||
}
|
||||
|
||||
.td-box {
|
||||
background-color: var(--color-card);
|
||||
border: 1px solid var(--nav-border-color);
|
||||
|
|
@ -486,39 +458,3 @@ section[class*="color-primary"] {
|
|||
}
|
||||
}
|
||||
|
||||
// Feature blocks on homepage (blocks/feature)
|
||||
.td-box--dark,
|
||||
.td-box--colored,
|
||||
section[class*="bg-dark"] .td-box,
|
||||
section[class*="color-dark"] .td-box {
|
||||
.h2, .h3, .h4, .h5, h2, h3, h4, h5, p, a {
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
|
||||
&:hover {
|
||||
background-color: rgba(0, 0, 0, 0.8) !important;
|
||||
|
||||
.h2, .h3, .h4, .h5, h2, h3, h4, h5, p, a {
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure text stays visible in dark sections
|
||||
section[class*="bg-dark"],
|
||||
section[class*="color-dark"] {
|
||||
* {
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
|
||||
.td-box, .card {
|
||||
&:hover {
|
||||
background-color: rgba(0, 0, 0, 0.8) !important;
|
||||
|
||||
* {
|
||||
color: #FFFFFF !important;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -3,84 +3,5 @@ title: IPCEI-CIS Developer Framework
|
|||
---
|
||||
|
||||
{{< blocks/cover title="IPCEI-CIS Developer Framework" image_anchor="top" height="full" >}}
|
||||
<p class="lead mt-5">
|
||||
A comprehensive enterprise development platform enabling teams to build, deploy, and operate cloud-native applications with ease.
|
||||
</p>
|
||||
{{< blocks/link-down color="info" >}}
|
||||
|
||||
{{< /blocks/cover >}}
|
||||
|
||||
{{% blocks/lead color="primary" %}}
|
||||
The IPCEI-CIS Developer Framework provides everything you need to deliver modern applications at scale.
|
||||
Built on open standards and battle-tested technologies.
|
||||
{{% /blocks/lead %}}
|
||||
|
||||
{{% blocks/section color="dark" type="row" %}}
|
||||
|
||||
{{% blocks/feature icon="fa-solid fa-diagram-project" title="Architecture Documentation" url="/docs/architecture/" %}}
|
||||
Explore the platform's architecture with interactive C4 diagrams. Understand the system design, components, and deployment topology.
|
||||
|
||||
**Dive into the architecture →**
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fa-solid fa-book-open" title="Technical Writer Guide" url="/docs/documentation/" %}}
|
||||
Learn how to contribute to this documentation. Write content, test locally, and understand the CI/CD pipeline.
|
||||
|
||||
**Start documenting →**
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fa-solid fa-archive" title="Legacy Documentation (v1)" url="/docs/v1/" %}}
|
||||
Access the previous version of our documentation including historical project information and early architecture decisions.
|
||||
|
||||
**Browse v1 docs →**
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% /blocks/section %}}
|
||||
|
||||
{{% blocks/section color="white" %}}
|
||||
|
||||
## What's in the Platform?
|
||||
|
||||
<div class="row">
|
||||
<div class="col-lg-4 mb-4">
|
||||
|
||||
### 🚀 Developer Experience
|
||||
|
||||
* **Backstage Portal** - Self-service platform
|
||||
* **GitOps Workflows** - Automated deployments
|
||||
* **Golden Paths** - Best practices built-in
|
||||
|
||||
</div>
|
||||
<div class="col-lg-4 mb-4">
|
||||
|
||||
### 🛠️ Infrastructure as Code
|
||||
|
||||
* **Crossplane** - Cloud resource provisioning
|
||||
* **ArgoCD** - Declarative GitOps
|
||||
* **Terraform** - Infrastructure automation
|
||||
|
||||
</div>
|
||||
<div class="col-lg-4 mb-4">
|
||||
|
||||
### 📊 Observability
|
||||
|
||||
* **Prometheus & Grafana** - Metrics & dashboards
|
||||
* **Loki** - Log aggregation
|
||||
* **OpenTelemetry** - Distributed tracing
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{% /blocks/section %}}
|
||||
|
||||
{{% blocks/section color="light" %}}
|
||||
|
||||
## Get Started
|
||||
|
||||
Whether you're a **platform engineer**, **application developer**, or **technicalWriter**, we have resources for you:
|
||||
|
||||
* 📖 Read the [Documentation](/docs/) to understand the platform
|
||||
* 🏗️ Explore [Platform Components](/docs/components/) and their usage
|
||||
* ✍️ Learn [How to Document](/docs/DOCUMENTATION-GUIDE/) and contribute
|
||||
* 🔍 Browse [Legacy Documentation](/docs-old/) for historical context
|
||||
|
||||
{{% /blocks/section %}}
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
title: important links
|
||||
weight: 20
|
||||
---
|
||||
|
||||
* Gardener login to Edge and orca cluster: IPCEICIS-6222
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
title: Legacy Documentation
|
||||
linkTitle: Docs (Old)
|
||||
menu:
|
||||
main:
|
||||
weight: 50
|
||||
weight: 50
|
||||
cascade:
|
||||
- type: docs
|
||||
---
|
||||
|
||||
# Legacy Documentation
|
||||
|
||||
This section contains the previous version of the documentation for reference purposes.
|
||||
|
||||
**Note**: This documentation is archived and may be outdated. Please refer to the main [Documentation](../docs/) section for current information.
|
||||
|
||||
## Available Sections
|
||||
|
||||
* [Architecture](architecture/) - System architecture and diagrams
|
||||
* [Documentation](documentation/) - Meta documentation about the documentation system
|
||||
* [Platform Overview](platform-overview/) - Overview document
|
||||
* [v1 (Legacy)](v1/) - Original v1 documentation
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
---
|
||||
title: "Documentation About Documentation"
|
||||
linkTitle: "Documentation"
|
||||
weight: 10
|
||||
description: >
|
||||
Learn how to create, maintain, and publish documentation for the developer platform.
|
||||
---
|
||||
|
||||
Welcome to the meta-documentation! This section explains how our documentation platform works and guides you through the technicalWriter role.
|
||||
|
||||
## What is a Technical Writer?
|
||||
|
||||
A **Technical Writer** is responsible for creating, maintaining, and publishing the developer platform documentation. This includes:
|
||||
|
||||
- Writing and updating content in Markdown
|
||||
- Creating architecture diagrams with LikeC4
|
||||
- Testing locally before committing
|
||||
- Following the CI/CD pipeline to production
|
||||
|
||||
## Documentation Platform Architecture
|
||||
|
||||
Our documentation is built on a modern stack:
|
||||
|
||||
- **Hugo** with the **Docsy** theme for static site generation
|
||||
- **LikeC4** for architecture visualization
|
||||
- **Taskfile** for local development automation
|
||||
- **GitHub Actions** for continuous testing
|
||||
- **Edge deployment** for hosting
|
||||
|
||||
### System Overview
|
||||
|
||||
{{< likec4-view view="overview" project="documentation-platform" >}}
|
||||
|
||||
This high-level view shows all major components of the documentation platform.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Continue to the next sections to learn about:
|
||||
|
||||
1. [Local Development](local-development/) - How to work on documentation locally
|
||||
2. [Testing](testing/) - Quality assurance processes
|
||||
3. [CI/CD Pipeline](cicd/) - Automated testing and deployment
|
||||
4. [Publishing](publishing/) - How documentation reaches production
|
||||
|
|
@ -1,264 +0,0 @@
|
|||
---
|
||||
title: "CI/CD Pipeline"
|
||||
linkTitle: "CI/CD"
|
||||
weight: 40
|
||||
description: >
|
||||
Automated testing and container build process.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Our documentation uses a continuous integration and deployment pipeline to ensure quality and automate deployment.
|
||||
|
||||
{{< likec4-view view="cicdPipeline" project="documentation-platform" >}}
|
||||
|
||||
## GitHub Actions Workflow
|
||||
|
||||
The CI/CD pipeline is defined in `.github/workflows/test.yml` and runs on:
|
||||
|
||||
- **Pushes to `main` branch**
|
||||
- **Pull requests to `main` branch**
|
||||
|
||||
### Workflow Steps
|
||||
|
||||
#### 1. Checkout Code
|
||||
|
||||
```yaml
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
fetch-depth: 0
|
||||
```
|
||||
|
||||
- Clones repository with full history
|
||||
- Includes Git submodules (Hugo modules)
|
||||
|
||||
#### 2. Setup Hugo
|
||||
|
||||
```yaml
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v3
|
||||
with:
|
||||
hugo-version: 'latest'
|
||||
extended: true
|
||||
```
|
||||
|
||||
- Installs Hugo Extended
|
||||
- Uses latest stable version
|
||||
|
||||
#### 3. Setup Node.js
|
||||
|
||||
```yaml
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '24'
|
||||
cache: 'npm'
|
||||
```
|
||||
|
||||
- Installs Node.js v24
|
||||
- Caches npm dependencies for faster builds
|
||||
|
||||
#### 4. Install Dependencies
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
go install github.com/wjdp/htmltest@latest
|
||||
```
|
||||
|
||||
- Installs npm packages (markdownlint, htmlvalidate)
|
||||
- Installs htmltest for link checking
|
||||
|
||||
#### 5. Run Tests
|
||||
|
||||
```bash
|
||||
npm run test:build
|
||||
npm run test:markdown
|
||||
npm run test:html
|
||||
```
|
||||
|
||||
- Validates Hugo build
|
||||
- Lints Markdown files
|
||||
- Validates HTML output
|
||||
|
||||
#### 6. Link Checking
|
||||
|
||||
```yaml
|
||||
- name: Run link checker
|
||||
run: htmltest
|
||||
continue-on-error: true
|
||||
```
|
||||
|
||||
- Checks all links
|
||||
- Continues even if links fail (soft requirement)
|
||||
|
||||
#### 7. Upload Results
|
||||
|
||||
```yaml
|
||||
- name: Upload htmltest results
|
||||
uses: actions/upload-artifact@v4
|
||||
if: always()
|
||||
with:
|
||||
name: htmltest-report
|
||||
path: tmp/.htmltest/
|
||||
```
|
||||
|
||||
- Uploads link check report
|
||||
- Available for download from GitHub Actions
|
||||
|
||||
## Container Build Process
|
||||
|
||||
After tests pass, a container image is built:
|
||||
|
||||
```bash
|
||||
task build:oci-image
|
||||
```
|
||||
|
||||
### Build Process
|
||||
|
||||
1. **Reads version information** from `.env.versions`:
|
||||
- `NODE_VERSION`
|
||||
- `GO_VERSION`
|
||||
- `HUGO_VERSION`
|
||||
|
||||
2. **Builds Docker image** using `Dockerfile`:
|
||||
- Multi-stage build
|
||||
- Hugo generates static site
|
||||
- Nginx serves the content
|
||||
|
||||
3. **Tags image** with:
|
||||
- `latest`
|
||||
- Git commit SHA (short)
|
||||
|
||||
### Dockerfile Structure
|
||||
|
||||
```dockerfile
|
||||
# Build stage
|
||||
FROM node:${NODE_VERSION} as builder
|
||||
# Install Hugo, build dependencies
|
||||
# Run: hugo --gc --minify
|
||||
# Output: public/ directory
|
||||
|
||||
# Runtime stage
|
||||
FROM nginx:alpine
|
||||
# Copy public/ to /usr/share/nginx/html/
|
||||
# Configure Nginx
|
||||
```
|
||||
|
||||
### Testing the Container
|
||||
|
||||
```bash
|
||||
task test:oci-image
|
||||
```
|
||||
|
||||
This:
|
||||
|
||||
1. Builds the image
|
||||
2. Starts container on port 8080
|
||||
3. Tests HTTP endpoint
|
||||
4. Cleans up container
|
||||
|
||||
## Package.json Scripts
|
||||
|
||||
The `package.json` defines test scripts:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"test:build": "hugo --gc --minify --logLevel info",
|
||||
"test:markdown": "markdownlint 'content/**/*.md'",
|
||||
"test:html": "htmlvalidate 'public/**/*.html'"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Running CI Locally
|
||||
|
||||
Simulate the CI environment locally:
|
||||
|
||||
```bash
|
||||
task ci
|
||||
```
|
||||
|
||||
This runs the same tests as GitHub Actions.
|
||||
|
||||
## Monitoring CI Results
|
||||
|
||||
### Successful Build
|
||||
|
||||
✅ All tests pass → Ready to deploy
|
||||
|
||||
### Failed Build
|
||||
|
||||
❌ Tests fail:
|
||||
|
||||
1. Click on the failed workflow in GitHub Actions
|
||||
2. Expand the failed step
|
||||
3. Read the error message
|
||||
4. Fix locally: `task test:<specific-test>`
|
||||
5. Commit and push fix
|
||||
|
||||
### Viewing Artifacts
|
||||
|
||||
1. Go to GitHub Actions
|
||||
2. Click on workflow run
|
||||
3. Scroll to "Artifacts" section
|
||||
4. Download `htmltest-report`
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Don't push to main directly** - Use feature branches and PRs
|
||||
2. **Wait for CI before merging** - Green checkmark required
|
||||
3. **Fix broken builds immediately** - Don't let main stay red
|
||||
4. **Review CI logs** - Understand why tests fail
|
||||
5. **Update dependencies** - Keep versions current in `.env.versions`
|
||||
|
||||
## Continuous Deployment
|
||||
|
||||
After successful CI:
|
||||
|
||||
1. Container image is built
|
||||
2. Image is pushed to registry
|
||||
3. Deployment process begins (see [Publishing](../publishing/))
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Tests pass locally but fail in CI
|
||||
|
||||
**Possible causes:**
|
||||
|
||||
- Different Hugo version
|
||||
- Different Node.js version
|
||||
- Missing dependencies
|
||||
- Environment-specific issues
|
||||
|
||||
**Solution:** Check versions in `.env.versions` and ensure local matches CI
|
||||
|
||||
### Build timeouts
|
||||
|
||||
**Possible causes:**
|
||||
|
||||
- Link checker taking too long
|
||||
- Large number of external links
|
||||
|
||||
**Solution:**
|
||||
|
||||
- Use `continue-on-error: true` for link checks
|
||||
- Configure `.htmltest.yml` to skip slow checks
|
||||
|
||||
### Cache issues
|
||||
|
||||
**Solution:** Clear GitHub Actions cache:
|
||||
|
||||
```yaml
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
```
|
||||
|
||||
Update the cache key to force refresh.
|
||||
|
||||
## Next Steps
|
||||
|
||||
Learn about [deployment to Edge environment](../publishing/).
|
||||
|
|
@ -1,234 +0,0 @@
|
|||
---
|
||||
title: "Local Development"
|
||||
linkTitle: "Local Development"
|
||||
weight: 20
|
||||
description: >
|
||||
Set up your local environment and learn the technicalWriter workflow.
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you start, ensure you have:
|
||||
|
||||
- **Devbox** or the following tools installed:
|
||||
- Hugo Extended (latest version)
|
||||
- Node.js (v24+)
|
||||
- Go (for htmltest)
|
||||
- Git
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd ipceicis-developerframework
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
|
||||
```bash
|
||||
task deps:install
|
||||
```
|
||||
|
||||
3. **If using Devbox**, enter the Devbox shell:
|
||||
|
||||
```bash
|
||||
devbox shell
|
||||
```
|
||||
|
||||
This ensures all tools (Hugo, Node.js, Go) are available in the correct versions.
|
||||
|
||||
## Local Development Workflow
|
||||
|
||||
{{< likec4-view view="localDevelopment" project="documentation-platform" >}}
|
||||
|
||||
### Starting the Development Server
|
||||
|
||||
The easiest way to work locally is to start the Hugo development server:
|
||||
|
||||
```bash
|
||||
task serve
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
- Generate build information (git commit, version)
|
||||
- Start Hugo server on `http://localhost:1313`
|
||||
- Enable hot reload - changes appear instantly in the browser
|
||||
|
||||
### Content Structure
|
||||
|
||||
```text
|
||||
content/
|
||||
└── en/ # English content
|
||||
├── _index.md # Homepage
|
||||
├── blog/ # Blog posts
|
||||
└── docs/ # Documentation
|
||||
├── architecture/ # Architecture docs
|
||||
├── decisions/ # ADRs
|
||||
└── v1/ # Version-specific docs
|
||||
```
|
||||
|
||||
### Creating Content
|
||||
|
||||
1. **Add a new documentation page:**
|
||||
|
||||
```bash
|
||||
# Create a new markdown file
|
||||
vim content/en/docs/your-topic/_index.md
|
||||
```
|
||||
|
||||
2. **Add frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Your Topic"
|
||||
linkTitle: "Your Topic"
|
||||
weight: 10
|
||||
description: >
|
||||
Brief description of your topic.
|
||||
---
|
||||
```
|
||||
|
||||
3. **Write your content** in Markdown
|
||||
|
||||
4. **Preview changes** - they appear immediately if `task serve` is running
|
||||
|
||||
### Creating Architecture Diagrams
|
||||
|
||||
Architecture diagrams are created with LikeC4:
|
||||
|
||||
1. **Navigate to the appropriate LikeC4 project:**
|
||||
- `resources/edp-likec4/` - Platform architecture
|
||||
- `resources/doc-likec4/` - Documentation platform architecture
|
||||
|
||||
2. **Edit or create `.c4` files** with your model
|
||||
|
||||
Example: Create a simple view in `resources/edp-likec4/views/my-view.c4`:
|
||||
|
||||
```likec4
|
||||
specification {
|
||||
element myperson
|
||||
element mysystem
|
||||
}
|
||||
|
||||
model {
|
||||
customer = myperson 'Customer' {
|
||||
description 'End user of the platform'
|
||||
}
|
||||
|
||||
mySystem = mysystem 'My System' {
|
||||
description 'Example system component'
|
||||
}
|
||||
|
||||
customer -> mySystem 'uses'
|
||||
}
|
||||
|
||||
views {
|
||||
view myCustomView {
|
||||
title "My Custom Architecture View"
|
||||
|
||||
include customer
|
||||
include mySystem
|
||||
|
||||
autoLayout TopBottom
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. **Regenerate webcomponents:**
|
||||
|
||||
```bash
|
||||
task likec4:generate
|
||||
```
|
||||
|
||||
4. **Embed diagrams in Markdown:**
|
||||
|
||||
```markdown
|
||||
{{</* likec4-view view="myCustomView" project="architecture" title="My Custom Architecture View" */>}}
|
||||
```
|
||||
|
||||
**Finding available view IDs:**
|
||||
- Open the `.c4` files in your project directory
|
||||
- Look for `view <viewId> {` declarations
|
||||
- The `<viewId>` is what you use in the `view` parameter
|
||||
- Or use: `grep -r "^view " resources/edp-likec4/ --include="*.c4"`
|
||||
|
||||
## Available Tasks
|
||||
|
||||
View all available tasks:
|
||||
|
||||
```bash
|
||||
task --list
|
||||
```
|
||||
|
||||
### Common Development Tasks
|
||||
|
||||
| Task | Description |
|
||||
|------|-------------|
|
||||
| `task serve` | Start development server with hot reload |
|
||||
| `task build` | Build production-ready site |
|
||||
| `task build:dev` | Build development version |
|
||||
| `task clean` | Remove build artifacts |
|
||||
| `task test` | Run all tests |
|
||||
| `task test:quick` | Run tests without link checking |
|
||||
|
||||
## Quick Testing
|
||||
|
||||
Before committing, run quick tests:
|
||||
|
||||
```bash
|
||||
task test:quick
|
||||
```
|
||||
|
||||
This validates:
|
||||
|
||||
- Hugo build succeeds
|
||||
- Markdown syntax is correct
|
||||
|
||||
For comprehensive testing, including link checking:
|
||||
|
||||
```bash
|
||||
task test
|
||||
```
|
||||
|
||||
## Tips for Technical Writers
|
||||
|
||||
1. **Write in present tense** - "The system processes..." not "The system will process..."
|
||||
2. **Use code blocks** with syntax highlighting
|
||||
3. **Include diagrams** for complex concepts
|
||||
4. **Test locally** before pushing
|
||||
5. **Keep it concise** - readers appreciate brevity
|
||||
6. **Update regularly** - stale docs are worse than no docs
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Port 1313 already in use
|
||||
|
||||
```bash
|
||||
# Find and kill the process
|
||||
lsof -ti:1313 | xargs kill -9
|
||||
```
|
||||
|
||||
### Build errors
|
||||
|
||||
```bash
|
||||
# Clean and rebuild
|
||||
task clean
|
||||
task build:dev
|
||||
```
|
||||
|
||||
### Missing dependencies
|
||||
|
||||
```bash
|
||||
# Reinstall all dependencies
|
||||
task deps:install
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
Now that you can develop locally, learn about:
|
||||
|
||||
- [Testing processes](../testing/)
|
||||
- [CI/CD pipeline](../cicd/)
|
||||
|
|
@ -1,339 +0,0 @@
|
|||
---
|
||||
title: "Publishing to Edge"
|
||||
linkTitle: "Publishing"
|
||||
weight: 50
|
||||
description: >
|
||||
How documentation is deployed to the edge environment.
|
||||
---
|
||||
|
||||
## Deployment Overview
|
||||
|
||||
After successful CI/CD, the documentation is deployed to an edge computing environment.
|
||||
|
||||
{{< likec4-view view="deploymentFlow" project="documentation-platform" >}}
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
### Edge Connect Platform
|
||||
|
||||
Our documentation is deployed using **Edge Connect**, which orchestrates deployments to edge cloudlets.
|
||||
|
||||
Configuration: `edgeconnectdeployment.yaml`
|
||||
|
||||
```yaml
|
||||
kind: edgeconnect-deployment
|
||||
metadata:
|
||||
name: "edpdoc"
|
||||
appVersion: "1.0.0"
|
||||
organization: "edp2"
|
||||
spec:
|
||||
k8sApp:
|
||||
manifestFile: "./k8s-deployment.yaml"
|
||||
infraTemplate:
|
||||
- region: "EU"
|
||||
cloudletOrg: "TelekomOP"
|
||||
cloudletName: "Munich"
|
||||
flavorName: "EU.small"
|
||||
```
|
||||
|
||||
**Key settings:**
|
||||
|
||||
- **Deployment name:** `edpdoc`
|
||||
- **Region:** EU (Munich)
|
||||
- **Cloudlet:** TelekomOP Munich
|
||||
- **Flavor:** EU.small (resource allocation)
|
||||
|
||||
### Kubernetes Deployment
|
||||
|
||||
The application runs on Kubernetes: `k8s-deployment.yaml`
|
||||
|
||||
#### Service Definition
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: edpdoc
|
||||
labels:
|
||||
run: edpdoc
|
||||
spec:
|
||||
type: LoadBalancer
|
||||
ports:
|
||||
- name: tcp80
|
||||
protocol: TCP
|
||||
port: 80
|
||||
targetPort: 80
|
||||
selector:
|
||||
run: edpdoc
|
||||
```
|
||||
|
||||
- **Type:** LoadBalancer (external access)
|
||||
- **Port:** 80 (HTTP)
|
||||
- **Selector:** Routes traffic to pods with label `run: edpdoc`
|
||||
|
||||
#### Deployment Configuration
|
||||
|
||||
```yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: edpdoc
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
run: edpdoc
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
run: edpdoc
|
||||
mexDeployGen: kubernetes-basic
|
||||
spec:
|
||||
containers:
|
||||
- name: edpdoc
|
||||
image: ###IMAGETAG###
|
||||
imagePullPolicy: Always
|
||||
ports:
|
||||
- containerPort: 80
|
||||
protocol: TCP
|
||||
```
|
||||
|
||||
- **Replicas:** 1 (single instance)
|
||||
- **Image:** Injected by deployment pipeline (`###IMAGETAG###` placeholder)
|
||||
- **Pull policy:** Always (ensures latest version)
|
||||
|
||||
### Network Configuration
|
||||
|
||||
Outbound connections are configured in `edgeconnectdeployment.yaml`:
|
||||
|
||||
```yaml
|
||||
network:
|
||||
outboundConnections:
|
||||
- protocol: "tcp"
|
||||
portRangeMin: 80
|
||||
portRangeMax: 80
|
||||
remoteCIDR: "0.0.0.0/0"
|
||||
- protocol: "tcp"
|
||||
portRangeMin: 443
|
||||
portRangeMax: 443
|
||||
remoteCIDR: "0.0.0.0/0"
|
||||
```
|
||||
|
||||
- **Port 80:** HTTP outbound
|
||||
- **Port 443:** HTTPS outbound
|
||||
- **CIDR:** `0.0.0.0/0` (all destinations)
|
||||
|
||||
## Deployment Process
|
||||
|
||||
### 1. Container Image Ready
|
||||
|
||||
After CI passes:
|
||||
|
||||
- Docker image built with `task build:oci-image`
|
||||
- Tagged with git commit SHA
|
||||
- Pushed to container registry
|
||||
|
||||
### 2. Edge Connect Orchestration
|
||||
|
||||
Edge Connect:
|
||||
|
||||
1. Pulls container image
|
||||
2. Reads `edgeconnectdeployment.yaml`
|
||||
3. Provisions resources on Munich cloudlet
|
||||
4. Applies Kubernetes manifests
|
||||
|
||||
### 3. Kubernetes Deployment
|
||||
|
||||
Kubernetes:
|
||||
|
||||
1. Creates deployment with 1 replica
|
||||
2. Pulls container image (`imagePullPolicy: Always`)
|
||||
3. Starts pod running Nginx + static Hugo site
|
||||
4. Creates LoadBalancer service
|
||||
5. Assigns external IP
|
||||
|
||||
### 4. Service Available
|
||||
|
||||
Documentation is now accessible:
|
||||
|
||||
- **Protocol:** HTTP
|
||||
- **Port:** 80
|
||||
- **IP:** Assigned by LoadBalancer
|
||||
|
||||
## Complete Workflow
|
||||
|
||||
{{< likec4-view view="fullWorkflow" project="documentation-platform" >}}
|
||||
|
||||
### End-to-End Process
|
||||
|
||||
1. **Technical Writer writes content** (Markdown, LikeC4 models)
|
||||
2. **Local testing** with `task serve` and `task test`
|
||||
3. **Commit and push** to Git repository
|
||||
4. **GitHub Actions triggered** on push to main
|
||||
5. **CI tests run** (build, markdown, HTML, links)
|
||||
6. **Container image built** if tests pass
|
||||
7. **Image pushed** to registry
|
||||
8. **Edge deployment triggered**
|
||||
9. **Kubernetes applies** manifests
|
||||
10. **Service available** on edge cloudlet
|
||||
|
||||
## Monitoring Deployment
|
||||
|
||||
### Check Deployment Status
|
||||
|
||||
```bash
|
||||
kubectl get deployments -n <namespace>
|
||||
kubectl get pods -n <namespace>
|
||||
kubectl get services -n <namespace>
|
||||
```
|
||||
|
||||
### View Logs
|
||||
|
||||
```bash
|
||||
kubectl logs deployment/edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
### Access Documentation
|
||||
|
||||
Find the LoadBalancer external IP:
|
||||
|
||||
```bash
|
||||
kubectl get service edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
Access via: `http://<EXTERNAL-IP>`
|
||||
|
||||
## Rollback
|
||||
|
||||
If issues occur after deployment:
|
||||
|
||||
### Option 1: Revert Commit
|
||||
|
||||
```bash
|
||||
git revert <bad-commit>
|
||||
git push origin main
|
||||
```
|
||||
|
||||
CI will rebuild and redeploy.
|
||||
|
||||
### Option 2: Manual Rollback
|
||||
|
||||
```bash
|
||||
kubectl rollout undo deployment/edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
Returns to previous deployment version.
|
||||
|
||||
### Option 3: Deploy Specific Version
|
||||
|
||||
Update image tag in deployment:
|
||||
|
||||
```bash
|
||||
kubectl set image deployment/edpdoc edpdoc=<registry>/<image>:<tag> -n <namespace>
|
||||
```
|
||||
|
||||
## Scaling
|
||||
|
||||
Currently: **1 replica**
|
||||
|
||||
To scale for higher traffic:
|
||||
|
||||
```yaml
|
||||
spec:
|
||||
replicas: 3
|
||||
```
|
||||
|
||||
Then apply:
|
||||
|
||||
```bash
|
||||
kubectl apply -f k8s-deployment.yaml
|
||||
```
|
||||
|
||||
Or scale dynamically:
|
||||
|
||||
```bash
|
||||
kubectl scale deployment/edpdoc --replicas=3 -n <namespace>
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. **Image scanning** - Scan container images for vulnerabilities
|
||||
2. **Resource limits** - Set CPU/memory limits in deployment
|
||||
3. **Network policies** - Restrict pod-to-pod communication
|
||||
4. **HTTPS** - Consider adding TLS termination (Ingress)
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
1. **CDN** - Add CDN in front of LoadBalancer
|
||||
2. **Caching** - Configure Nginx caching headers
|
||||
3. **Compression** - Enable gzip in Nginx
|
||||
4. **Image optimization** - Compress images in documentation
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Pod not starting
|
||||
|
||||
```bash
|
||||
kubectl describe pod <pod-name> -n <namespace>
|
||||
```
|
||||
|
||||
Check:
|
||||
|
||||
- Image pull errors
|
||||
- Resource constraints
|
||||
- Configuration errors
|
||||
|
||||
### Service unreachable
|
||||
|
||||
```bash
|
||||
kubectl describe service edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
Check:
|
||||
|
||||
- LoadBalancer IP assigned
|
||||
- Port configuration
|
||||
- Network policies
|
||||
|
||||
### Old content served
|
||||
|
||||
Check:
|
||||
|
||||
- `imagePullPolicy: Always` in deployment
|
||||
- Image tag is updated
|
||||
- Pod has restarted
|
||||
|
||||
Force pod restart:
|
||||
|
||||
```bash
|
||||
kubectl rollout restart deployment/edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Test before deploying** - Always run `task test` locally
|
||||
2. **Use feature branches** - Don't deploy directly from local
|
||||
3. **Monitor after deployment** - Check logs and access
|
||||
4. **Document changes** - Update RELEASE.md
|
||||
5. **Version control** - Tag releases in Git
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Potential improvements:
|
||||
|
||||
- **Blue-green deployment** - Zero-downtime updates
|
||||
- **Canary releases** - Gradual rollout to subset of users
|
||||
- **Auto-scaling** - HorizontalPodAutoscaler based on traffic
|
||||
- **Multi-region** - Deploy to multiple cloudlets
|
||||
- **HTTPS** - TLS certificates and Ingress controller
|
||||
|
||||
## Summary
|
||||
|
||||
The deployment process is automated and reliable:
|
||||
|
||||
✅ **CI ensures quality** - Tests prevent broken deployments
|
||||
✅ **Edge infrastructure** - Low-latency access from EU
|
||||
✅ **Kubernetes orchestration** - Reliable, scalable platform
|
||||
✅ **Simple rollback** - Easy to recover from issues
|
||||
|
||||
As a technicalWriter, focus on content quality. The platform handles deployment automatically! 🚀
|
||||
|
|
@ -1,282 +0,0 @@
|
|||
---
|
||||
title: "Quick Reference"
|
||||
linkTitle: "Quick Reference"
|
||||
weight: 60
|
||||
description: >
|
||||
Cheat sheet for common technicalWriter tasks.
|
||||
---
|
||||
|
||||
## Common Commands
|
||||
|
||||
### Local Development
|
||||
|
||||
```bash
|
||||
# Start development server (with hot reload)
|
||||
task serve
|
||||
|
||||
# Build for production
|
||||
task build
|
||||
|
||||
# Build for development (faster, no minification)
|
||||
task build:dev
|
||||
|
||||
# Clean build artifacts
|
||||
task clean
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
```bash
|
||||
# Quick tests (build + markdown)
|
||||
task test:quick
|
||||
|
||||
# Full test suite
|
||||
task test
|
||||
|
||||
# Individual tests
|
||||
task test:build # Hugo build validation
|
||||
task test:markdown # Markdown linting
|
||||
task test:html # HTML validation
|
||||
task test:links # Link checking
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
task deps:install
|
||||
|
||||
# Update dependencies
|
||||
task deps:update
|
||||
|
||||
# Ensure npm dependencies (auto-installs if missing)
|
||||
task deps:ensure-npm
|
||||
```
|
||||
|
||||
### Container Operations
|
||||
|
||||
```bash
|
||||
# Build OCI/Docker image
|
||||
task build:oci-image
|
||||
|
||||
# Build and test container
|
||||
task test:oci-image
|
||||
```
|
||||
|
||||
## File Locations
|
||||
|
||||
### Content
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `content/en/docs/` | Main documentation |
|
||||
| `content/en/blog/` | Blog posts |
|
||||
| `content/en/_index.md` | Homepage |
|
||||
|
||||
### Architecture Models
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `resources/edp-likec4/` | Platform architecture models |
|
||||
| `resources/doc-likec4/` | Documentation platform models |
|
||||
|
||||
### Configuration
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `hugo.toml` | Hugo configuration |
|
||||
| `config.yaml` | Docsy theme config |
|
||||
| `Taskfile.yml` | Task definitions |
|
||||
| `package.json` | npm dependencies and scripts |
|
||||
| `.markdownlint.json` | Markdown linting rules |
|
||||
| `.htmlvalidate.json` | HTML validation rules |
|
||||
| `.htmltest.yml` | Link checker config |
|
||||
|
||||
### Build Output
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `public/` | Generated static site |
|
||||
| `resources/_gen/` | Generated resources (Hugo) |
|
||||
| `data/build_info.json` | Build metadata (git commit, version) |
|
||||
|
||||
## Markdown Frontmatter
|
||||
|
||||
### Standard Page
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Page Title"
|
||||
linkTitle: "Short Title"
|
||||
weight: 10
|
||||
description: >
|
||||
Brief description for SEO and navigation.
|
||||
---
|
||||
```
|
||||
|
||||
### Blog Post
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Post Title"
|
||||
date: 2025-01-15
|
||||
author: "Your Name"
|
||||
description: >
|
||||
Post summary.
|
||||
---
|
||||
```
|
||||
|
||||
## Embedding Architecture Diagrams
|
||||
|
||||
### Basic Embed
|
||||
|
||||
```markdown
|
||||
{{< likec4-view view="view-name" project="project-name" >}}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
- `view` (required) - The view ID from your LikeC4 model
|
||||
- `project` (optional, default: "architecture") - The LikeC4 project name
|
||||
- `title` (optional, default: "Architecture View: {view}") - Custom header text above the diagram
|
||||
|
||||
### Examples
|
||||
|
||||
```markdown
|
||||
{{< likec4-view view="overview" project="documentation-platform" >}}
|
||||
{{< likec4-view view="localDevelopment" project="documentation-platform" >}}
|
||||
{{< likec4-view view="cicdPipeline" project="documentation-platform" >}}
|
||||
{{< likec4-view view="otc-faas" project="architecture" title="OTC FaaS Deployment" >}}
|
||||
```
|
||||
|
||||
## LikeC4 Commands
|
||||
|
||||
### Regenerate Webcomponents
|
||||
|
||||
After modifying `.c4` files:
|
||||
|
||||
```bash
|
||||
task likec4:generate
|
||||
```
|
||||
|
||||
This regenerates both:
|
||||
|
||||
- `static/js/likec4-webcomponent.js` (EDP architecture)
|
||||
- `static/js/likec4-doc-webcomponent.js` (Documentation platform)
|
||||
|
||||
### Start Development Server
|
||||
|
||||
```bash
|
||||
cd resources/doc-likec4 # or resources/edp-likec4
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
Opens LikeC4 IDE at `http://localhost:5173`
|
||||
|
||||
### Export Diagrams
|
||||
|
||||
```bash
|
||||
cd resources/doc-likec4
|
||||
npx likec4 export png -o ./images .
|
||||
```
|
||||
|
||||
## Git Workflow
|
||||
|
||||
### Feature Branch
|
||||
|
||||
```bash
|
||||
# Create feature branch
|
||||
git checkout -b feature/your-feature
|
||||
|
||||
# Make changes and test
|
||||
task serve
|
||||
task test:quick
|
||||
|
||||
# Commit
|
||||
git add .
|
||||
git commit -m "Description of changes"
|
||||
|
||||
# Push
|
||||
git push origin feature/your-feature
|
||||
|
||||
# Create pull request on GitHub
|
||||
```
|
||||
|
||||
### Update from Main
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git checkout feature/your-feature
|
||||
git rebase main
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Port 1313 in use
|
||||
|
||||
```bash
|
||||
lsof -ti:1313 | xargs kill -9
|
||||
```
|
||||
|
||||
### Build errors
|
||||
|
||||
```bash
|
||||
task clean
|
||||
task build:dev
|
||||
```
|
||||
|
||||
### Missing dependencies
|
||||
|
||||
```bash
|
||||
task deps:install
|
||||
```
|
||||
|
||||
### Hugo module issues
|
||||
|
||||
```bash
|
||||
hugo mod clean
|
||||
hugo mod get -u
|
||||
hugo mod tidy
|
||||
```
|
||||
|
||||
### LikeC4 language server
|
||||
|
||||
In VS Code: `Ctrl+Shift+P` → "LikeC4: restart language server"
|
||||
|
||||
## URLs
|
||||
|
||||
### Local Development
|
||||
|
||||
- **Documentation:** <http://localhost:1313>
|
||||
- **LikeC4 IDE:** <http://localhost:5173> (when running `npm start` in likec4 folder)
|
||||
|
||||
### Production
|
||||
|
||||
Check `edgeconnectdeployment.yaml` for deployment URL or run:
|
||||
|
||||
```bash
|
||||
kubectl get service edpdoc -n <namespace>
|
||||
```
|
||||
|
||||
## Quick Checks Before Committing
|
||||
|
||||
1. ✅ `task test:quick` passes
|
||||
2. ✅ Preview looks correct in browser
|
||||
3. ✅ No broken links (visual check)
|
||||
4. ✅ Architecture diagrams render
|
||||
5. ✅ Frontmatter is correct
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Hugo docs:** <https://gohugo.io/documentation/>
|
||||
- **Docsy theme:** <https://www.docsy.dev/docs/>
|
||||
- **LikeC4:** <https://likec4.dev/>
|
||||
- **Task:** <https://taskfile.dev/>
|
||||
|
||||
## View Documentation Architecture
|
||||
|
||||
To understand how this documentation platform works:
|
||||
|
||||
→ Start here: [Documentation About Documentation](../)
|
||||
|
|
@ -1,229 +0,0 @@
|
|||
---
|
||||
title: "Testing"
|
||||
linkTitle: "Testing"
|
||||
weight: 30
|
||||
description: >
|
||||
Quality assurance processes for documentation.
|
||||
---
|
||||
|
||||
## Testing Philosophy
|
||||
|
||||
Quality documentation requires testing. Our testing process validates:
|
||||
|
||||
- **Build integrity** - Hugo can generate the site
|
||||
- **Content quality** - Markdown follows best practices
|
||||
- **HTML validity** - Generated HTML is well-formed
|
||||
- **Link integrity** - No broken internal or external links
|
||||
|
||||
## Testing Capabilities
|
||||
|
||||
{{< likec4-view view="testingCapabilities" project="documentation-platform" >}}
|
||||
|
||||
## Local Testing
|
||||
|
||||
Before committing changes, run tests locally:
|
||||
|
||||
### Quick Tests
|
||||
|
||||
For rapid feedback during development:
|
||||
|
||||
```bash
|
||||
task test:quick
|
||||
```
|
||||
|
||||
This runs:
|
||||
|
||||
- `task test:build` - Hugo build validation
|
||||
- `task test:markdown` - Markdown linting
|
||||
|
||||
### Full Test Suite
|
||||
|
||||
Before creating a pull request:
|
||||
|
||||
```bash
|
||||
task test
|
||||
```
|
||||
|
||||
This runs all tests including:
|
||||
|
||||
- `task test:build` - Build validation
|
||||
- `task test:markdown` - Markdown linting
|
||||
- `task test:html` - HTML validation
|
||||
- `task test:links` - Link checking
|
||||
|
||||
## Individual Tests
|
||||
|
||||
You can run individual tests:
|
||||
|
||||
### Build Test
|
||||
|
||||
Validates that Hugo can build the site:
|
||||
|
||||
```bash
|
||||
task test:build
|
||||
```
|
||||
|
||||
This runs: `hugo --gc --minify --logLevel info`
|
||||
|
||||
**What it checks:**
|
||||
|
||||
- Hugo configuration is valid
|
||||
- Content files have correct frontmatter
|
||||
- Templates render without errors
|
||||
- No circular dependencies in content structure
|
||||
|
||||
### Markdown Lint
|
||||
|
||||
Checks Markdown syntax and style:
|
||||
|
||||
```bash
|
||||
task test:markdown
|
||||
```
|
||||
|
||||
This uses `markdownlint` with custom rules in `.markdownlint.json`.
|
||||
|
||||
**What it checks:**
|
||||
|
||||
- Consistent heading hierarchy
|
||||
- Proper list formatting
|
||||
- Code blocks have language tags
|
||||
- No trailing whitespace
|
||||
- Consistent line length (where applicable)
|
||||
|
||||
**Common issues:**
|
||||
|
||||
- Missing blank lines around code blocks
|
||||
- Inconsistent list markers
|
||||
- Heading levels skipped
|
||||
|
||||
### HTML Validation
|
||||
|
||||
Validates generated HTML:
|
||||
|
||||
```bash
|
||||
task test:html
|
||||
```
|
||||
|
||||
This uses `htmlvalidate` with rules in `.htmlvalidate.json`.
|
||||
|
||||
**What it checks:**
|
||||
|
||||
- Well-formed HTML5
|
||||
- Proper nesting of elements
|
||||
- Valid attributes
|
||||
- Accessible markup
|
||||
|
||||
### Link Checking
|
||||
|
||||
Verifies all links are valid:
|
||||
|
||||
```bash
|
||||
task test:links
|
||||
```
|
||||
|
||||
This uses `htmltest` configured in `.htmltest.yml`.
|
||||
|
||||
**What it checks:**
|
||||
|
||||
- Internal links point to existing pages
|
||||
- External links are reachable
|
||||
- Anchor links target existing elements
|
||||
- No redirects (301/302)
|
||||
|
||||
**Note:** This test can be slow for large sites with many external links.
|
||||
|
||||
## CI Testing
|
||||
|
||||
All tests run automatically on:
|
||||
|
||||
- **Push to `main`** - Full test suite
|
||||
- **Pull requests** - Full test suite
|
||||
|
||||
View the GitHub Actions workflow: `.github/workflows/test.yml`
|
||||
|
||||
### CI Test Results
|
||||
|
||||
If tests fail in CI:
|
||||
|
||||
1. Check the GitHub Actions logs
|
||||
2. Look for specific test failures
|
||||
3. Run the same test locally: `task test:<name>`
|
||||
4. Fix the issue
|
||||
5. Commit and push
|
||||
|
||||
### Artifacts
|
||||
|
||||
CI uploads test artifacts:
|
||||
|
||||
- `htmltest-report/` - Link checking results
|
||||
|
||||
Download these from the GitHub Actions run to investigate failures.
|
||||
|
||||
## Test Configuration Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `.markdownlint.json` | Markdown linting rules |
|
||||
| `.htmlvalidate.json` | HTML validation rules |
|
||||
| `.htmltest.yml` | Link checker configuration |
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Test early, test often** - Run `task test:quick` frequently
|
||||
2. **Fix issues immediately** - Don't accumulate technical debt
|
||||
3. **Understand failures** - Read error messages carefully
|
||||
4. **Update tests** - If rules change, update config files
|
||||
5. **Document exceptions** - If you need to ignore a rule, document why
|
||||
|
||||
## Common Issues and Solutions
|
||||
|
||||
### Markdown: MD031 - Blank lines around fences
|
||||
|
||||
**Problem:** Missing blank line before/after code block
|
||||
|
||||
**Solution:** Add blank lines:
|
||||
|
||||
```markdown
|
||||
Some text
|
||||
|
||||
```bash
|
||||
command here
|
||||
```
|
||||
|
||||
More text
|
||||
```
|
||||
|
||||
### Markdown: MD032 - Blank lines around lists
|
||||
|
||||
**Problem:** Missing blank line before/after list
|
||||
|
||||
**Solution:** Add blank lines:
|
||||
|
||||
```markdown
|
||||
Text before
|
||||
|
||||
- List item 1
|
||||
- List item 2
|
||||
|
||||
Text after
|
||||
```
|
||||
|
||||
### HTML: Invalid nesting
|
||||
|
||||
**Problem:** Elements improperly nested
|
||||
|
||||
**Solution:** Check template files and shortcodes
|
||||
|
||||
### Link Check: 404 Not Found
|
||||
|
||||
**Problem:** Link points to non-existent page
|
||||
|
||||
**Solution:**
|
||||
|
||||
- Fix the link
|
||||
- Create the missing page
|
||||
- Remove the link if no longer relevant
|
||||
|
||||
## Next Steps
|
||||
|
||||
Learn about the automated [CI/CD pipeline](../cicd/).
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
---
|
||||
title: "eDF Documentation Overview"
|
||||
description: "Comprehensive guide for users and auditors to understand and use the eDF."
|
||||
---
|
||||
|
||||
# Meta
|
||||
|
||||
## Guidelines
|
||||
|
||||
1. for users/developers/engineers we describe our output / outcome as product
|
||||
* it is usable
|
||||
* there are links / lists to repos
|
||||
2. we have and describe a 'product-structure-tree'
|
||||
3. for auditors / governance we have a list / cross reference to Jira tickets
|
||||
* R&D ?,
|
||||
* mappen auf die projektphasen, wie erstellt ein team eine plattform?
|
||||
* stw. mobbing, mob programming
|
||||
* mapping auf deliverables von IPCEI-CIS ???, bzw. mapping auf epics?
|
||||
* projekthistorie, projektdynamic, teilprojekt von eDF , teilprojekt-abhängigkiet zB 'Platform'
|
||||
* friendly user phase
|
||||
* forgejo community, OSS, PR handling
|
||||
* externe stakeholder, user experience, think ahead integration
|
||||
* technolgien, technologie-schwerpunkte, cutting-edge research
|
||||
* design/specification und bewertung von lösungsentürfen (zB VictoriaMetrics, GARM, terraform, argoCD, ...)
|
||||
* CI/CD, golden paths (anm.: ist in grobkonzept, deployment von apps von developern fehlt)
|
||||
|
||||
# Introduction
|
||||
- Purpose of the eDF
|
||||
- Target audience (developers, engineers, auditors)
|
||||
- High-level product structure overview
|
||||
- High-level architecture overview
|
||||
|
||||
# eDF Components Overview
|
||||
- List of all major components
|
||||
- Vertical and horizontal layers explained
|
||||
- Component maturity/status (fully integrated, partial, experimental)
|
||||
|
||||
# Getting Started
|
||||
- Quickstart guide for developers
|
||||
- Onboarding steps for eDF engineers
|
||||
- Prerequisites and environment setup
|
||||
|
||||
# Component Details
|
||||
For each component:
|
||||
- Description and purpose
|
||||
- Repository link
|
||||
- README summary
|
||||
- Architecture diagrams (link to Miro/Lucid)
|
||||
- Usage instructions
|
||||
- Integration points
|
||||
|
||||
# Development Experience
|
||||
- How to contribute
|
||||
- Local development workflow
|
||||
- CI/CD pipelines
|
||||
- Testing and validation
|
||||
|
||||
# Operational Experience
|
||||
- Deployment guides
|
||||
- Monitoring and observability
|
||||
- Troubleshooting
|
||||
|
||||
# Audit & Compliance
|
||||
- Overview of implemented controls
|
||||
- Ticket references (Jira, changelogs)
|
||||
- Documentation of decisions and reviews
|
||||
- Evidence of value and coverage
|
||||
|
||||
# FAQ & Support
|
||||
- Common issues and solutions
|
||||
- Contact points for help
|
||||
|
||||
# Appendix
|
||||
- Glossary
|
||||
- References to external resources
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
title: Humanitec
|
||||
weight: 4
|
||||
---
|
||||
|
||||
|
||||
tbd
|
||||
46
content/en/docs/_index.md
Normal file → Executable file
46
content/en/docs/_index.md
Normal file → Executable file
|
|
@ -1,45 +1,9 @@
|
|||
---
|
||||
title: "Documentation"
|
||||
linkTitle: "Documentation"
|
||||
menu:
|
||||
main:
|
||||
weight: 20
|
||||
title: Developer Framework Documentation
|
||||
linkTitle: Docs
|
||||
menu: {main: {weight: 20}}
|
||||
weight: 20
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
This section is the project documentation for IPCEI-CIS Developer Framework.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
# Edge Developer Platform (EDP) Documentation
|
||||
|
||||
Welcome to the EDP documentation. This documentation serves developers, engineers, and auditors who want to understand, use, and audit the Edge Developer Platform.
|
||||
|
||||
## Target Audience
|
||||
|
||||
* **Developers & Engineers**: Learn how to use the platform, deploy applications, and integrate services
|
||||
* **Platform Engineers**: Understand the architecture, components, and operational aspects
|
||||
* **Auditors & Governance**: Access project history, decisions, and compliance information
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
The documentation follows a top-down approach focusing on outcomes and practical usage:
|
||||
|
||||
* **Platform Overview**: High-level introduction and product structure
|
||||
* **Components**: Individual platform components and their usage
|
||||
* **Getting Started**: Onboarding and quick start guides
|
||||
* **Operations**: Deployment, monitoring, and troubleshooting
|
||||
* **Governance**: Project history, decisions, and compliance
|
||||
|
||||
## Purpose
|
||||
|
||||
This documentation describes the outcomes and products of the edgeDeveloperFramework (eDF) project. The EDP is designed as a usable, integrated platform with clear links to repositories and implementation details.
|
||||
|
|
|
|||
|
|
@ -10,14 +10,60 @@ This document describes the high-level architecture of our Enterprise Developmen
|
|||
|
||||
## Interactive Architecture Diagram
|
||||
|
||||
{{< likec4-view view="otc-faas" project="architecture" title="Enterprise Development Platform - OTC FaaS Deployment Architecture" >}}
|
||||
<div class="likec4-container">
|
||||
<div class="likec4-header">
|
||||
Enterprise Development Platform - OTC FaaS Deployment Architecture
|
||||
</div>
|
||||
<likec4-view view-id="otc-faas" browser="true"></likec4-view>
|
||||
<div class="likec4-loading" id="likec4-loading">
|
||||
Loading architecture diagram...
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Enhanced loading check with fallback
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
let attempts = 0;
|
||||
const maxAttempts = 10;
|
||||
|
||||
function checkLikeC4Loading() {
|
||||
attempts++;
|
||||
const component = document.querySelector('likec4-view');
|
||||
const loading = document.getElementById('likec4-loading');
|
||||
|
||||
if (component && component.shadowRoot && component.shadowRoot.children.length > 0) {
|
||||
if (loading) loading.style.display = 'none';
|
||||
console.log('LikeC4 component loaded successfully');
|
||||
} else if (attempts >= maxAttempts) {
|
||||
console.warn('LikeC4 component failed to load');
|
||||
if (loading) {
|
||||
loading.innerHTML = 'Interactive diagram failed to load. <br><small>Please ensure JavaScript is enabled and the webcomponent is generated.</small>';
|
||||
loading.style.color = '#dc3545';
|
||||
}
|
||||
} else {
|
||||
setTimeout(checkLikeC4Loading, 1000);
|
||||
}
|
||||
}
|
||||
|
||||
// Check if LikeC4 loader is available
|
||||
if (typeof window.customElements !== 'undefined') {
|
||||
setTimeout(checkLikeC4Loading, 1500);
|
||||
} else {
|
||||
const loading = document.getElementById('likec4-loading');
|
||||
if (loading) {
|
||||
loading.innerHTML = 'Interactive diagrams require a modern browser with JavaScript enabled.';
|
||||
loading.style.color = '#dc3545';
|
||||
}
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
{{< alert title="Interactive Diagram" >}}
|
||||
The diagram above is interactive when viewed in a compatible browser.
|
||||
You can click on components to explore the architecture details.
|
||||
|
||||
**Note:** The interactive diagram requires the LikeC4 webcomponent to be generated.
|
||||
See the [setup instructions]({{< ref "/docs-old/architecture/setup" >}}) for details.
|
||||
See the [setup instructions]({{< ref "/docs/architecture/setup" >}}) for details.
|
||||
{{< /alert >}}
|
||||
|
||||
## Architecture Overview
|
||||
|
|
@ -64,11 +110,11 @@ The interactive diagram above shows the relationships between different componen
|
|||
|
||||
To update or modify the architecture diagrams:
|
||||
|
||||
1. Edit the `.c4` files in `resources/edp-likec4/`
|
||||
1. Edit the `.c4` files in `resources/likec4/`
|
||||
2. Regenerate the webcomponent:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
npx likec4 codegen webcomponent \
|
||||
--webcomponent-prefix likec4 \
|
||||
--outfile ../../static/js/likec4-webcomponent.js
|
||||
|
|
@ -76,4 +122,4 @@ To update or modify the architecture diagrams:
|
|||
|
||||
3. Commit both the model changes and the regenerated JavaScript file
|
||||
|
||||
For more information, see the [LikeC4 Integration Guide]({{< ref "/docs-old/architecture/setup" >}}).
|
||||
For more information, see the [LikeC4 Integration Guide]({{< ref "/docs/architecture/setup" >}}).
|
||||
|
|
@ -24,7 +24,7 @@ LikeC4 enables you to create interactive C4 architecture diagrams as code. The d
|
|||
Navigate to the LikeC4 directory and install dependencies:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
npm install
|
||||
```
|
||||
|
||||
|
|
@ -39,7 +39,6 @@ npx likec4 codegen webcomponent \
|
|||
```
|
||||
|
||||
This command:
|
||||
|
||||
- Reads all `.c4` files from `models/` and `views/`
|
||||
- Generates a single JavaScript file with all architecture views
|
||||
- Outputs to `static/js/likec4-webcomponent.js`
|
||||
|
|
@ -55,8 +54,8 @@ The integration should already be configured in:
|
|||
|
||||
## Directory Structure
|
||||
|
||||
```plaintext
|
||||
resources/edp-likec4/
|
||||
```
|
||||
resources/likec4/
|
||||
├── models/ # C4 model definitions
|
||||
│ ├── components/ # Component models
|
||||
│ ├── containers/ # Container models
|
||||
|
|
@ -94,12 +93,11 @@ Add this to any Markdown file:
|
|||
To find available view IDs, search the `.c4` files:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
grep -r "view\s\+\w" views/ models/ --include="*.c4"
|
||||
```
|
||||
|
||||
Common views:
|
||||
|
||||
- `otc-faas` - OTC FaaS deployment
|
||||
- `edp` - EDP overview
|
||||
- `landscape` - Developer landscape
|
||||
|
|
@ -130,14 +128,14 @@ Click on components in the diagram to explore the architecture.
|
|||
|
||||
### 1. Modify Architecture Models
|
||||
|
||||
Edit the `.c4` files in `resources/edp-likec4/`:
|
||||
Edit the `.c4` files in `resources/likec4/`:
|
||||
|
||||
```bash
|
||||
# Edit a model
|
||||
vi resources/edp-likec4/models/containers/argocd.c4
|
||||
vi resources/likec4/models/containers/argocd.c4
|
||||
|
||||
# Or edit a view
|
||||
vi resources/edp-likec4/views/deployment/otc/otc-faas.c4
|
||||
vi resources/likec4/views/deployment/otc/otc-faas.c4
|
||||
```
|
||||
|
||||
### 2. Preview Changes Locally
|
||||
|
|
@ -145,7 +143,7 @@ vi resources/edp-likec4/views/deployment/otc/otc-faas.c4
|
|||
Use the LikeC4 CLI to preview:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
|
||||
# Start preview server
|
||||
npx likec4 start
|
||||
|
|
@ -158,7 +156,7 @@ npx likec4 start
|
|||
After making changes:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
npx likec4 codegen webcomponent \
|
||||
--webcomponent-prefix likec4 \
|
||||
--outfile ../../static/js/likec4-webcomponent.js
|
||||
|
|
@ -180,7 +178,7 @@ hugo server -D
|
|||
Commit both the model files and the regenerated web component:
|
||||
|
||||
```bash
|
||||
git add resources/edp-likec4/
|
||||
git add resources/likec4/
|
||||
git add static/js/likec4-webcomponent.js
|
||||
git commit -m "feat: update architecture diagrams"
|
||||
```
|
||||
|
|
@ -244,15 +242,12 @@ Then update `layouts/partials/hooks/head-end.html`:
|
|||
|
||||
1. **Check browser console** (F12 → Console)
|
||||
2. **Verify webcomponent exists:**
|
||||
|
||||
```bash
|
||||
ls -lh static/js/likec4-webcomponent.js
|
||||
```
|
||||
|
||||
3. **Regenerate if missing:**
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
npm install
|
||||
npx likec4 codegen webcomponent \
|
||||
--webcomponent-prefix likec4 \
|
||||
|
|
@ -263,9 +258,8 @@ Then update `layouts/partials/hooks/head-end.html`:
|
|||
|
||||
- Check view ID matches exactly (case-sensitive)
|
||||
- Search for the view in `.c4` files:
|
||||
|
||||
```bash
|
||||
grep -r "view otc-faas" resources/edp-likec4/
|
||||
grep -r "view otc-faas" resources/likec4/
|
||||
```
|
||||
|
||||
### Styling Issues
|
||||
|
|
@ -278,7 +272,7 @@ Then update `layouts/partials/hooks/head-end.html`:
|
|||
If LikeC4 codegen fails:
|
||||
|
||||
```bash
|
||||
cd resources/edp-likec4
|
||||
cd resources/likec4
|
||||
rm -rf node_modules package-lock.json
|
||||
npm install
|
||||
```
|
||||
|
|
@ -1,141 +0,0 @@
|
|||
---
|
||||
title: "[Component Name]"
|
||||
linkTitle: "[Short Name]"
|
||||
weight: 1
|
||||
description: >
|
||||
[Brief one-line description of the component]
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## Integration Points
|
||||
|
||||
* **[Component A]**: [How it integrates]
|
||||
* **[Component B]**: [How it integrates]
|
||||
* **[Component C]**: [How it integrates]
|
||||
|
||||
## Architecture
|
||||
|
||||
[Optional: Add architectural diagrams and descriptions]
|
||||
|
||||
### C4 charts
|
||||
|
||||
Embed C4 charts this way:
|
||||
|
||||
1. add a likec4-view with the name of the view
|
||||
{{< likec4-view view="components-template-documentation" project="architecture" title="Example Documentation Diagram" >}}
|
||||
|
||||
2. create the LikeC4 view somewhere in ```./resources/edp-likec4/views```, the example above is in ```./resources/edp-likec4/views/documentation/components-template-documentation.c4```
|
||||
|
||||
3. run ```task likec4:generate``` to create the webcomponent
|
||||
|
||||
4. if you are in ```task:serve``` hot-reload mode the view will show up directly
|
||||
|
||||
### 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: "Components"
|
||||
linkTitle: "Components"
|
||||
weight: 30
|
||||
description: >
|
||||
Overview of EDP platform components and their integration.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: Stephan
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
This section documents all components of the Edge Developer Platform based on the product structure.
|
||||
|
||||
## Component Categories
|
||||
|
||||
The EDP consists of the following main component categories:
|
||||
|
||||
* **Orchestrator**: Platform and infrastructure orchestration
|
||||
* **Forgejo & CI/CD**: Source code management and automation
|
||||
* **Deployments**: Deployment targets and edge connectivity
|
||||
* **Dev Environments**: Development environment provisioning
|
||||
* **Physical Environments**: Runtime infrastructure
|
||||
|
||||
### Product Component Structure
|
||||
|
||||
[TODO] Links
|
||||
|
||||
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
title: "Deployments"
|
||||
linkTitle: "Deployments"
|
||||
weight: 40
|
||||
description: >
|
||||
Deployment targets and edge connectivity solutions.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6733](https://jira.telekom-mms.com/browse/IPCEICIS-6733)
|
||||
* **Assignee**: Patrick
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
Deployment components manage connections to various deployment targets including cloud infrastructure and edge devices.
|
||||
|
||||
## Components
|
||||
|
||||
* **OTC**: Open Telekom Cloud deployment target
|
||||
* **EdgeConnect**: Secure edge connectivity solution
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "EdgeConnect"
|
||||
linkTitle: "EdgeConnect"
|
||||
weight: 20
|
||||
description: >
|
||||
Secure connectivity solution for edge devices and environments
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6734](https://jira.telekom-mms.com/browse/IPCEICIS-6734)
|
||||
* **Assignee**: Waldemar
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "EdgeConnect Client"
|
||||
linkTitle: "EdgeConnect Client"
|
||||
weight: 30
|
||||
description: >
|
||||
Client software for establishing EdgeConnect connections
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6734](https://jira.telekom-mms.com/browse/IPCEICIS-6734)
|
||||
* **Assignee**: Waldemar
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "EdgeConnect SDK"
|
||||
linkTitle: "EdgeConnect SDK"
|
||||
weight: 10
|
||||
description: >
|
||||
Software Development Kit for establishing EdgeConnect connections
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6734](https://jira.telekom-mms.com/browse/IPCEICIS-6734)
|
||||
* **Assignee**: Waldemar
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "OTC (Open Telekom Cloud)"
|
||||
linkTitle: "OTC"
|
||||
weight: 10
|
||||
description: >
|
||||
Open Telekom Cloud deployment and infrastructure target
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6733](https://jira.telekom-mms.com/browse/IPCEICIS-6733)
|
||||
* **Assignee**: Patrick
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Development Environments"
|
||||
linkTitle: "DevEnvironments"
|
||||
weight: 30
|
||||
description: >
|
||||
Development environment provisioning and management
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
title: "Documentation System"
|
||||
linkTitle: "Documentation System"
|
||||
weight: 100
|
||||
description: The developer 'documentation as code' documentation System we use ourselfes and over to use for each development team.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6736](https://jira.telekom-mms.com/browse/IPCEICIS-6736)
|
||||
* **Assignee**: Stephan
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
The Orchestration manages platform and infrastructure provisioning, providing the foundation for the EDP deployment model.
|
||||
|
||||
## Sub-Components
|
||||
|
||||
* **Infrastructure Provisioning**: Low-level infrastructure deployment (infra-deploy, infra-catalogue)
|
||||
* **Platform Provisioning**: Platform-level component deployment via Stacks
|
||||
|
|
@ -1,108 +0,0 @@
|
|||
---
|
||||
title: "Forgejo"
|
||||
linkTitle: "Forgejo"
|
||||
weight: 20
|
||||
description: Forgejo provides source code management, project management, and CI/CD automation for the EDP.
|
||||
---
|
||||
|
||||
The internal service is officially designated as the Edge Developer Platform (EDP). It is hosted at **[edp.buildth.ing](https://edp.buildth.ing)**. The domain selection followed a democratic team process to establish a unique identity distinct from standard corporate naming conventions.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Technical Architecture & Deployment
|
||||
|
||||
### Infrastructure Stack
|
||||
|
||||
The platform is hosted on the **Open Telekom Cloud (OTC)**. The infrastructure adheres to Infrastructure-as-Code (IaC) principles.
|
||||
|
||||
* **Deployment Method:** The official Forgejo Helm Chart is deployed via **ArgoCD**.
|
||||
* **Infrastructure Provisioning:** **Terraform** is used to provision all underlying OTC services, including:
|
||||
* **Container Orchestration**: CCE (Cloud Container Engine): Kubernetes
|
||||
* **Database:** RDS (Distributed Cache Service): PostgreSQL
|
||||
* **Caching:** DCS (Distributed Cache Service): Redis
|
||||
* **Object Storage:** OBS (Object Storage Service, S3-compatible): for user data (avatars, attachments).
|
||||
* **Search:** CSS (Cloud Search Service): Elasticsearch
|
||||
|
||||
### The "Self-Replicating" Pipeline
|
||||
|
||||
A key architectural feature is the ability of the platform to maintain itself. A Forgejo Action can trigger the deployment script, which runs Terraform and syncs ArgoCD, effectively allowing "Forgejo to create/update Forgejo."
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph "Open Telekom Cloud (OTC)"
|
||||
subgraph "Control Plane"
|
||||
Dev[DevOps Engineer] -->|Triggers| Pipeline[Deployment Pipeline]
|
||||
Pipeline -->|Executes| TF[Terraform]
|
||||
end
|
||||
|
||||
subgraph "Provisioned Infrastructure"
|
||||
TF -->|Provisions| CCE[(CCE K8s Cluster)]
|
||||
TF -->|Provisions| RDS[(RDS PostgreSQL)]
|
||||
TF -->|Provisions| Redis[(DCS Redis)]
|
||||
TF -->|Provisions| S3[(OBS S3 Bucket)]
|
||||
TF -->|Provisions| CSS[(CSS Elasticsearch)]
|
||||
end
|
||||
|
||||
subgraph "Application Layer (on CCE K8s)"
|
||||
Pipeline -->|Helm Chart| Argo[ArgoCD]
|
||||
Argo -->|Deploys| ForgejoApp[Forgejo]
|
||||
end
|
||||
|
||||
CCE -- Runs --> Argo
|
||||
CCE -- Runs --> ForgejoApp
|
||||
ForgejoApp -->|Connects| RDS
|
||||
ForgejoApp -->|Connects| Redis
|
||||
ForgejoApp -->|Connects| S3
|
||||
ForgejoApp -->|Connects| CSS
|
||||
end
|
||||
```
|
||||
|
||||
### Migration History
|
||||
|
||||
The initial environment was a manual setup on the Open Sovereign Cloud (OSC). Once the automation stack (Terraform/ArgoCD) was matured, the platform was migrated to the current OTC environment.
|
||||
|
||||
## Application Extensions
|
||||
|
||||
### Core Functionality
|
||||
|
||||
Beyond standard Git versioning, the platform utilizes:
|
||||
|
||||
* **Releases:** Hosting binaries for software distribution (e.g., Edge Connect CLI).
|
||||
* **CI/CD:** Extensive pipeline usage for build, test, and deployment automation.
|
||||
* **Note on Issues:** While initially used, issue tracking was migrated to JIRA to align with the broader IPCEI program standards.
|
||||
|
||||
### GARM (Git-based Actions Runner Manager)
|
||||
|
||||
The primary technical innovation was the integration of [GARM](./actions/runner-orchestration.md) to enable ephemeral, scalable runners. This required extending Forgejo's capabilities to support GitHub-compatible runner registration and webhook events.
|
||||
|
||||
## Development Methodology & Contributions
|
||||
|
||||
### Workflow
|
||||
|
||||
* **Branching Strategy:** Trunk-based development was utilized to ensure rapid integration.
|
||||
* **Collaboration:** The team adopted **Mob Programming**. This practice proved essential for knowledge sharing and onboarding junior developers, creating a resilient and high-intensity learning environment.
|
||||
* **Versions:** The platform evolved from Forgejo v7/8 to the current v11.0.3-edp1. An upgrade is pending to leverage the latest upstream GARM features.
|
||||
|
||||
### Open Source Contributions
|
||||
|
||||
We actively contributed our extensions back to the upstream Forgejo project in [a list of Codeberg.org pull requests](../../governance/_index.md#forgejo)
|
||||
|
||||
|
||||
### Artifact Caching (Pull-Through Proxy)
|
||||
|
||||
We implemented a feature allowing Forgejo to act as a pull-through proxy for remote container registries, optimizing bandwidth and build speeds.
|
||||
|
||||
* [Source Code Branch: refactor-remote-registry-client](https://edp.buildth.ing/DevFW/edp-forgejo/src/branch/refactor-remote-registry-client)
|
||||
|
||||
## Key Performance Indicators (KPIs)
|
||||
|
||||
These KPIs measure the effectiveness of the Forgejo setup and quantify our strategic commitment to the Forgejo community.
|
||||
|
||||
| KPI | Description | Target / Benchmark |
|
||||
| :--- | :--- | :--- |
|
||||
| **Deployment Frequency** | Frequency of successful pipeline executions. | High (Daily/On-demand) |
|
||||
| **Artifact Cache Hit Rate** | Percentage of build requests served by the local Forgejo proxy. | > 90% (Reduced external traffic) |
|
||||
| **Upstream Contribution** | Percentage of GARM-related features contributed back to Codeberg. | 100% (No vendor lock-in) |
|
||||
| **PR Resolution Time** | Average time for upstream community review and merge. | < 14 days (Healthy collaboration) |
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
title: "Forgejo Actions"
|
||||
linkTitle: "Forgejo Actions"
|
||||
weight: 20
|
||||
description: Forgejo Actions.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6730](https://jira.telekom-mms.com/browse/IPCEICIS-6730)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
Forgejo provides source code management, project management, and CI/CD automation for the EDP.
|
||||
|
||||
## Sub-Components
|
||||
|
||||
* **Project Management**: Issue tracking and project management features
|
||||
* **Actions**: CI/CD automation (see CI/CD section)
|
||||
|
|
@ -1,127 +0,0 @@
|
|||
---
|
||||
title: "Forgejo Actions"
|
||||
linkTitle: "Actions"
|
||||
weight: 10
|
||||
description: GitHub Actions-compatible CI/CD automation
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,140 +0,0 @@
|
|||
---
|
||||
title: "Runner Orchestration"
|
||||
linkTitle: "Runner Orchestration"
|
||||
weight: 30
|
||||
description: GARM
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## Integration Points
|
||||
|
||||
* **[Component A]**: [How it integrates]
|
||||
* **[Component B]**: [How it integrates]
|
||||
* **[Component C]**: [How it integrates]
|
||||
|
||||
## Architecture
|
||||
|
||||
The primary technical innovation was the integration of **[GARM](https://github.com/cloudbase/garm)** to enable ephemeral, scalable runners. This required extending Forgejo's capabilities to support GitHub-compatible runner registration and webhook events.
|
||||
|
||||
**Workflow Architecture:**
|
||||
|
||||
1. **Event:** A workflow event occurs in Forgejo.
|
||||
2. **Trigger:** A webhook notifies GARM.
|
||||
3. **Provisioning:** GARM spins up a fresh, ephemeral runner.
|
||||
4. **Execution:** The runner registers via the API, executes the job, and is terminated immediately after, ensuring a clean build environment.
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Forgejo
|
||||
participant GARM
|
||||
participant Runner as Ephemeral Runner
|
||||
|
||||
User->>Forgejo: Push Code / Trigger Event
|
||||
Forgejo->>GARM: Webhook Event (Workflow Dispatch)
|
||||
GARM->>Forgejo: Register Runner (via API)
|
||||
GARM->>Runner: Spin up Instance
|
||||
Runner->>Forgejo: Request Job
|
||||
Forgejo->>Runner: Send Job Payload
|
||||
Runner->>Runner: Execute Steps
|
||||
Runner->>Forgejo: Report Status
|
||||
GARM->>Runner: Terminate (Ephemeral)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Action Runner"
|
||||
linkTitle: "Runner"
|
||||
weight: 20
|
||||
description: >
|
||||
Self-hosted runner infrastructure with orchestration capabilities
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 218 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 122 KiB |
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Project Management"
|
||||
linkTitle: "Forgejo Project Mgmt"
|
||||
weight: 50
|
||||
description: >
|
||||
Project and issue management capabilities within Forgejo
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,246 +0,0 @@
|
|||
---
|
||||
title: "Orchestration"
|
||||
linkTitle: "Orchestration"
|
||||
weight: 10
|
||||
description: >
|
||||
Orchestration in the context of Platform Engineering - coordinating infrastructure, platform, and application delivery.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Orchestration in the context of Platform Engineering refers to the coordinated automation and management of infrastructure, platform, and application components throughout their entire lifecycle. It is a fundamental concept that bridges the gap between declarative specifications (what should be deployed) and actual execution (how it is deployed).
|
||||
|
||||
## The Role of Orchestration in Platform Engineering
|
||||
|
||||
Platform Engineering has emerged as a discipline to improve developer experience and reduce cognitive load on development teams ([CNCF Platforms White Paper](https://tag-app-delivery.cncf.io/whitepapers/platforms/)). Orchestration is the central mechanism that enables this vision:
|
||||
|
||||
1. **Automation of Complex Workflows**: Orchestration coordinates multiple steps and dependencies automatically
|
||||
2. **Consistency and Reproducibility**: Guaranteed, repeatable deployments across different environments
|
||||
3. **Self-Service Capabilities**: Developers can independently orchestrate resources and deployments
|
||||
4. **Governance and Compliance**: Centralized control over policies and best practices
|
||||
|
||||
### What Does Orchestration Do?
|
||||
|
||||
Orchestration systems perform the following tasks:
|
||||
|
||||
- **Workflow Coordination**: Coordination of complex, multi-step deployment processes
|
||||
- **Dependency Management**: Resolution and management of dependencies between components
|
||||
- **State Management**: Continuous monitoring and reconciliation between desired and actual state
|
||||
- **Resource Provisioning**: Automatic provisioning of infrastructure and services
|
||||
- **Configuration Management**: Management of configurations across different environments
|
||||
- **Health Monitoring**: Monitoring the health of deployed resources
|
||||
|
||||
## Three Layers of Orchestration
|
||||
|
||||
In modern Platform Engineering, we distinguish three fundamental layers of orchestration:
|
||||
|
||||
### [Infrastructure Orchestration](infrastructure/)
|
||||
|
||||
Infrastructure Orchestration deals with the lowest level - the physical and virtual infrastructure layer. This includes:
|
||||
|
||||
- Provisioning of compute, network, and storage resources
|
||||
- Cloud resource management (VMs, networking, storage)
|
||||
- Infrastructure-as-Code deployment (Terraform, etc.)
|
||||
- Bare metal and hypervisor management
|
||||
|
||||
**Target Audience**: Infrastructure Engineers, Cloud Architects
|
||||
|
||||
**Note**: Detailed documentation for Infrastructure Orchestration is maintained separately.
|
||||
|
||||
More details: [Infrastructure Orchestration →](infrastructure/)
|
||||
|
||||
### [Platform Orchestration](platform/)
|
||||
|
||||
Platform Orchestration focuses on deploying and managing the platform itself - the services and tools that development teams use. This includes:
|
||||
|
||||
- Installation and configuration of Kubernetes clusters
|
||||
- Deployment of platform services (GitOps tools, Observability, Security)
|
||||
- Management of platform components via Stacks
|
||||
- Multi-cluster orchestration
|
||||
|
||||
**Target Audience**: Platform Engineering Teams, SRE Teams
|
||||
|
||||
**In IPCEI-CIS**: Platform orchestration is realized using the CNOE stack concept with ArgoCD and Forgejo.
|
||||
|
||||
More details: [Platform Orchestration →](platform/)
|
||||
|
||||
### [Application Orchestration](application/)
|
||||
|
||||
Application Orchestration concentrates on the deployment and lifecycle management of applications running on the platform. This includes:
|
||||
|
||||
- Deployment of microservices and containerized applications
|
||||
- CI/CD pipeline orchestration
|
||||
- Configuration management and secrets handling
|
||||
- Application health monitoring and auto-scaling
|
||||
|
||||
**Target Audience**: Application Developers, DevOps Engineers
|
||||
|
||||
**In IPCEI-CIS**: Application orchestration uses Forgejo pipelines for CI/CD and ArgoCD for GitOps-based deployment.
|
||||
|
||||
More details: [Application Orchestration →](application/)
|
||||
|
||||
## GitOps as Orchestration Paradigm
|
||||
|
||||
A central approach in modern platform orchestration solutions is **GitOps**. GitOps uses Git repositories as the single source of truth for declarative infrastructure and applications:
|
||||
|
||||
- **Declarative Approach**: The desired state is defined in Git
|
||||
- **Automatic Synchronization**: Controllers monitor Git and reconcile the live state
|
||||
- **Audit Trail**: All changes are traceable in Git history
|
||||
- **Rollback Capability**: Easy rollback through Git revert
|
||||
|
||||
### Continuous Reconciliation
|
||||
|
||||
An important concept is **continuous reconciliation**:
|
||||
|
||||
1. The orchestrator monitors both the source (Git) and the target (e.g., Kubernetes cluster)
|
||||
2. Deviations trigger automatic corrective actions
|
||||
3. Health checks validate that the desired state has been achieved
|
||||
4. Drift detection warns of unexpected changes
|
||||
|
||||
## Orchestration Tools in IPCEI-CIS
|
||||
|
||||
Within the IPCEI-CIS platform, we utilize the [CNOE (Cloud Native Operational Excellence)](https://cnoe.io/) stack concept with the following orchestration components:
|
||||
|
||||
### ArgoCD
|
||||
|
||||
- **Continuous Delivery** for Kubernetes based on GitOps
|
||||
- Synchronizes Kubernetes manifests from Git repositories
|
||||
- Supports Helm Charts, Kustomize, Jsonnet, and plain YAML
|
||||
- Multi-cluster deployment capabilities
|
||||
- Application Sets for parameterized deployments
|
||||
|
||||
**Role in IPCEI-CIS**: ArgoCD is the central component for GitOps-based deployment management. After the initial bootstrapping phase, ArgoCD takes over the technical coordination of all components.
|
||||
|
||||
### Forgejo
|
||||
|
||||
- **Git Repository Management** and source control
|
||||
- **CI/CD Pipelines** via Forgejo Actions (GitHub Actions compatible)
|
||||
- **Developer Portal Capabilities** (initially planned, project discontinued)
|
||||
- Package registry and artifact management
|
||||
- Integration with ArgoCD for GitOps workflows
|
||||
|
||||
**Role in IPCEI-CIS**: Forgejo serves as the Git repository host and CI/CD engine. It was initially planned as a developer portal (similar to Backstage's role in other stacks) but this aspect was not fully realized before project completion.
|
||||
|
||||
**Note on Backstage**: In typical CNOE implementations, Backstage serves as the developer portal providing golden paths through software templates. IPCEI-CIS initially planned to use Forgejo for this purpose but the project concluded before full implementation.
|
||||
|
||||
### Terraform
|
||||
|
||||
- **Infrastructure-as-Code** provisioning
|
||||
- Multi-cloud resource management
|
||||
- State management for infrastructure
|
||||
- Integration with Forgejo pipelines for automated deployment
|
||||
|
||||
**Role in IPCEI-CIS**: Terraform handles infrastructure provisioning at the infrastructure orchestration layer, integrated into automated workflows via Forgejo pipelines.
|
||||
|
||||
### CNOE Stacks Concept
|
||||
|
||||
- **Modular Platform Components** bundled as stacks
|
||||
- Reusable, composable platform building blocks
|
||||
- Version-controlled stack definitions
|
||||
- GitOps-based stack deployment via ArgoCD
|
||||
|
||||
**Role in IPCEI-CIS**: The stacks concept from CNOE provides the structural foundation for platform orchestration, enabling modular deployment and management of platform components.
|
||||
|
||||
## The Orchestration Workflow
|
||||
|
||||
A typical orchestration workflow in the IPCEI-CIS platform:
|
||||
|
||||
```text
|
||||
┌─────────────┐ ┌───────────┐ ┌───────────┐ ┌────────────┐
|
||||
│ Developer │────▶│ Forgejo │────▶│ Git │────▶│ ArgoCD │
|
||||
│ │ │ Pipelines│ │Repository │ │ │
|
||||
└─────────────┘ └───────────┘ └───────────┘ └─────┬──────┘
|
||||
│
|
||||
▼
|
||||
┌───────────────────────────────────────────────┐
|
||||
│ │
|
||||
│ Kubernetes Cluster(s) │
|
||||
│ │
|
||||
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
|
||||
│ │ Apps │ │Services │ │Resources │ │
|
||||
│ └──────────┘ └──────────┘ └──────────┘ │
|
||||
│ │
|
||||
└───────────────────────────────────────────────┘
|
||||
▲
|
||||
│
|
||||
┌────┴─────┐
|
||||
│Terraform │
|
||||
│ │
|
||||
└──────────┘
|
||||
```
|
||||
|
||||
**Workflow Steps**:
|
||||
|
||||
1. **Definition**: Developer defines application/infrastructure as code
|
||||
2. **Commit**: Changes are committed to Forgejo Git repository
|
||||
3. **CI Pipeline**: Forgejo Actions build, test, and package the application
|
||||
4. **Sync**: ArgoCD detects changes and triggers deployment
|
||||
5. **Provision**: Terraform orchestrates required cloud resources (if needed)
|
||||
6. **Deploy**: Application is deployed to Kubernetes
|
||||
7. **Monitor**: Continuous monitoring and health checks
|
||||
8. **Reconcile**: Automatic correction on drift detection
|
||||
|
||||
## Benefits of Coordinated Orchestration
|
||||
|
||||
The integration of infrastructure, platform, and application orchestration provides crucial advantages:
|
||||
|
||||
- **Reduced Complexity**: Developers don't need to know all infrastructure details
|
||||
- **Faster Time-to-Market**: Automated workflows accelerate deployments
|
||||
- **Consistency**: Standardized patterns across all teams
|
||||
- **Governance**: Central policies are automatically enforced
|
||||
- **Scalability**: Platform teams can support many application teams
|
||||
- **Self-Service**: Developers can provision services independently
|
||||
- **Audit and Compliance**: Complete traceability through Git history
|
||||
|
||||
## Best Practices
|
||||
|
||||
Successful orchestration follows proven principles ([Platform Engineering Principles](https://platformengineering.org/blog/what-is-platform-engineering)):
|
||||
|
||||
1. **Platform as a Product**: Treat the platform as a product with focus on user experience
|
||||
2. **Self-Service First**: Enable developers to use services autonomously
|
||||
3. **Documentation**: Comprehensive documentation of golden paths
|
||||
4. **Feedback Loops**: Continuous improvement through user feedback
|
||||
5. **Thin Platform Layer**: Use managed services where possible instead of building everything
|
||||
6. **Progressive Disclosure**: Offer different abstraction levels
|
||||
7. **Focus on Common Problems**: Solve recurring problems centrally
|
||||
8. **Treat Glue as Valuable**: Integration of different tools is valuable
|
||||
9. **Clear Mission**: Define clear goals and responsibilities
|
||||
|
||||
## Avoiding Anti-Patterns
|
||||
|
||||
Common mistakes in platform orchestration ([How to fail at Platform Engineering](https://www.cncf.io/blog/2024/03/08/how-to-fail-at-platform-engineering/)):
|
||||
|
||||
- **Product Misfit**: Building platform without involving developers
|
||||
- **Overly Complex Design**: Too many features and unnecessary complexity
|
||||
- **Swiss Knife Syndrome**: Trying to solve all problems with one tool
|
||||
- **Insufficient Documentation**: Missing or outdated documentation
|
||||
- **Siloed Development**: Platform and development teams working in isolation
|
||||
- **Stagnant Platform**: Platform not continuously evolved
|
||||
|
||||
## Sub-Components
|
||||
|
||||
The orchestration component includes the following sub-areas:
|
||||
|
||||
- **[Infrastructure Orchestration](infrastructure/)**: Low-level infrastructure deployment and provisioning
|
||||
- **[Platform Orchestration](platform/)**: Platform-level component deployment via Stacks
|
||||
- **[Application Orchestration](application/)**: Application-level deployment and CI/CD
|
||||
- **[Stacks](stacks/)**: Reusable component bundles and compositions
|
||||
|
||||
## Further Resources
|
||||
|
||||
### Fundamentals
|
||||
|
||||
- [CNCF Platforms White Paper](https://tag-app-delivery.cncf.io/whitepapers/platforms/) - Comprehensive paper on Platform Engineering
|
||||
- [Platform Engineering Definition](https://platformengineering.org/blog/what-is-platform-engineering) - What is Platform Engineering?
|
||||
- [Team Topologies](https://teamtopologies.com/) - Organizational structures for modern teams
|
||||
|
||||
### GitOps
|
||||
|
||||
- [GitOps Principles](https://opengitops.dev/) - Official GitOps principles
|
||||
- [ArgoCD Documentation](https://argo-cd.readthedocs.io/) - ArgoCD documentation
|
||||
|
||||
### Tools
|
||||
|
||||
- [CNOE.io](https://cnoe.io/) - Cloud Native Operational Excellence Framework
|
||||
- [Forgejo](https://forgejo.org/) - Self-hosted Git service with CI/CD
|
||||
- [Terraform](https://www.terraform.io/) - Infrastructure as Code tool
|
||||
|
|
@ -1,832 +0,0 @@
|
|||
---
|
||||
title: "Application Orchestration"
|
||||
linkTitle: "Application Orchestration"
|
||||
weight: 30
|
||||
description: >
|
||||
Application deployment via CI/CD pipelines and GitOps - Orchestrating application deployments
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Application Orchestration deals with the automation of application deployment and lifecycle management. It encompasses the entire workflow from source code to running application in production.
|
||||
|
||||
In the context of IPCEI-CIS, Application Orchestration includes:
|
||||
|
||||
- **CI/CD Pipelines**: Automated build, test, and deployment pipelines
|
||||
- **GitOps Deployment**: Declarative application deployment via ArgoCD
|
||||
- **Progressive Delivery**: Canary deployments, blue-green deployments
|
||||
- **Application Configuration**: Environment-specific configuration management
|
||||
- **Golden Paths**: Standardized deployment templates and workflows
|
||||
|
||||
### Target Audience
|
||||
|
||||
Application Orchestration is primarily for:
|
||||
|
||||
- **Application Developers**: Teams developing and deploying applications
|
||||
- **DevOps Teams**: Teams responsible for deployment automation
|
||||
- **Product Teams**: Teams responsible for application lifecycle
|
||||
|
||||
## Key Features
|
||||
|
||||
### Automated CI/CD Pipelines
|
||||
|
||||
Forgejo Actions provides GitHub Actions-compatible CI/CD:
|
||||
|
||||
- **Build Automation**: Automatic building of container images
|
||||
- **Test Automation**: Automated unit, integration, and E2E tests
|
||||
- **Security Scanning**: Vulnerability scanning of dependencies and images
|
||||
- **Artifact Publishing**: Publishing to container registries
|
||||
- **Deployment Triggering**: Automatic deployment after successful build
|
||||
|
||||
### GitOps-based Deployment
|
||||
|
||||
ArgoCD enables declarative application deployment:
|
||||
|
||||
- **Declarative Configuration**: Applications defined as Kubernetes manifests
|
||||
- **Automated Sync**: Automatic synchronization between Git and cluster
|
||||
- **Rollback Capability**: Easy rollback to previous versions
|
||||
- **Multi-Environment**: Consistent deployment across Dev/Test/Prod
|
||||
- **Health Monitoring**: Continuous monitoring of application health
|
||||
|
||||
### Progressive Delivery
|
||||
|
||||
Support for advanced deployment strategies:
|
||||
|
||||
- **Canary Deployments**: Gradual rollout to subset of users
|
||||
- **Blue-Green Deployments**: Zero-downtime deployments with instant rollback
|
||||
- **A/B Testing**: Traffic splitting for feature testing
|
||||
- **Feature Flags**: Dynamic feature enablement without deployment
|
||||
|
||||
### Configuration Management
|
||||
|
||||
Flexible configuration for different environments:
|
||||
|
||||
- **Environment Variables**: Configuration via environment variables
|
||||
- **ConfigMaps**: Kubernetes-native configuration
|
||||
- **Secrets Management**: Secure handling of sensitive data
|
||||
- **External Secrets**: Integration with external secret stores (Vault, etc.)
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
Application Orchestration is the core of developer experience in IPCEI-CIS Edge Developer Platform.
|
||||
|
||||
### Developer Self-Service
|
||||
|
||||
Developers can deploy applications independently:
|
||||
|
||||
- **Self-Service Deployment**: No dependency on operations team
|
||||
- **Standardized Workflows**: Clear, documented deployment processes
|
||||
- **Fast Feedback**: Quick feedback through automated pipelines
|
||||
- **Environment Parity**: Consistent behavior across all environments
|
||||
|
||||
### Quality and Security
|
||||
|
||||
Automated checks ensure quality and security:
|
||||
|
||||
- **Automated Testing**: All changes are automatically tested
|
||||
- **Security Scans**: Vulnerability scanning of dependencies and images
|
||||
- **Policy Enforcement**: Automated policy checks (OPA, Kyverno)
|
||||
- **Compliance**: Auditability of all deployments
|
||||
|
||||
### Efficiency and Productivity
|
||||
|
||||
Automation increases team efficiency:
|
||||
|
||||
- **Faster Time-to-Market**: Faster deployment of new features
|
||||
- **Reduced Manual Work**: Automation of repetitive tasks
|
||||
- **Fewer Errors**: Fewer manual mistakes through automation
|
||||
- **Better Collaboration**: Clear interfaces between Dev and Ops
|
||||
|
||||
## Repository
|
||||
|
||||
**Forgejo**: [forgejo.org](https://forgejo.org/)
|
||||
|
||||
**Forgejo Actions**: [Forgejo Actions Documentation](https://forgejo.org/docs/latest/user/actions/)
|
||||
|
||||
**ArgoCD**: [argoproj.github.io/cd](https://argoproj.github.io/cd/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Forgejo Account**: Access to Forgejo instance
|
||||
- **Kubernetes Cluster**: Target cluster for deployments
|
||||
- **ArgoCD Access**: Access to ArgoCD instance
|
||||
- **Git**: For repository management
|
||||
|
||||
### Quick Start: Application Deployment
|
||||
|
||||
1. **Create Application Repository**
|
||||
|
||||
```bash
|
||||
# Create new repository in Forgejo
|
||||
git init my-application
|
||||
cd my-application
|
||||
|
||||
# Add application code and Dockerfile
|
||||
cat > Dockerfile <<EOF
|
||||
FROM node:18-alpine
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm ci --only=production
|
||||
COPY . .
|
||||
EXPOSE 3000
|
||||
CMD ["node", "server.js"]
|
||||
EOF
|
||||
```
|
||||
|
||||
2. **Add CI/CD Pipeline**
|
||||
|
||||
Create `.forgejo/workflows/build.yaml`:
|
||||
|
||||
```yaml
|
||||
name: Build and Push
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
||||
- name: Login to Registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: registry.example.com
|
||||
username: ${{ secrets.REGISTRY_USER }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
push: ${{ github.event_name == 'push' }}
|
||||
tags: registry.example.com/my-app:${{ github.sha }}
|
||||
```
|
||||
|
||||
3. **Create Kubernetes Manifests**
|
||||
|
||||
Create `k8s/deployment.yaml`:
|
||||
|
||||
```yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: my-application
|
||||
spec:
|
||||
replicas: 3
|
||||
selector:
|
||||
matchLabels:
|
||||
app: my-application
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: my-application
|
||||
spec:
|
||||
containers:
|
||||
- name: app
|
||||
image: registry.example.com/my-app:latest
|
||||
ports:
|
||||
- containerPort: 3000
|
||||
env:
|
||||
- name: NODE_ENV
|
||||
value: "production"
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: my-application
|
||||
spec:
|
||||
selector:
|
||||
app: my-application
|
||||
ports:
|
||||
- port: 80
|
||||
targetPort: 3000
|
||||
```
|
||||
|
||||
4. **Configure ArgoCD Application**
|
||||
|
||||
```yaml
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: my-application
|
||||
namespace: argocd
|
||||
spec:
|
||||
project: default
|
||||
source:
|
||||
repoURL: https://forgejo.example.com/myteam/my-application
|
||||
targetRevision: main
|
||||
path: k8s
|
||||
destination:
|
||||
server: https://kubernetes.default.svc
|
||||
namespace: production
|
||||
syncPolicy:
|
||||
automated:
|
||||
prune: true
|
||||
selfHeal: true
|
||||
```
|
||||
|
||||
5. **Deploy**
|
||||
|
||||
```bash
|
||||
# Commit and push
|
||||
git add .
|
||||
git commit -m "Add application and deployment configuration"
|
||||
git push origin main
|
||||
|
||||
# ArgoCD will automatically deploy the application
|
||||
argocd app sync my-application --watch
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Use Case 1: Multi-Environment Deployment
|
||||
|
||||
Deploy application to multiple environments:
|
||||
|
||||
**Repository Structure:**
|
||||
|
||||
```text
|
||||
my-application/
|
||||
├── .forgejo/
|
||||
│ └── workflows/
|
||||
│ └── build.yaml
|
||||
├── base/
|
||||
│ ├── deployment.yaml
|
||||
│ ├── service.yaml
|
||||
│ └── kustomization.yaml
|
||||
├── overlays/
|
||||
│ ├── dev/
|
||||
│ │ ├── kustomization.yaml
|
||||
│ │ └── patches.yaml
|
||||
│ ├── staging/
|
||||
│ │ ├── kustomization.yaml
|
||||
│ │ └── patches.yaml
|
||||
│ └── production/
|
||||
│ ├── kustomization.yaml
|
||||
│ └── patches.yaml
|
||||
```
|
||||
|
||||
**Kustomize Base** (`base/kustomization.yaml`):
|
||||
|
||||
```yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
resources:
|
||||
- deployment.yaml
|
||||
- service.yaml
|
||||
|
||||
commonLabels:
|
||||
app: my-application
|
||||
```
|
||||
|
||||
**Environment Overlay** (`overlays/production/kustomization.yaml`):
|
||||
|
||||
```yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
bases:
|
||||
- ../../base
|
||||
|
||||
namespace: production
|
||||
|
||||
replicas:
|
||||
- name: my-application
|
||||
count: 5
|
||||
|
||||
images:
|
||||
- name: my-app
|
||||
newTag: v1.2.3
|
||||
|
||||
patches:
|
||||
- patches.yaml
|
||||
```
|
||||
|
||||
**ArgoCD Applications for each environment:**
|
||||
|
||||
```yaml
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: my-application-prod
|
||||
namespace: argocd
|
||||
spec:
|
||||
project: default
|
||||
source:
|
||||
repoURL: https://forgejo.example.com/myteam/my-application
|
||||
targetRevision: main
|
||||
path: overlays/production
|
||||
destination:
|
||||
server: https://kubernetes.default.svc
|
||||
namespace: production
|
||||
syncPolicy:
|
||||
automated:
|
||||
prune: true
|
||||
selfHeal: true
|
||||
```
|
||||
|
||||
### Use Case 2: Canary Deployment
|
||||
|
||||
Progressive rollout with canary strategy:
|
||||
|
||||
**Argo Rollouts Canary:**
|
||||
|
||||
```yaml
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Rollout
|
||||
metadata:
|
||||
name: my-application
|
||||
spec:
|
||||
replicas: 10
|
||||
strategy:
|
||||
canary:
|
||||
steps:
|
||||
- setWeight: 10
|
||||
- pause: {duration: 5m}
|
||||
- setWeight: 30
|
||||
- pause: {duration: 5m}
|
||||
- setWeight: 60
|
||||
- pause: {duration: 5m}
|
||||
- setWeight: 100
|
||||
selector:
|
||||
matchLabels:
|
||||
app: my-application
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: my-application
|
||||
spec:
|
||||
containers:
|
||||
- name: app
|
||||
image: registry.example.com/my-app:v2.0.0
|
||||
```
|
||||
|
||||
### Use Case 3: Feature Flags
|
||||
|
||||
Dynamic feature control without deployment:
|
||||
|
||||
**Application Code with Feature Flag:**
|
||||
|
||||
```javascript
|
||||
const Unleash = require('unleash-client');
|
||||
|
||||
const unleash = new Unleash({
|
||||
url: 'http://unleash.platform/api/',
|
||||
appName: 'my-application',
|
||||
customHeaders: {
|
||||
Authorization: process.env.UNLEASH_API_TOKEN
|
||||
}
|
||||
});
|
||||
|
||||
// Use feature flag
|
||||
if (unleash.isEnabled('new-checkout-flow')) {
|
||||
// New checkout implementation
|
||||
renderNewCheckout();
|
||||
} else {
|
||||
// Old checkout implementation
|
||||
renderOldCheckout();
|
||||
}
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
### Forgejo Integration
|
||||
|
||||
Forgejo serves as central source code management and CI/CD platform:
|
||||
|
||||
- **Source Control**: Git repositories for application code
|
||||
- **CI/CD Pipelines**: Forgejo Actions for automated builds and tests
|
||||
- **Container Registry**: Built-in container registry for images
|
||||
- **Webhook Integration**: Triggers for external systems
|
||||
- **Pull Request Workflows**: Code review and approval processes
|
||||
|
||||
### ArgoCD Integration
|
||||
|
||||
ArgoCD handles declarative application deployment:
|
||||
|
||||
- **GitOps Sync**: Continuous synchronization with Git state
|
||||
- **Health Monitoring**: Application health status monitoring
|
||||
- **Rollback Support**: Easy rollback to previous versions
|
||||
- **Multi-Cluster**: Deployment to multiple clusters
|
||||
- **UI and CLI**: Web interface and command-line access
|
||||
|
||||
### Observability Integration
|
||||
|
||||
Integration with monitoring and logging:
|
||||
|
||||
- **Metrics**: Prometheus metrics from applications
|
||||
- **Logs**: Centralized log collection via Loki/ELK
|
||||
- **Tracing**: Distributed tracing with Jaeger/Tempo
|
||||
- **Alerting**: Alert rules for application issues
|
||||
|
||||
## Architecture
|
||||
|
||||
### Application Deployment Flow
|
||||
|
||||
```text
|
||||
┌──────────────┐
|
||||
│ Developer │
|
||||
└──────┬───────┘
|
||||
│ git push
|
||||
▼
|
||||
┌─────────────────────────────────────────┐
|
||||
│ Forgejo │
|
||||
│ │
|
||||
│ ┌────────────────────────────────┐ │
|
||||
│ │ Git Repository │ │
|
||||
│ │ - Application Code │ │
|
||||
│ │ - Kubernetes Manifests │ │
|
||||
│ │ - Pipeline Configuration │ │
|
||||
│ └─────────┬──────────────────────┘ │
|
||||
│ │ │
|
||||
│ │ triggers │
|
||||
│ ▼ │
|
||||
│ ┌────────────────────────────────┐ │
|
||||
│ │ Forgejo Actions (CI/CD) │ │
|
||||
│ │ - Build Container Image │ │
|
||||
│ │ - Run Tests │ │
|
||||
│ │ - Security Scans │ │
|
||||
│ │ - Push to Registry │ │
|
||||
│ └─────────┬──────────────────────┘ │
|
||||
└────────────┼────────────────────────────┘
|
||||
│
|
||||
│ image pushed
|
||||
▼
|
||||
┌─────────────────────────────────────────┐
|
||||
│ Container Registry │
|
||||
└─────────────────────────────────────────┘
|
||||
│
|
||||
│ watches manifests
|
||||
▼
|
||||
┌─────────────────────────────────────────┐
|
||||
│ ArgoCD │
|
||||
│ │
|
||||
│ - Monitors Git Repository │
|
||||
│ - Detects Changes │
|
||||
│ - Syncs to Kubernetes │
|
||||
│ - Reports Health Status │
|
||||
└─────────────┬───────────────────────────┘
|
||||
│
|
||||
│ deploys
|
||||
▼
|
||||
┌─────────────────────────────────────────┐
|
||||
│ Kubernetes Cluster │
|
||||
│ │
|
||||
│ ┌────────────────────────────────┐ │
|
||||
│ │ Running Application │ │
|
||||
│ │ - Pods │ │
|
||||
│ │ - Services │ │
|
||||
│ │ - Ingress │ │
|
||||
│ └────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### CI/CD Pipeline Architecture
|
||||
|
||||
Typical Forgejo Actions pipeline stages:
|
||||
|
||||
1. **Checkout**: Clone source code
|
||||
2. **Build**: Compile application and dependencies
|
||||
3. **Test**: Run unit and integration tests
|
||||
4. **Security Scan**: Scan dependencies and code for vulnerabilities
|
||||
5. **Build Image**: Create container image
|
||||
6. **Push Image**: Push to container registry
|
||||
7. **Update Manifests**: Update Kubernetes manifests with new image tag
|
||||
8. **Notify**: Send notifications on success/failure
|
||||
|
||||
## Configuration
|
||||
|
||||
### Forgejo Actions Configuration
|
||||
|
||||
Example for Node.js application:
|
||||
|
||||
```yaml
|
||||
name: CI/CD Pipeline
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, develop ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
env:
|
||||
REGISTRY: registry.example.com
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: '18'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
|
||||
- name: Run linter
|
||||
run: npm run lint
|
||||
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Run Trivy vulnerability scanner
|
||||
uses: aquasecurity/trivy-action@master
|
||||
with:
|
||||
scan-type: 'fs'
|
||||
scan-ref: '.'
|
||||
format: 'sarif'
|
||||
output: 'trivy-results.sarif'
|
||||
|
||||
build-and-push:
|
||||
needs: [test, security]
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name == 'push'
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
||||
- name: Login to Registry
|
||||
uses: docker/login-action@v2
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ secrets.REGISTRY_USER }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Extract metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v4
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
tags: |
|
||||
type=ref,event=branch
|
||||
type=sha,prefix={{branch}}-
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v4
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
```
|
||||
|
||||
### ArgoCD Application Configuration
|
||||
|
||||
Complete configuration example:
|
||||
|
||||
```yaml
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: my-application
|
||||
namespace: argocd
|
||||
finalizers:
|
||||
- resources-finalizer.argocd.argoproj.io
|
||||
spec:
|
||||
project: default
|
||||
|
||||
source:
|
||||
repoURL: https://forgejo.example.com/myteam/my-application
|
||||
targetRevision: main
|
||||
path: k8s/overlays/production
|
||||
|
||||
# Kustomize options
|
||||
kustomize:
|
||||
version: v5.0.0
|
||||
images:
|
||||
- my-app=registry.example.com/my-app:v1.2.3
|
||||
|
||||
destination:
|
||||
server: https://kubernetes.default.svc
|
||||
namespace: production
|
||||
|
||||
# Sync policy
|
||||
syncPolicy:
|
||||
automated:
|
||||
prune: true # Delete resources not in Git
|
||||
selfHeal: true # Override manual changes
|
||||
allowEmpty: false # Don't delete everything on empty repo
|
||||
|
||||
syncOptions:
|
||||
- CreateNamespace=true
|
||||
- PruneLast=true
|
||||
- RespectIgnoreDifferences=true
|
||||
|
||||
retry:
|
||||
limit: 5
|
||||
backoff:
|
||||
duration: 5s
|
||||
factor: 2
|
||||
maxDuration: 3m
|
||||
|
||||
# Ignore differences (avoid sync loops)
|
||||
ignoreDifferences:
|
||||
- group: apps
|
||||
kind: Deployment
|
||||
jsonPointers:
|
||||
- /spec/replicas # Ignore if HPA manages replicas
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Pipeline Fails
|
||||
|
||||
**Problem**: Forgejo Actions pipeline fails
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Check pipeline logs in Forgejo UI
|
||||
# Navigate to: Repository → Actions → Select failed run
|
||||
|
||||
# 2. Check runner status
|
||||
# In Forgejo: Site Admin → Actions → Runners
|
||||
|
||||
# 3. Check runner logs
|
||||
kubectl logs -n forgejo-runner deployment/act-runner
|
||||
|
||||
# 4. Test pipeline locally with act
|
||||
act -l # List available jobs
|
||||
act -j build # Run specific job
|
||||
```
|
||||
|
||||
### ArgoCD Application OutOfSync
|
||||
|
||||
**Problem**: Application shows "OutOfSync" status
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Check differences
|
||||
argocd app diff my-application
|
||||
|
||||
# 2. View sync status details
|
||||
argocd app get my-application
|
||||
|
||||
# 3. Manual sync
|
||||
argocd app sync my-application
|
||||
|
||||
# 4. Hard refresh (ignore cache)
|
||||
argocd app sync my-application --force
|
||||
|
||||
# 5. Check for ignored differences
|
||||
argocd app get my-application --show-operation
|
||||
```
|
||||
|
||||
### Application Deployment Fails
|
||||
|
||||
**Problem**: Application pod crashes after deployment
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Check pod status
|
||||
kubectl get pods -n production
|
||||
|
||||
# 2. View pod logs
|
||||
kubectl logs -n production deployment/my-application
|
||||
|
||||
# 3. Describe pod for events
|
||||
kubectl describe pod -n production <pod-name>
|
||||
|
||||
# 4. Check resource limits
|
||||
kubectl top pod -n production
|
||||
|
||||
# 5. Rollback via ArgoCD
|
||||
argocd app rollback my-application
|
||||
```
|
||||
|
||||
### Image Pull Errors
|
||||
|
||||
**Problem**: Kubernetes cannot pull container image
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Verify image exists
|
||||
docker pull registry.example.com/my-app:v1.2.3
|
||||
|
||||
# 2. Check image pull secret
|
||||
kubectl get secret -n production regcred
|
||||
|
||||
# 3. Create image pull secret if missing
|
||||
kubectl create secret docker-registry regcred \
|
||||
--docker-server=registry.example.com \
|
||||
--docker-username=user \
|
||||
--docker-password=password \
|
||||
-n production
|
||||
|
||||
# 4. Reference secret in deployment
|
||||
kubectl patch deployment my-application -n production \
|
||||
-p '{"spec":{"template":{"spec":{"imagePullSecrets":[{"name":"regcred"}]}}}}'
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Golden Path Templates
|
||||
|
||||
Provide standardized templates for common use cases:
|
||||
|
||||
1. **Web Application Template**: Node.js, Python, Go web services
|
||||
2. **API Service Template**: RESTful API with OpenAPI
|
||||
3. **Batch Job Template**: Kubernetes CronJob configurations
|
||||
4. **Microservice Template**: Service mesh integration
|
||||
|
||||
Example repository template structure:
|
||||
|
||||
```text
|
||||
application-template/
|
||||
├── .forgejo/
|
||||
│ └── workflows/
|
||||
│ ├── build.yaml
|
||||
│ ├── test.yaml
|
||||
│ └── deploy.yaml
|
||||
├── k8s/
|
||||
│ ├── base/
|
||||
│ └── overlays/
|
||||
├── src/
|
||||
│ └── ...
|
||||
├── Dockerfile
|
||||
├── README.md
|
||||
└── .gitignore
|
||||
```
|
||||
|
||||
### Deployment Checklist
|
||||
|
||||
Before deploying to production:
|
||||
|
||||
- ✅ All tests passing
|
||||
- ✅ Security scans completed
|
||||
- ✅ Resource limits defined
|
||||
- ✅ Health checks configured
|
||||
- ✅ Monitoring and alerts set up
|
||||
- ✅ Backup strategy defined
|
||||
- ✅ Rollback plan documented
|
||||
- ✅ Team notified about deployment
|
||||
|
||||
### Configuration Management
|
||||
|
||||
- Use ConfigMaps for non-sensitive configuration
|
||||
- Use Secrets for sensitive data
|
||||
- Use External Secrets Operator for vault integration
|
||||
- Never commit secrets to Git
|
||||
- Use environment-specific overlays (Kustomize)
|
||||
- Document all configuration options
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: Production
|
||||
|
||||
**Stability**: Stable
|
||||
|
||||
**Support**: Internal Platform Team
|
||||
|
||||
## Additional Resources
|
||||
|
||||
### Forgejo
|
||||
|
||||
- [Forgejo Documentation](https://forgejo.org/docs/latest/)
|
||||
- [Forgejo Actions Guide](https://forgejo.org/docs/latest/user/actions/)
|
||||
- [Forgejo API Reference](https://forgejo.org/docs/latest/api/)
|
||||
|
||||
### ArgoCD
|
||||
|
||||
- [ArgoCD Documentation](https://argo-cd.readthedocs.io/)
|
||||
- [ArgoCD Best Practices](https://argo-cd.readthedocs.io/en/stable/user-guide/best_practices/)
|
||||
- [ArgoCD Sync Waves](https://argo-cd.readthedocs.io/en/stable/user-guide/sync-waves/)
|
||||
|
||||
### GitOps
|
||||
|
||||
- [GitOps Principles](https://opengitops.dev/)
|
||||
- [GitOps Patterns](https://www.gitops.tech/)
|
||||
- [Kubernetes Deployment Strategies](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy)
|
||||
|
||||
### CI/CD
|
||||
|
||||
- [GitHub Actions Documentation](https://docs.github.com/en/actions) (Forgejo Actions compatible)
|
||||
- [Docker Best Practices](https://docs.docker.com/develop/dev-best-practices/)
|
||||
- [Container Security Best Practices](https://kubernetes.io/docs/concepts/security/pod-security-standards/)
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Infrastructure Orchestration"
|
||||
linkTitle: "Infrastructure Orchestration"
|
||||
weight: 10
|
||||
description: >
|
||||
Infrastructure deployment and catalog management (infra-deploy, infra-catalogue)
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)
|
||||
* **Assignee**: Martin
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,129 +0,0 @@
|
|||
---
|
||||
title: Terraform provider for Edge cloud
|
||||
linkTitle: Edge provider
|
||||
weight: 20
|
||||
description: Custom Terraform provider for orchestrating infrastructure deployments
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: Mostly ready
|
||||
|
||||
* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)
|
||||
* **Assignee**: Martin
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
This work-in-progress Terraform provider for Edge cloud allows orchestration of selected resources using flexible, concise [HCL](https://developer.hashicorp.com/terraform/language). This allows deployment to Edge Cloud through a familiar format, abstracting away specific endpoints and authentication elements, and allowing seamless combination of Edge resources with others: on OTC, other clouds, or local utilities.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Interact with Apps and AppInstances using widely-used Terraform framework
|
||||
* Using Terraform's systems, provide minimal configuration: just an endpoint and credentials, then no need to deal with header structure or other tokens
|
||||
* Provider currently under development: more features can be added at will.
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,114 +0,0 @@
|
|||
---
|
||||
title: Terraform-based deployment of EDP
|
||||
linkTitle: Terraform
|
||||
weight: 10
|
||||
description: >
|
||||
As-code definitions of EDP clusters, so they can be deployed reliably and consistently on OTC whenever needed.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: Mostly ready
|
||||
|
||||
* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)
|
||||
* **Assignee**: Martin
|
||||
* **Status**: Draft
|
||||
* **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 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.
|
||||
|
||||
Note that both repositories rely on the wide range of features available on [OTC](https://console.otc.t-systems.com). Several of these features, such as S3-compatible storage and on-demand managed Postgres instances, are not yet available on more sovereign clouds such as [Edge](https://hub.apps.edge.platform.mg3.mdb.osc.live/), so these are not currently supported.
|
||||
|
||||
## Key Features
|
||||
|
||||
* 'Catalogue' of infrastructure stacks to be used in deployments
|
||||
* Definition of deployment stacks for each environment in prod or dev
|
||||
* Scripts to govern deployment, installation and drift-correction of EDP
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
For our Edge Developer Platform to be reliable it must be deployable in a consistent manner. When errors occur, or after any manual alterations, the system can then be safely reset to a working state. This state should be provided in code to allow for automated validation and deployment, and to allow it to be deployed from an always-identical CI/CD pipeline rather than a variable local deployment environment.
|
||||
|
||||
## Repositories
|
||||
|
||||
**Infra-deploy**: [https://edp.buildth.ing/DevFW/infra-deploy](https://edp.buildth.ing/DevFW/infra-deploy)
|
||||
|
||||
**Infra-catalogue**: [https://edp.buildth.ing/DevFW/infra-catalogue](https://edp.buildth.ing/DevFW/infra-catalogue)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Docker](https://docs.docker.com/)
|
||||
* [Kubernetes management](https://kubernetes.io/docs/reference/kubectl/)
|
||||
* Access to [OTC](https://console.otc.t-systems.com/console/)
|
||||
* HashiCorp [Terraform](https://developer.hashicorp.com/terraform) or its open-source equivalent, [OpenTofu](https://opentofu.org/)
|
||||
* [Terragrunt](https://terragrunt.gruntwork.io/), an orchestrator for Terraform stacks
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. Set up OTC credentials per [README section](https://edp.buildth.ing/DevFW/infra-deploy#installation-on-otc)
|
||||
2. Set cluster environment and run install script per [README section](https://edp.buildth.ing/DevFW/infra-deploy#using-the-edpbuilder)
|
||||
|
||||
Alternatively, manually trigger automated [deployment pipeline](https://edp.buildth.ing/DevFW/infra-deploy/actions?workflow=deploy.yaml).
|
||||
- You will be asked for essential information like the deployment name and tenant.
|
||||
- Any fields marked `INITIAL` only need to be set when first creating an environment
|
||||
- Thereafter, the cached values are used and the `INITIAL` values provided to the pipeline are ignored.
|
||||
|
||||
### 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).
|
||||
|
||||
#### 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]
|
||||
|
||||
> Stephan: are there problems left with versioning?
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: TRL-9
|
||||
|
||||
## Additional Resources
|
||||
|
||||
> Stephan: perhaps terraform/terragrunt links?
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## 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
|
||||
|
|
@ -1,509 +0,0 @@
|
|||
---
|
||||
title: "Platform Orchestration"
|
||||
linkTitle: "Platform Orchestration"
|
||||
weight: 20
|
||||
description: >
|
||||
Platform-level component provisioning via Stacks - Orchestrating the platform infrastructure itself
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Platform Orchestration refers to the automation and management of the platform infrastructure itself. This includes the provisioning, configuration, and lifecycle management of all components that make up the Internal Developer Platform (IDP).
|
||||
|
||||
In the context of IPCEI-CIS, Platform Orchestration means:
|
||||
|
||||
- **Platform Bootstrap**: Initial setup of Kubernetes clusters and core services
|
||||
- **Platform Services Management**: Deployment and management of ArgoCD, Forgejo, Keycloak, etc.
|
||||
- **Infrastructure-as-Code**: Declarative management using Terraform and GitOps
|
||||
- **Multi-Cluster Orchestration**: Coordination across different Kubernetes clusters
|
||||
- **Platform Stacks**: Reusable bundles of platform components (CNOE concept)
|
||||
|
||||
### Target Audience
|
||||
|
||||
Platform Orchestration is primarily aimed at:
|
||||
|
||||
- **Platform Engineering Teams**: Teams that build and operate the IDP
|
||||
- **Infrastructure Architects**: Those responsible for the platform architecture
|
||||
- **SRE Teams**: Teams responsible for reliability and operations
|
||||
|
||||
## Key Features
|
||||
|
||||
### Declarative Platform Definition
|
||||
|
||||
The entire platform is defined declaratively as code:
|
||||
|
||||
- **GitOps-First**: Everything is versioned in Git and traceable
|
||||
- **Reproducibility**: The platform can be rebuilt at any time
|
||||
- **Environment Parity**: Consistency between Dev, Test, and Production
|
||||
- **Auditability**: Complete history of all changes
|
||||
|
||||
### Self-Bootstrapping
|
||||
|
||||
The platform can bootstrap itself:
|
||||
|
||||
1. **Initial Bootstrap**: Minimal tool (like `idpbuilder`) starts the platform
|
||||
2. **Self-Management**: After bootstrap, ArgoCD takes over management
|
||||
3. **Continuous Reconciliation**: Platform is continuously reconciled with Git state
|
||||
4. **Self-Healing**: Automatic recovery on deviations
|
||||
|
||||
### Stack-based Composition
|
||||
|
||||
Platform components are organized as reusable stacks (CNOE concept):
|
||||
|
||||
- **Modularity**: Components can be updated individually
|
||||
- **Reusability**: Stacks can be used across different environments
|
||||
- **Composability**: Compose complex platforms from simple building blocks
|
||||
- **Versioning**: Stacks can be versioned and tested
|
||||
|
||||
**In IPCEI-CIS**: The stacks concept from CNOE is the core organizational principle for platform components.
|
||||
|
||||
### Multi-Cluster Support
|
||||
|
||||
Platform Orchestration supports different cluster topologies:
|
||||
|
||||
- **Control Plane + Worker Clusters**: Centralized control, distributed workloads
|
||||
- **Hub-and-Spoke**: One management cluster manages multiple target clusters
|
||||
- **Federation**: Coordination across multiple independent clusters
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
Platform Orchestration is the foundation of the IPCEI-CIS Edge Developer Platform. It enables:
|
||||
|
||||
### Foundation for Developer Self-Service
|
||||
|
||||
Platform Orchestration ensures all services are available that developers need for self-service:
|
||||
|
||||
- **GitOps Engine** (ArgoCD) for continuous deployment
|
||||
- **Source Control** (Forgejo) for code and configuration management
|
||||
- **Identity Management** (Keycloak) for authentication and authorization
|
||||
- **Observability** (Grafana, Prometheus) for monitoring and logging
|
||||
- **CI/CD** (Forgejo Actions/Pipelines) for automated build and test
|
||||
|
||||
### Consistency Across Environments
|
||||
|
||||
Through declarative definition, consistency is guaranteed:
|
||||
|
||||
- Development, test, and production environments are identically configured
|
||||
- No "configuration drift" between environments
|
||||
- Predictable behavior across all stages
|
||||
|
||||
### Platform as Code
|
||||
|
||||
The platform itself is treated like software:
|
||||
|
||||
- **Version Control**: All changes are versioned in Git
|
||||
- **Code Review**: Platform changes go through review processes
|
||||
- **Testing**: Platform configurations can be tested
|
||||
- **Rollback**: Easy rollback on problems
|
||||
|
||||
### Reduced Operational Overhead
|
||||
|
||||
Automation reduces manual effort:
|
||||
|
||||
- No manual installation steps
|
||||
- Automatic updates and patching
|
||||
- Self-healing on failures
|
||||
- Standardized deployment processes
|
||||
|
||||
## Repository
|
||||
|
||||
**CNOE Reference Implementation**: [cnoe-io/stacks](https://github.com/cnoe-io/stacks)
|
||||
|
||||
**CNOE idpbuilder**: [cnoe-io/idpbuilder](https://github.com/cnoe-io/idpbuilder)
|
||||
|
||||
**Documentation**: [CNOE.io Documentation](https://cnoe.io/docs/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Docker**: For local Kubernetes clusters (Kind)
|
||||
- **kubectl**: Kubernetes CLI tool
|
||||
- **Git**: For repository management
|
||||
- **idpbuilder**: CNOE bootstrap tool
|
||||
|
||||
### Quick Start
|
||||
|
||||
Platform Orchestration with CNOE Reference Implementation:
|
||||
|
||||
```bash
|
||||
# 1. Install idpbuilder
|
||||
curl -fsSL https://cnoe.io/install.sh | bash
|
||||
|
||||
# 2. Bootstrap platform
|
||||
idpbuilder create \
|
||||
--use-path-routing \
|
||||
--package-dir https://github.com/cnoe-io/stacks//ref-implementation
|
||||
|
||||
# 3. Wait for platform ready (ca. 10 minutes)
|
||||
kubectl get applications -A
|
||||
```
|
||||
|
||||
### Verification
|
||||
|
||||
Verify the platform is running correctly:
|
||||
|
||||
```bash
|
||||
# Get platform secrets (credentials)
|
||||
idpbuilder get secrets
|
||||
|
||||
# Check all ArgoCD applications
|
||||
kubectl get applications -n argocd
|
||||
|
||||
# Expected: All applications "Synced" and "Healthy"
|
||||
```
|
||||
|
||||
Access URLs (with path-routing):
|
||||
|
||||
- **ArgoCD**: `https://cnoe.localtest.me:8443/argocd`
|
||||
- **Forgejo**: `https://cnoe.localtest.me:8443/gitea`
|
||||
- **Keycloak**: `https://cnoe.localtest.me:8443/keycloak`
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Use Case 1: Platform Bootstrap
|
||||
|
||||
Initial bootstrapping of a new platform instance:
|
||||
|
||||
```bash
|
||||
idpbuilder create \
|
||||
--use-path-routing \
|
||||
--package-dir https://github.com/cnoe-io/stacks//ref-implementation \
|
||||
--log-level debug
|
||||
|
||||
# Workflow:
|
||||
# 1. Creates Kind cluster
|
||||
# 2. Installs ingress-nginx
|
||||
# 3. Clones and installs ArgoCD
|
||||
# 4. Installs Forgejo
|
||||
# 5. Waits for core services
|
||||
# 6. Creates technical users
|
||||
# 7. Configures Git repositories
|
||||
# 8. Installs remaining stacks via ArgoCD
|
||||
```
|
||||
|
||||
After approximately 10 minutes, the platform is fully deployed.
|
||||
|
||||
### Use Case 2: Adding New Platform Components
|
||||
|
||||
Add new platform components via ArgoCD:
|
||||
|
||||
```bash
|
||||
# Create ArgoCD Application for new component
|
||||
cat <<EOF | kubectl apply -f -
|
||||
apiVersion: argoproj.io/v1alpha1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: external-secrets
|
||||
namespace: argocd
|
||||
spec:
|
||||
project: default
|
||||
source:
|
||||
repoURL: https://charts.external-secrets.io
|
||||
targetRevision: 0.9.9
|
||||
chart: external-secrets
|
||||
destination:
|
||||
server: https://kubernetes.default.svc
|
||||
namespace: external-secrets-system
|
||||
syncPolicy:
|
||||
automated:
|
||||
prune: true
|
||||
selfHeal: true
|
||||
syncOptions:
|
||||
- CreateNamespace=true
|
||||
EOF
|
||||
```
|
||||
|
||||
### Use Case 3: Platform Updates
|
||||
|
||||
Update platform components:
|
||||
|
||||
```bash
|
||||
# 1. Update via Git (GitOps)
|
||||
cd your-platform-config-repo
|
||||
git pull
|
||||
|
||||
# 2. Update stack version
|
||||
vim argocd/applications/component.yaml
|
||||
# Change targetRevision to new version
|
||||
|
||||
# 3. Commit and push
|
||||
git add .
|
||||
git commit -m "Update component to v1.2.3"
|
||||
git push
|
||||
|
||||
# 4. ArgoCD will automatically sync
|
||||
# 5. Monitor the update
|
||||
argocd app sync component --watch
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
### ArgoCD Integration
|
||||
|
||||
- **Bootstrap**: ArgoCD is initially installed via idpbuilder
|
||||
- **Self-Management**: After bootstrap, ArgoCD manages itself via Application CRD
|
||||
- **Platform Coordination**: ArgoCD orchestrates all other platform components
|
||||
- **Health Monitoring**: ArgoCD monitors health status of all platform services
|
||||
|
||||
### Forgejo Integration
|
||||
|
||||
- **Source of Truth**: Git repositories contain all platform definitions
|
||||
- **GitOps Workflow**: Changes in Git trigger platform updates
|
||||
- **Backup**: Git serves as backup of platform configuration
|
||||
- **Audit Trail**: Git history documents all platform changes
|
||||
- **CI/CD**: Forgejo Actions can automate platform operations
|
||||
|
||||
### Terraform Integration
|
||||
|
||||
- **Infrastructure Provisioning**: Terraform provisions cloud resources for platform
|
||||
- **State Management**: Terraform state tracks infrastructure
|
||||
- **Integration**: Terraform can be triggered via Forgejo pipelines
|
||||
- **Multi-Cloud**: Support for multiple cloud providers
|
||||
|
||||
## Architecture
|
||||
|
||||
### Platform Orchestration Flow
|
||||
|
||||
```text
|
||||
┌─────────────────┐
|
||||
│ idpbuilder │ Bootstrap Tool
|
||||
│ (Initial Run) │
|
||||
└────────┬────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ Kubernetes Cluster │
|
||||
│ │
|
||||
│ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ ArgoCD │────────▶│ Forgejo │ │
|
||||
│ │ (GitOps) │ │ (Git Repo) │ │
|
||||
│ └──────┬───────┘ └──────────────┘ │
|
||||
│ │ │
|
||||
│ │ Monitors & Syncs │
|
||||
│ │ │
|
||||
│ ▼ │
|
||||
│ ┌──────────────────────────────────────┐ │
|
||||
│ │ Platform Stacks │ │
|
||||
│ │ │ │
|
||||
│ │ ┌──────────┐ ┌──────────┐ │ │
|
||||
│ │ │Forgejo │ │Keycloak │ │ │
|
||||
│ │ └──────────┘ └──────────┘ │ │
|
||||
│ │ ┌──────────┐ ┌──────────┐ │ │
|
||||
│ │ │Observ- │ │Ingress │ │ │
|
||||
│ │ │ability │ │ │ │ │
|
||||
│ │ └──────────┘ └──────────┘ │ │
|
||||
│ └──────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Platform Bootstrap Sequence
|
||||
|
||||
The idpbuilder executes the following workflow:
|
||||
|
||||
1. Create Kind Kubernetes cluster
|
||||
2. Install ingress-nginx controller
|
||||
3. Install ArgoCD
|
||||
4. Install Forgejo Git server
|
||||
5. Wait for services to be ready
|
||||
6. Create technical users in Forgejo
|
||||
7. Create repository for platform state in Forgejo
|
||||
8. Push platform stacks to Forgejo
|
||||
9. Create ArgoCD Applications for all stacks
|
||||
10. ArgoCD takes over continuous synchronization
|
||||
|
||||
### Deployment Architecture
|
||||
|
||||
The platform is deployed in different namespaces:
|
||||
|
||||
- `argocd`: ArgoCD and its components
|
||||
- `gitea`: Forgejo Git server
|
||||
- `keycloak`: Identity and access management
|
||||
- `observability`: Prometheus, Grafana, etc.
|
||||
- `ingress-nginx`: Ingress controller
|
||||
|
||||
## Configuration
|
||||
|
||||
### idpbuilder Configuration
|
||||
|
||||
Key configuration options for idpbuilder:
|
||||
|
||||
```bash
|
||||
# Path-based routing (recommended for local development)
|
||||
idpbuilder create --use-path-routing
|
||||
|
||||
# Custom package directory
|
||||
idpbuilder create --package-dir /path/to/custom/packages
|
||||
|
||||
# Custom Kind cluster config
|
||||
idpbuilder create --kind-config custom-kind.yaml
|
||||
|
||||
# Enable debug logging
|
||||
idpbuilder create --log-level debug
|
||||
```
|
||||
|
||||
### ArgoCD Configuration
|
||||
|
||||
Important ArgoCD configurations for platform orchestration:
|
||||
|
||||
```yaml
|
||||
# argocd-cm ConfigMap
|
||||
data:
|
||||
# Enable automatic sync
|
||||
application.instanceLabelKey: argocd.argoproj.io/instance
|
||||
|
||||
# Repository credentials
|
||||
repositories: |
|
||||
- url: https://github.com/cnoe-io/stacks
|
||||
name: cnoe-stacks
|
||||
type: git
|
||||
|
||||
# Resource exclusions
|
||||
resource.exclusions: |
|
||||
- apiGroups:
|
||||
- cilium.io
|
||||
kinds:
|
||||
- CiliumIdentity
|
||||
```
|
||||
|
||||
### Platform Stack Configuration
|
||||
|
||||
Configuration of platform stacks via Kustomize:
|
||||
|
||||
```yaml
|
||||
# kustomization.yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
namespace: platform-system
|
||||
|
||||
resources:
|
||||
- argocd-app.yaml
|
||||
- forgejo-app.yaml
|
||||
- keycloak-app.yaml
|
||||
|
||||
patches:
|
||||
- target:
|
||||
kind: Application
|
||||
patch: |-
|
||||
- op: add
|
||||
path: /spec/syncPolicy
|
||||
value:
|
||||
automated:
|
||||
prune: true
|
||||
selfHeal: true
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Platform not reachable
|
||||
|
||||
**Problem**: After `idpbuilder create`, platform services are not reachable
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Check if all pods are running
|
||||
kubectl get pods -A
|
||||
|
||||
# 2. Check ArgoCD application status
|
||||
kubectl get applications -n argocd
|
||||
|
||||
# 3. Check ingress
|
||||
kubectl get ingress -A
|
||||
|
||||
# 4. Verify DNS resolution
|
||||
nslookup cnoe.localtest.me
|
||||
|
||||
# 5. Check idpbuilder logs
|
||||
idpbuilder get logs
|
||||
```
|
||||
|
||||
### ArgoCD Applications not synchronized
|
||||
|
||||
**Problem**: ArgoCD Applications show status "OutOfSync"
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Check application details
|
||||
argocd app get <app-name>
|
||||
|
||||
# 2. View sync status
|
||||
argocd app sync <app-name> --dry-run
|
||||
|
||||
# 3. Force sync
|
||||
argocd app sync <app-name> --force
|
||||
|
||||
# 4. Check for errors in ArgoCD logs
|
||||
kubectl logs -n argocd deployment/argocd-application-controller
|
||||
```
|
||||
|
||||
### Git Repository Connection Issues
|
||||
|
||||
**Problem**: ArgoCD cannot access Git repository
|
||||
|
||||
**Solution**:
|
||||
|
||||
```bash
|
||||
# 1. Verify repository configuration
|
||||
argocd repo list
|
||||
|
||||
# 2. Test connection
|
||||
argocd repo get https://your-git-repo
|
||||
|
||||
# 3. Check credentials
|
||||
kubectl get secret -n argocd
|
||||
|
||||
# 4. Re-add repository with correct credentials
|
||||
argocd repo add https://your-git-repo \
|
||||
--username <user> \
|
||||
--password <token>
|
||||
```
|
||||
|
||||
## Platform Orchestration Best Practices
|
||||
|
||||
Based on experience and [CNCF Guidelines](https://tag-app-delivery.cncf.io/whitepapers/platforms/):
|
||||
|
||||
1. **Start Simple**: Begin with the CNOE reference stack, extend gradually
|
||||
2. **Automate Everything**: Manual platform changes are anti-pattern
|
||||
3. **Monitor Continuously**: Use observability tools for platform health
|
||||
4. **Document Well**: Platform documentation is essential for adoption
|
||||
5. **Version Everything**: All platform components should be versioned
|
||||
6. **Test Changes**: Platform updates should be tested in non-prod
|
||||
7. **Plan for Disaster**: Backup and disaster recovery strategies are important
|
||||
8. **Use Stacks**: Organize platform components as reusable stacks
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: Production (for CNOE Reference Implementation)
|
||||
|
||||
**Stability**: Stable
|
||||
|
||||
**Support**: Community Support via CNOE Community
|
||||
|
||||
## Additional Resources
|
||||
|
||||
### CNOE Resources
|
||||
|
||||
- [CNOE Official Website](https://cnoe.io/)
|
||||
- [CNOE GitHub Organization](https://github.com/cnoe-io)
|
||||
- [CNOE Reference Implementation](https://github.com/cnoe-io/stacks)
|
||||
- [CNOE Community Slack](https://cloud-native.slack.com/archives/C05TN9WFN5S)
|
||||
|
||||
### Platform Engineering
|
||||
|
||||
- [CNCF Platforms White Paper](https://tag-app-delivery.cncf.io/whitepapers/platforms/)
|
||||
- [Platform Engineering Maturity Model](https://tag-app-delivery.cncf.io/whitepapers/platform-eng-maturity-model/)
|
||||
- [Team Topologies](https://teamtopologies.com/) - Organizational patterns
|
||||
|
||||
### GitOps
|
||||
|
||||
- [GitOps Working Group](https://opengitops.dev/)
|
||||
- [ArgoCD Best Practices](https://argo-cd.readthedocs.io/en/stable/user-guide/best_practices/)
|
||||
- [GitOps Principles](https://opengitops.dev/)
|
||||
|
||||
### CNOE Stacks
|
||||
|
||||
- [Understanding CNOE Stacks](https://cnoe.io/docs/reference-implementation/stacks/)
|
||||
- [Creating Custom Stacks](https://cnoe.io/docs/reference-implementation/customization/)
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Stacks"
|
||||
linkTitle: "Stacks"
|
||||
weight: 40
|
||||
description: >
|
||||
Platform-level component provisioning via Stacks
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6729](https://jira.telekom-mms.com/browse/IPCEICIS-6729)
|
||||
* **Assignee**: Stephan
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Component 1"
|
||||
linkTitle: "Component 1"
|
||||
weight: 20
|
||||
description: >
|
||||
Component 1
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TBD]
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Component 2"
|
||||
linkTitle: "Component 2"
|
||||
weight: 30
|
||||
description: >
|
||||
Component 2
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TBD]
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
title: "Physical Environments"
|
||||
linkTitle: "Physical Envs"
|
||||
weight: 60
|
||||
description: >
|
||||
Physical runtime environments and infrastructure providers.
|
||||
---
|
||||
|
||||
Physical environment components provide the runtime infrastructure for deploying and running applications.
|
||||
|
||||
## Components
|
||||
|
||||
* **Docker**: Container runtime
|
||||
* **Kubernetes**: Container orchestration
|
||||
* **LXC**: Linux Containers
|
||||
* **Provider**: Infrastructure provider abstraction
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Docker"
|
||||
linkTitle: "Docker"
|
||||
weight: 10
|
||||
description: >
|
||||
Container runtime for running containerized applications
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Kubernetes"
|
||||
linkTitle: "Kubernetes"
|
||||
weight: 20
|
||||
description: >
|
||||
Container orchestration platform for managing containerized workloads
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "LXC"
|
||||
linkTitle: "LXC"
|
||||
weight: 30
|
||||
description: >
|
||||
Linux Containers for lightweight system-level virtualization
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: "Infrastructure Provider"
|
||||
linkTitle: "Provider"
|
||||
weight: 40
|
||||
description: >
|
||||
Infrastructure provider abstraction for managing physical resources
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
||||
* **Assignee**: [Name or Team]
|
||||
* **Status**: Draft
|
||||
* **Last Updated**: YYYY-MM-DD
|
||||
* **TODO**:
|
||||
* [ ] Add detailed component description
|
||||
* [ ] Include usage examples and code samples
|
||||
* [ ] Add architecture diagrams
|
||||
* [ ] Review and finalize content
|
||||
{{% /alert %}}
|
||||
|
||||
## Overview
|
||||
|
||||
[Detailed description of the component - what it is, what it does, and why it exists]
|
||||
|
||||
## Key Features
|
||||
|
||||
* [Feature 1]
|
||||
* [Feature 2]
|
||||
* [Feature 3]
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to source code repository]
|
||||
|
||||
**Documentation**: [Link to component-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* [Prerequisite 1]
|
||||
* [Prerequisite 2]
|
||||
|
||||
### Quick Start
|
||||
|
||||
[Step-by-step guide to get started with this component]
|
||||
|
||||
1. [Step 1]
|
||||
2. [Step 2]
|
||||
3. [Step 3]
|
||||
|
||||
### Verification
|
||||
|
||||
[How to verify the component is working correctly]
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### [Use Case 1]
|
||||
|
||||
[Example with code/commands showing common use case]
|
||||
|
||||
```bash
|
||||
# Example commands
|
||||
```
|
||||
|
||||
### [Use Case 2]
|
||||
|
||||
[Another common scenario]
|
||||
|
||||
## 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]
|
||||
|
||||
## Configuration
|
||||
|
||||
[Key configuration options and how to set them]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### [Common Issue 1]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
### [Common Issue 2]
|
||||
|
||||
**Problem**: [Description]
|
||||
|
||||
**Solution**: [How to fix]
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: [Production / Beta / Experimental]
|
||||
|
||||
## Additional Resources
|
||||
|
||||
* [Link to external documentation]
|
||||
* [Link to community resources]
|
||||
* [Link to related components]
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
[Instructions for team members filling in this documentation - remove this section once complete]
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 92 KiB |
|
|
@ -38,13 +38,13 @@ TBD
|
|||
|
||||
### Argo Workflows + Events
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* integration with ArgoCD
|
||||
* ability to trigger additional workflows based on events.
|
||||
* level of maturity and community support.
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* Ability to self-host runners?
|
||||
* way how composition for pipelines works (based on Kubernetes CRDs)
|
||||
|
|
@ -57,53 +57,53 @@ TBD
|
|||
|
||||
### Argo Workflows + Events + Additional Composition tool
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* Composability can be offloaded to another tool
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* All cons of the previous option (except composability)
|
||||
* Additional complexity by adding another tool
|
||||
|
||||
### Forgejo Actions
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* tight integration with GitHub Actions providing a familiar interface for developers and a vast catalog of actions to choose from
|
||||
* ability to compose pipelines without relying on another tool
|
||||
* Self-hosting of runners possible
|
||||
* every component can have its own repository and use different tools (e.g. written in go, bash, python etc.)
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* level of maturity - will require additional investments to provide a production-grade system
|
||||
|
||||
### Forgejo Actions + Additional Tool
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* may be possible to use GitHub actions alongside another tool
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* additional complexity by adding another tool
|
||||
|
||||
### Shuttle
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* Possibility to clearly define interfaces for pipeline steps
|
||||
* Relatively simple
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* basically backed by only one company
|
||||
* **centralized templates**, so no mechanism for composing pipelines from multiple repositories
|
||||
|
||||
### Dagger
|
||||
|
||||
#### Pro
|
||||
**Pro**
|
||||
|
||||
* Pipeline as code
|
||||
* if it runs it should run anywhere and produce the "same" / somewhat stable results
|
||||
|
|
@ -112,13 +112,13 @@ TBD
|
|||
* additional tooling, like trivy, is added to a build pipeline with low effort due to containers and existing plugin/wrappers
|
||||
* you can create complex test environments similar to test containers and docker compose
|
||||
|
||||
#### Con
|
||||
**Con**
|
||||
|
||||
* relies heavily containers, which might not be available some environments (due to policy etc), it also has an effect on reproducibility and verifiability
|
||||
* as a dev you need to properly understand containers
|
||||
* dagger engine has to run privileged locally and/or in the cloud which might be a blocker or at least a big pain in the ...
|
||||
|
||||
#### Suggestion Patrick
|
||||
**Suggestion Patrick**
|
||||
|
||||
* dagger is a heavy weight and might not be as productive in a dev workflow as it seems (setup lsp etc)
|
||||
* it might be too opinionated to force on teams, especially since it is not near mainstream enough, community might be too small
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
---
|
||||
title: "WiP Documentation Guide"
|
||||
linkTitle: "WiP Doc Guide"
|
||||
weight: 1
|
||||
description: Guidelines and templates for creating EDP documentation. This page will be removed in the final documentation.
|
||||
---
|
||||
|
||||
{{% alert title="WiP - Only during creation phase" %}}
|
||||
This page will be removed in the final documentation.
|
||||
{{% /alert %}}
|
||||
|
||||
## Purpose
|
||||
|
||||
This guide helps team members create consistent, high-quality documentation for the Edge Developer Platform.
|
||||
|
||||
|
||||
## Documentation Principles
|
||||
|
||||
### 1. Focus on Outcomes
|
||||
|
||||
1. Describe how the platform is comprised and which Products we deliver
|
||||
2. If you need inspiration for our EDP product structure look at [EDP product structure tree](../components/website-and-documentation_resources_product-structure.svg)
|
||||
2. Include links to repositories for deeper technical information or for not beeing too verbose and redundant with existing doumentation within the IPCEI-CIS scope or our EDP repos scope.
|
||||
|
||||
### 2. Write for the Audience
|
||||
|
||||
1. **Developers**: How to use the software products
|
||||
2. **Engineers**: Architecture
|
||||
3. **Auditors**: Project history, decisions, compliance information
|
||||
|
||||
### 3. Keep It Concise
|
||||
|
||||
1. Top-down approach: start with overview, drill down as needed
|
||||
2. Less is more - avoid deep nested structures
|
||||
3. Avoid emojis
|
||||
4. **When using AI**: Review the text that you paste, check integration into the rest of the documentation
|
||||
|
||||
### 4. Maintain Quality
|
||||
|
||||
1. Use present tense ("The system processes..." not "will process")
|
||||
2. Run `task test:quick` before committing changes
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
The EDP documentation is organized into five main sections:
|
||||
|
||||
### 1. Platform Overview
|
||||
|
||||
High-level introduction to EDP, target audience, purpose, and product structure.
|
||||
|
||||
**Content focus**: Why EDP exists, who uses it, what it provides
|
||||
|
||||
### 2. Getting Started
|
||||
|
||||
Onboarding guides and quick start instructions.
|
||||
|
||||
**Content focus**: Prerequisites, step-by-step setup, first application deployment
|
||||
|
||||
### 3. Components
|
||||
|
||||
Detailed documentation for each platform component.
|
||||
|
||||
**Content focus**: What each component does, how to use it, integration points
|
||||
|
||||
**Template**: Use `components/TEMPLATE.md` as starting point
|
||||
|
||||
### 4. Operations
|
||||
|
||||
Deployment, monitoring, troubleshooting, and maintenance procedures.
|
||||
|
||||
**Content focus**: How to operate the platform, resolve issues, maintain health
|
||||
|
||||
### 5. Governance
|
||||
|
||||
Project history, architecture decisions, compliance, and audit information.
|
||||
|
||||
**Content focus**: Why decisions were made, project evolution, external relations
|
||||
|
||||
## Writing Documentation
|
||||
|
||||
### Components
|
||||
|
||||
#### Using Templates
|
||||
|
||||
In section 'Components' Templates are provided for common documentation types:
|
||||
|
||||
* **Component Documentation**: `content/en/docs/components/TEMPLATE.md`
|
||||
|
||||
#### Content Structure
|
||||
|
||||
Follow this pattern for component documentation:
|
||||
|
||||
1. **Overview**: What it is and what it does
|
||||
2. **Key Features**: Bullet list of main capabilities
|
||||
3. **Purpose in EDP**: Why it's part of the platform
|
||||
4. **Getting Started**: Quick start guide
|
||||
5. **Usage Examples**: Common scenarios
|
||||
6. **Integration Points**: How it connects to other components
|
||||
7. **Status**: Current maturity level
|
||||
8. **Documentation Notes**: Instructions for filling in details (remove when complete)
|
||||
|
||||
### Frontmatter
|
||||
|
||||
Every markdown file starts with YAML frontmatter according to [Docsy](https://www.docsy.dev/docs/adding-content/content/#page-frontmatter):
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Full Page Title"
|
||||
linkTitle: "Short Nav Title"
|
||||
weight: 10
|
||||
description: >
|
||||
Brief description for search and previews.
|
||||
---
|
||||
```
|
||||
|
||||
* **title**: Full page title (appears in page header)
|
||||
* **linkTitle**: Shorter title for navigation menu
|
||||
* **weight**: Sort order (lower numbers appear first)
|
||||
* **description**: Brief summary for SEO and page previews
|
||||
|
||||
## Testing Documentation
|
||||
|
||||
Before committing changes:
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
task test:quick
|
||||
|
||||
# Build site locally
|
||||
task build
|
||||
|
||||
# Preview changes
|
||||
task serve
|
||||
```
|
||||
|
||||
## Adding New Sections
|
||||
|
||||
When adding a new documentation section:
|
||||
|
||||
1. Create directory: `content/en/docs/[section-name]/`
|
||||
2. Create index file: `_index.md` with frontmatter
|
||||
3. Add weight to control sort order
|
||||
4. Update navigation in parent `_index.md` if needed
|
||||
5. Test with `task test`
|
||||
|
||||
## Reference
|
||||
|
||||
* **Main README**: `/doc/README-technical-writer.md`
|
||||
* **Component Template**: `/content/en/docs/components/TEMPLATE.md`
|
||||
* **Hugo Documentation**: <https://gohugo.io/documentation/>
|
||||
* **Docsy Theme**: <https://www.docsy.dev/docs/>
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
---
|
||||
title: "Getting Started"
|
||||
linkTitle: "Getting Started"
|
||||
weight: 20
|
||||
description: >
|
||||
Quick start guides and onboarding information for the Edge Developer Platform.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: TBD
|
||||
* **Assignee**: Team
|
||||
* **Status**: Draft - Structure only
|
||||
* **Last Updated**: 2025-11-16
|
||||
* **TODO**:
|
||||
* [ ] Add concrete quick start steps
|
||||
* [ ] Include prerequisites and access information
|
||||
* [ ] Create first application tutorial
|
||||
{{% /alert %}}
|
||||
|
||||
## Welcome to EDP
|
||||
|
||||
This section helps you get started with the Edge Developer Platform, whether you're a developer building applications or a platform engineer managing infrastructure.
|
||||
|
||||
## Quick Start for Developers
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* Access to EDP instance
|
||||
* Git client installed
|
||||
* kubectl configured (for Kubernetes access)
|
||||
* Basic knowledge of containers and CI/CD
|
||||
|
||||
### Your First Application
|
||||
|
||||
1. **Access the Platform**: Log in to Backstage portal
|
||||
2. **Clone Repository**: Get your application repository from Forgejo/GitLab
|
||||
3. **Configure Pipeline**: Set up CI/CD in Woodpecker or ArgoCD
|
||||
4. **Deploy**: Push code and watch automated deployment
|
||||
|
||||
### Next Steps
|
||||
|
||||
* Explore available components and services
|
||||
* Review platform documentation and best practices
|
||||
* Join the developer community
|
||||
|
||||
## Quick Start for Platform Engineers
|
||||
|
||||
### Platform Access
|
||||
|
||||
* Kubernetes cluster access
|
||||
* Infrastructure management tools
|
||||
* Monitoring and observability dashboards
|
||||
|
||||
### Key Resources
|
||||
|
||||
* Platform architecture documentation
|
||||
* Operational runbooks
|
||||
* Troubleshooting guides
|
||||
|
||||
## Documentation Template
|
||||
|
||||
When creating "Getting Started" content for a component:
|
||||
|
||||
1. **Prerequisites**: What users need before starting
|
||||
2. **Step-by-Step Guide**: Clear, numbered instructions
|
||||
3. **Verification**: How to confirm success
|
||||
4. **Common Issues**: FAQ and troubleshooting
|
||||
5. **Next Steps**: Links to deeper documentation
|
||||
|
|
@ -1,114 +0,0 @@
|
|||
---
|
||||
title: "Governance"
|
||||
linkTitle: "Governance"
|
||||
weight: 100
|
||||
description: >
|
||||
Project history, architecture decisions, compliance, and audit information.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: [TICKET-6737](https://jira.telekom-mms.com/browse/IPCEICIS-6737)
|
||||
* **Assignee**: Sophie
|
||||
* **Status**: Draft - Structure only
|
||||
* **Last Updated**: 2025-11-16
|
||||
* **TODO**:
|
||||
* [ ] Migrate relevant ADRs from docs-old
|
||||
* [ ] Document project history and phases
|
||||
* [ ] Add deliverables mapping
|
||||
* [ ] Include compliance documentation
|
||||
{{% /alert %}}
|
||||
|
||||
## Governance Overview
|
||||
|
||||
This section provides information for auditors, governance teams, and stakeholders who need to understand the project's decision-making process, history, and compliance.
|
||||
|
||||
## Architecture Decision Records (ADRs)
|
||||
|
||||
Documentation of significant architectural decisions made during the project, including context, options considered, and rationale.
|
||||
|
||||
## Project History
|
||||
|
||||
### Development Process
|
||||
|
||||
The EDP was developed using collaborative approaches including mob programming and iterative development with regular user feedback.
|
||||
|
||||
### Project Phases
|
||||
|
||||
* Research & Design
|
||||
* Proof of Concept
|
||||
* Friendly User Phase
|
||||
* Production Rollout
|
||||
|
||||
### Deliverables Mapping
|
||||
|
||||
Mapping to IPCEI-CIS deliverables and project milestones.
|
||||
|
||||
## Compliance & Audit
|
||||
|
||||
### Technology Choices
|
||||
|
||||
Documentation of technology evaluation and selection process for key components (e.g., VictoriaMetrics, GARM, Terraform, ArgoCD).
|
||||
|
||||
#### Forgejo
|
||||
|
||||
The internal service is officially designated as the [Edge Developer Platform (EDP)](../components/forgejo/_index.md). It is hosted at **[edp.buildth.ing](https://edp.buildth.ing)**. The domain selection followed a democratic team process to establish a unique identity distinct from standard corporate naming conventions.
|
||||
|
||||
**Solution selection:**
|
||||
|
||||
The decision to utilize **[Forgejo](https://forgejo.org/)** as the core self-hosted Git service was driven by specific strategic requirements:
|
||||
|
||||
* **EU-Based Stewardship:** Forgejo is stewarded by **[Codeberg e.V.](https://docs.codeberg.org/getting-started/what-is-codeberg/)**, a non-profit organization based in Berlin, Germany. This alignment ensures compliance with GDPR and data sovereignty requirements, placing governance under EU jurisdiction rather than US tech entities.
|
||||
* **License Protection (GPL v3+):** Unlike "Open Core" models, Forgejo uses a copyleft license. This legally protects our custom extensions (such as GARM support) from being appropriated into proprietary software, ensuring the ecosystem remains open.
|
||||
* **Open Source Strategy:** The platform aligns with the "Public Money, Public Code" philosophy, mandating that funded developments are returned to the community.
|
||||
|
||||
**Access Model:**
|
||||
|
||||
The platform operates on a hybrid visibility model:
|
||||
|
||||
* **Public Access:** The [`DEVFW-CICD`](https://edp.buildth.ing/DevFW-CICD) organization is publicly accessible, fostering transparency.
|
||||
* **Private Access:** Sensitive development occurs in restricted organizations (e.g., [`DEVFW`](https://edp.buildth.ing/DevFW)).
|
||||
* **User Base:** Primary users include the internal development team, with friendly user access granted to the IPCEI team and MMS BT.
|
||||
|
||||
### Security Controls
|
||||
|
||||
Overview of implemented security controls and compliance measures.
|
||||
|
||||
### Ticket References
|
||||
|
||||
Cross-references to Jira tickets, epics, and project tracking for audit trails.
|
||||
|
||||
## Community & External Relations
|
||||
|
||||
### Open Source Contributions
|
||||
|
||||
Contributions to the Forgejo community and other open-source projects.
|
||||
|
||||
#### Forgejo
|
||||
|
||||
We actively contributed our extensions back to the upstream Forgejo project on **[Codeberg.org](https://codeberg.org/)**.
|
||||
|
||||
**Key Pull Requests:**
|
||||
|
||||
* **API Compatibility:** Added GitHub-compatible endpoints for runner registration.
|
||||
* [PR #9409: Feat: Add endpoints for GARM](https://codeberg.org/forgejo/forgejo/pulls/9409)
|
||||
* **Webhook Support:** Implemented webhook triggers for workflow events.
|
||||
* [PR #9803: Feat: Add webhook support for workflow events](https://codeberg.org/forgejo/forgejo/pulls/9803)
|
||||
* **Ephemeral Runners:** Added support for runners that terminate after a single job.
|
||||
* [PR #9962: Feat: Support for ephemeral runners](https://codeberg.org/forgejo/forgejo/pulls/9962)
|
||||
|
||||
### External Stakeholders
|
||||
|
||||
User experience research and feedback integration.
|
||||
|
||||
## Documentation Template
|
||||
|
||||
When creating governance documentation:
|
||||
|
||||
1. **Context**: Background and situation
|
||||
2. **Decision/Event**: What was decided or what happened
|
||||
3. **Rationale**: Why this decision was made
|
||||
4. **Alternatives**: Other options considered
|
||||
5. **Consequences**: Impact and outcomes
|
||||
6. **References**: Links to tickets, discussions, external resources
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
---
|
||||
title: "Operations"
|
||||
linkTitle: "Operations"
|
||||
weight: 40
|
||||
description: >
|
||||
Operational guides for deploying, monitoring, and maintaining the Edge Developer Platform.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: TBD
|
||||
* **Assignee**: Team
|
||||
* **Status**: Draft - Structure only
|
||||
* **Last Updated**: 2025-11-16
|
||||
* **TODO**:
|
||||
* [ ] Add deployment procedures
|
||||
* [ ] Document monitoring setup and dashboards
|
||||
* [ ] Include troubleshooting guides
|
||||
* [ ] Add maintenance procedures
|
||||
{{% /alert %}}
|
||||
|
||||
## Operations Overview
|
||||
|
||||
This section covers operational aspects of the Edge Developer Platform including deployment, monitoring, troubleshooting, and maintenance.
|
||||
|
||||
## Deployment
|
||||
|
||||
### Platform Deployment
|
||||
|
||||
Instructions for deploying EDP components to your infrastructure.
|
||||
|
||||
### Application Deployment
|
||||
|
||||
Guides for deploying applications to the platform using available deployment methods.
|
||||
|
||||
## Monitoring & Observability
|
||||
|
||||
### Metrics
|
||||
|
||||
Access and interpret platform and application metrics using VictoriaMetrics, Prometheus, and Grafana.
|
||||
|
||||
### Logging
|
||||
|
||||
Log aggregation and analysis for troubleshooting and audit purposes.
|
||||
|
||||
### Alerting
|
||||
|
||||
Configure alerts for critical platform events and application issues.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and their solutions for platform operations.
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Updates & Upgrades
|
||||
|
||||
Procedures for updating platform components and maintaining system health.
|
||||
|
||||
### Backup & Recovery
|
||||
|
||||
Data backup strategies and disaster recovery procedures.
|
||||
|
||||
## Documentation Template
|
||||
|
||||
When creating operational documentation:
|
||||
|
||||
1. **Purpose**: What this operation achieves
|
||||
2. **Prerequisites**: Required access, tools, and knowledge
|
||||
3. **Procedure**: Step-by-step instructions with commands
|
||||
4. **Verification**: How to confirm successful completion
|
||||
5. **Rollback**: How to revert if needed
|
||||
6. **Troubleshooting**: Common issues and solutions
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
---
|
||||
title: "Platform Overview"
|
||||
linkTitle: "Platform Overview"
|
||||
weight: 10
|
||||
description: >
|
||||
High-level overview of the Edge Developer Platform (EDP), its purpose, and product structure.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: TBD
|
||||
* **Assignee**: Team
|
||||
* **Status**: Draft - Initial structure created
|
||||
* **Last Updated**: 2025-11-16
|
||||
* **TODO**:
|
||||
* [ ] Add detailed product structure from excalidraw
|
||||
* [ ] Include platform maturity matrix
|
||||
* [ ] Add links to component pages as they are created
|
||||
{{% /alert %}}
|
||||
|
||||
## Purpose
|
||||
|
||||
The Edge Developer Platform (EDP) is a comprehensive DevOps platform designed to enable developers to build, deploy, and operate cloud-native applications at the edge. It provides an integrated suite of tools and services covering the entire software development lifecycle.
|
||||
|
||||
## Target Audience
|
||||
|
||||
* **Developers**: Build and deploy applications using standardized workflows
|
||||
* **Platform Engineers**: Operate and maintain the platform infrastructure
|
||||
* **DevOps Teams**: Implement CI/CD pipelines and automation
|
||||
* **Auditors**: Verify platform capabilities and compliance
|
||||
|
||||
## Product Structure
|
||||
|
||||
EDP consists of multiple integrated components organized in layers:
|
||||
|
||||
### Core Platform Services
|
||||
|
||||
The foundation layer provides essential platform capabilities including source code management, CI/CD, and container orchestration.
|
||||
|
||||
### Developer Experience
|
||||
|
||||
Tools and services that developers interact with directly to build, test, and deploy applications.
|
||||
|
||||
### Infrastructure & Operations
|
||||
|
||||
Infrastructure automation, observability, and operational tooling for platform management.
|
||||
|
||||
## Platform Maturity
|
||||
|
||||
Components in EDP have different maturity levels:
|
||||
|
||||
* **Production**: Fully integrated and supported for production use
|
||||
* **Beta**: Available for testing with potential changes
|
||||
* **Experimental**: Early stage, subject to significant changes
|
||||
|
||||
## Getting Started
|
||||
|
||||
For quick start guides and onboarding information, see the [Getting Started](../getting-started/) section.
|
||||
|
||||
For detailed component information, explore the [Components](../components/) section.
|
||||
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
|
Before Width: | Height: | Size: 944 KiB After Width: | Height: | Size: 944 KiB |
|
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 732 KiB After Width: | Height: | Size: 732 KiB |
|
Before Width: | Height: | Size: 554 KiB After Width: | Height: | Size: 554 KiB |
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: CNOE
|
||||
weight: 4
|
||||
---
|
||||
+++
|
||||
title = "CNOE"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
|
||||
* https://cnoe.io/docs/intro
|
||||
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 113 KiB |
|
Before Width: | Height: | Size: 364 KiB After Width: | Height: | Size: 364 KiB |
|
Before Width: | Height: | Size: 208 KiB After Width: | Height: | Size: 208 KiB |
|
|
@ -0,0 +1,7 @@
|
|||
+++
|
||||
title = "Humanitec"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
|
||||
tbd
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue