initial commit

Change-Id: I4630f10e87c2a1233268fb6df6e8513936d893bf

docs/api.md

@@ -0,0 +1,20 @@
+# API Reference
+
+Base URL: `https://sonar-test-go.kyndemo.live`
+
+## Items `/api/items`
+
+| Method | Path | Body | Response |
+|--------|------|------|----------|
+| GET | `/api/items` | — | Array of items |
+| POST | `/api/items` | `{"name":"...","description":"..."}` | Created item (201) |
+| GET | `/api/items/{id}` | — | Item or 404 |
+| PUT | `/api/items/{id}` | `{"name":"...","description":"..."}` | Updated item |
+| DELETE | `/api/items/{id}` | — | `{"deleted":id}` |
+
+## Observability
+
+| Path | Description |
+|------|-------------|
+| `/health` | Health check — `{"status":"UP"}` |
+| `/metrics` | Prometheus exposition format |

docs/architecture.md

@@ -0,0 +1,30 @@
+# Architecture
+
+`sonar-test-go` is a `go` service.
+
+| Component | Detail |
+|-----------|--------|
+| Runtime | `go` |
+| Container port | `8080` |
+| Health check | `/health` |
+| Metrics | `/metrics` (Prometheus format) |
+| Image | Azure Container Registry (`bstagecjotdevacr`) |
+
+## Deployment flow
+
+```
+Push to dev/staging/prod
+  → build-push.yml  (build + test → push image to ACR)
+  → deploy-humanitec.yml (hctl score deploy)
+```
+
+## Branch model
+
+| Branch | Purpose |
+|--------|---------|
+| `main` | System of record — catalog, docs, score.yaml, platform config |
+| `dev` | Active development |
+| `staging` | Pre-production (lazy-created on first promote) |
+| `prod` | Production (lazy-created on first promote) |
+
+Promotions between environments are triggered from the Backstage CI/CD tab.

docs/index.md

@@ -0,0 +1,45 @@
+# sonar-test-go
+
+SonarQube test — Go runtime
+
+## Overview
+
+This service was scaffolded from the **Create Microservice** golden-path template on the Kyndryl Platform.
+
+- **Runtime**: `go`
+- **Owner**: group:default/platform-engineering
+- **Deployment profile**: `stateless`
+
+## Architecture
+
+See [architecture.md](architecture.md) for the full architecture diagram.
+
+At a glance:
+
+```
+┌──────────────────────────────────────┐
+│  Gitea Actions CI/CD                 │
+│  ┌─────────────┐  ┌───────────────┐  │
+│  │ build-push  │→ │ deploy-       │  │
+│  │ .yml        │  │ humanitec.yml │  │
+│  └─────────────┘  └───────────────┘  │
+└──────────────────────────────────────┘
+          │                │
+          ▼                ▼
+       Azure ACR     Humanitec API
+                          │
+                          ▼
+                   AKS (via Score)
+                          │
+                          ▼
+              ┌──────────────────────────┐
+              │  sonar-test-go        │
+              │  :8080     │
+              │  /api/items              │
+              │  /health         │
+              └──────────────────────────┘
+```
+
+## API Reference
+
+See [api.md](api.md) for the full OpenAPI reference.