cache-management-api
Small operational API that lists the known TC.Cache caches across the estate and allows them to be cleared.
Health score
0 to 100 across seven weighted factors; nothing is hidden. Green is 75 and above, amber 50 to 74, red below 50. How scoring works.
Facts
| Languages | csharp |
| Frameworks | ASP.NET Core 8 |
| Runtimes | .NET 8 |
| Tests / CI | none / CI in place |
| Last commit | 2026-07-01 |
| Owner | Owner unknown (mapping to be curated) |
| Domain | Platform services (system generated; curate in repo-owners.json to override) |
| Product area | Shared platform |
| Hosted | On-prem Deployed to our own machines
|
| Releases | 1 release pipeline(s): cache-management-api |
| Integration | rest |
| Source | Open in Azure DevOps |
Dependencies in context
Entanglement
loose No binding mechanisms apply: this system needs no untangling work.
Depends on / used by
Migration playbooks
Generated from this repo's assessment data: what is feasible, what blocks it, and the steps in order. Ratings: green means actionable now, amber means sequence other work first, red means blocked, grey means not applicable.
ZDD adoption
Needs workFeasible through the Workflow Engine's rolling drain, but real preparation is needed: dual-version discipline, better tests, or schema care before at-will release is sensible. No automated tests yet.
- Adopt the four-stage discipline from the ZDD engineering standard: pre-deployment compatibility, deployment, feature activation behind a flag, post-release cleanup.
- Raise automated test coverage first: ZDD trades the end-of-sprint manual gate for continuous automated confidence, so the tests are the entry ticket.
- Make every change dual-version safe: backwards-compatible APIs (new major version for breaking wire changes), expand and contract for any schema change, and consumers tolerant of unknown fields.
- Audit serialized data: anything in Redis, queues or shared caches must deserialize cleanly across adjacent versions.
- Wrap behaviour changes in feature flags so code deploys dark and release becomes a business decision, not a deployment event.
- Route deployments through the Workflow Engine's automated drain, deploy, health-check, return cycle (the path proven by the first automated production run in mid-2026).
- Verify with area-scoped regression rather than the whole-platform cycle, and watch error rates after rollout with automated rollback on alert.
SQL Server exit
Not applicableNo SQL Server dependency is recorded for this repo. Nothing to migrate.
Containerisation
Ready to containeriseModern runtime, no hosted legacy transport: this service can follow the estate's proven container path (Dockerfile, shared pipeline template, ECS via Terraform).
- Add a Dockerfile and make the app read all configuration from environment variables and the secrets manager, never from machine-local files.
- Log to stdout and expose a health check endpoint so ECS can supervise it.
- Adopt the shared ci.yml pipeline template with the container parameters (awsRegion, containerAfterBuild, ecsTerraformRepo), which is exactly how the estate's existing AWS services deploy.
- Define the service in the Terraform repo, deploy to a non-production environment, then shift traffic and disarm the deployment-group release pipeline.
Recommended actions
No specific actions for this repo. It either needs only normal maintenance, or its work is covered by an estate-level action. See the full programme.
Assessment notes
cache-management-api
Purpose
An operational/administrative API for the TC.Cache caching layer: it enumerates known caches (from an embedded CacheInformation.xml catalogue) and exposes endpoints to clear them across environments, calling other API hosts' cache endpoints where needed.
Tech stack
- C# on .NET 8, single ASP.NET Core project (
TC.Cache.Management.Api). - API versioning, Swashbuckle/Swagger, PhenixAuth authentication scheme, TC exception middleware.
- Internal libraries: TC.Cache 10.x (Redis-backed cache abstraction), TC.ConnectionBroker (Api/Redis).
Deployment
release_count 1, single build pipeline and single release pipeline (cache-management-api). CI (build.yml) uses shared azure-pipelines-templates with dotnet SDK 8.x. README badges show releases to QA, Staging, Production, Training and DR. web.config transforms per environment indicate IIS hosting.
Dependencies
- Internal: operates on the shared TC.Cache Redis infrastructure used by other estate services; connection details resolved via TC.ConnectionBroker. It calls cache endpoints on other API hosts (
ApiCacheHostsconfig) but no specific estate repo dependency is confirmed. - External: none.
Data stores
- Redis (the shared TC.Cache storage it manages;
CacheStorage: redis). No database of its own.
Integration points
- Versioned REST API with Swagger; outbound HTTP calls to sibling APIs' cache-clear endpoints.
Code health
No test projects exist in the repo. CI is in place and the service is small and recently touched (last commit 2026-07-01). Multiple per-environment appsettings and web.config transforms add configuration sprawl for its size.
Modernisation risks
Low priority: modern .NET 8 runtime and tiny scope. Flags: no automated tests, and the embedded XML cache catalogue must be kept manually in sync with caches across the estate.