feat: add platform deployment artifacts

This commit is contained in:
2026-03-13 11:38:49 +00:00
parent 1d0b844e76
commit 99df8075be
8 changed files with 601 additions and 0 deletions

25
docs/api.md Normal file
View File

@@ -0,0 +1,25 @@
# API Reference
## Endpoints
### Health Check
```
GET /health
```
**Response:**
```json
{"status": "UP", "service": "mohamed-node-mod-1"}
```
### Root
```
GET /
```
**Response:**
```json
{"service": "mohamed-node-mod-1", "description": "Modernized mohamed-node-mod-1 service", "version": "1.0.0"}
```

15
docs/architecture.md Normal file
View File

@@ -0,0 +1,15 @@
# Architecture
## Service Design
mohamed-node-mod-1 is a microservice following cloud-native patterns.
## Technology Stack
- **Runtime**: Node.js Express
- **Deployment**: Humanitec Platform Orchestrator
- **CI/CD**: Gitea Actions → ACR → Humanitec
## Dependencies
See `score.yaml` for external resource dependencies.

32
docs/index.md Normal file
View File

@@ -0,0 +1,32 @@
# mohamed-node-mod-1
Modernized mohamed-node-mod-1 service
## Overview
This service is built with **Node.js Express** and follows the Golden Path architecture patterns.
### Key Features
- 🚀 Production-ready configuration
- 📊 Prometheus metrics exposed
- 🏥 Health check endpoints
- 🔒 Security scanning in CI/CD
- 📦 Containerized deployment
## Quick Start
```bash
git clone https://gitea.kyndemo.live/kyndryl-demos/mohamed-node-mod-1.git
cd mohamed-node-mod-1
```
## Monitoring
- **Metrics**: Prometheus metrics at `/metrics`
- **Health**: `/health`
- **Grafana**: [View Dashboard](https://grafana.kyndemo.live/d/app-mohamed-node-mod-1)
## Support
Contact the Platform Engineering team.

51
docs/migration-plan.md Normal file
View File

@@ -0,0 +1,51 @@
# Modernization Plan for mohamed-node-mod-1
## Application Type
Nodejs Application
## Selected Modernization Strategy
- **Migration Approach**: containerize-optimize
- **Target Platform**: kubernetes-humanitec
- **Observability**: ENABLED (Prometheus metrics, health checks, tracing)
- **Security Scanning**: ENABLED (Trivy vulnerability scanning)
## Discovery Summary
### Discovery Report
#### Application Overview
- **Path**: `/tmp/modernize_mj1ov94n`
- **Type**: Node.js application
- **Language**: TypeScript
- **Build Tools**: npm
- **Linting/Formatting**: ESLint, Prettier
#### Technology Stack
- **Framework**: Express.js
- **Database Client**: Prisma
- **Authentication**: JSON Web Tokens (JWT)
- **Other Utilities**:
- Axios (HTTP client)
- bcryptjs (Password hashing)
- cors (Cross-Origin Resource Sharing)
- body-parser (Request body parsing)
- s...
## Generated Artifacts
1. **Dockerfile**: Optimized with health checks and metrics endpoints
2. **score.yaml**: Platform-agnostic environment intent optimized for kubernetes-humanitec with Prometheus metrics resources
3. **CI Workflow**: Automated build/push to ACR with Trivy security scanning
## Next Steps
1. Review and customize generated artifacts
2. Test container build and run
3. Deploy to development environment using score.yaml
4. Validate application functionality
5. Promote to staging/production via Humanitec
## Migration Strategy Details
### Containerize Optimize
Add cloud-native patterns: health checks, metrics, optimized base images.
### Platform: kubernetes-humanitec
score.yaml is the single environment intent. Use Humanitec Platform Orchestrator for deployment.