Skip to content

DevOps · Editable reference architecture

Internal developer platform architecture

An editable internal developer platform architecture reference showing Developer → Service catalog → Template workflow and downstream dependencies. Build a paved path with an escape hatch.

Open & Edit in DrawArc (Free, No Login Required)

Your changes stay in a separate draft on this browser. Download an editable project to keep a portable copy.

LinkedInTelegramReddit

Internal developer platform architecture diagram: Developer, Service catalog, Template workflow, Provisioning API and their connections
Internal developer platform architecture — follow the component relationships, then open the editor to adapt the design. View diagram image.

7 components · 6 connections · Open the editor to zoom, move nodes and edit source.

Architectural overview

Internal developer platform architecture addresses the responsibilities and boundaries shown in this reference rather than prescribing an entire production deployment. The primary flow starts at Developer and reaches Runtime through Service catalog, Template workflow, Provisioning API. Use this view to explain which component initiates work, which component owns a decision, and where a dependency can affect the caller. Build a paved path with an escape hatch.

The diagram contains 7 distinct components and 6 directed relationships. A separate path connects Service catalog → Documentation. A separate path connects Runtime → Observability. These arrows describe logical interactions; they do not establish authentication, network access, atomic transactions or delivery guarantees. Label the actual protocol, payload contract and owner when adapting the drawing to your system. Keep synchronous and asynchronous boundaries explicit so that a reviewer can identify where a request ends and a later operation begins.

Before implementing this architecture, define expected load, data classification, latency budgets and recovery objectives. Give Developer a bounded dependency timeout and a documented failure response. Assign ownership to any state or external service added during implementation. Validate the decision above against your workload instead of treating the presence of a component as proof of reliability. Open the editable canvas, replace generic labels with real deployment units, and document the decisions that differ from this reference.

The real-world problem

Design or explain internal developer platform architecture with explicit ownership and dependency paths. Build a paved path with an escape hatch.

Data flow

Connections from this diagram. Branches and control signals are not a single chronological sequence.

  • Developer → Service catalog. Define the interaction contract and trace the resulting response or state change.
  • Service catalog → Template workflow. Define the interaction contract and trace the resulting response or state change.
  • Template workflow → Provisioning API. Define the interaction contract and trace the resulting response or state change.
  • Provisioning API → Runtime. Define the interaction contract and trace the resulting response or state change.
  • Service catalog → Documentation. Define the interaction contract and trace the resulting response or state change.
  • Runtime → Observability. Define the interaction contract and trace the resulting response or state change.

Security boundaries

  • Authenticate callers at the boundary before Service catalog accepts protected work; authorize the specific operation rather than trusting network placement.
  • Use separate service identities and least-privilege permissions for Service catalog, Template workflow, Provisioning API. Encrypt sensitive traffic, protect credentials and avoid placing confidential payloads in logs.
  • Validate untrusted inputs and restrict administrative/configuration endpoints separately from the main flow.

Failure handling

Developer is unavailable or slow

Response: Apply bounded timeouts and controlled backoff only where retrying is safe. Return an explicit failure or durable acceptance; do not report success before required work is committed.

Verify: Interrupt Developer in an isolated test and measure errors, recovery and any repeated side effects.

A dependency repeats or drops a request

Response: Use operation identifiers and explicit acknowledgement/reconciliation where needed. Verify idempotency before enabling retries.

Verify: Exercise the failure path with representative records and verify both the visible response and the resulting state.

An invalid or incompatible input reaches Service catalog

Response: Validate the input contract before effects are committed. Preserve rejected input identifiers without exposing secrets, and document a safe replay or correction procedure.

Verify: Send malformed and older-version inputs through Developer and verify rejection, observability and unchanged valid state.

Trade-offs and alternatives

Build a paved path with an escape hatch.

Benefit
Makes the ownership and interaction boundaries visible for a focused design review.
Cost
The 7 illustrated components still require contracts, monitoring and operational ownership; extra boundaries can add latency and failure modes.
Alternative
Use a simpler deployment when it meets the same requirements, or split a boundary only after measuring a specific need.

Logical boundaries versus deployment units in Internal developer platform architecture

Benefit
Keeps the responsibilities of Developer, Service catalog, Template workflow visible without requiring a separate server for each box.
Cost
A logical view does not establish isolation, independent scaling or high availability; those require a separate deployment design and operational tests.
Alternative
Co-locate components in a simpler deployment first when ownership and workload requirements permit it.

When to use this architecture

  • Explain internal developer platform architecture to engineers or stakeholders using a concrete visual flow.
  • Review this decision before deployment: Build a paved path with an escape hatch.
  • Adapt a starting diagram for your own requirements, then record and validate every changed boundary.

Key components

Developer
Developer participates in internal developer platform architecture. Developer → Service catalog. Define its contract, owner and access permissions in your implementation.
Service catalog
Service catalog participates in internal developer platform architecture. Developer → Service catalog; Service catalog → Template workflow; Service catalog → Documentation. Define its contract, owner and access permissions in your implementation.
Template workflow
Template workflow participates in internal developer platform architecture. Service catalog → Template workflow; Template workflow → Provisioning API. Define its contract, owner and access permissions in your implementation.
Provisioning API
Provisioning API participates in internal developer platform architecture. Template workflow → Provisioning API; Provisioning API → Runtime. Define its contract, owner and access permissions in your implementation.
Runtime
Runtime participates in internal developer platform architecture. Provisioning API → Runtime; Runtime → Observability. Define its contract, owner and access permissions in your implementation.
Documentation
Documentation participates in internal developer platform architecture. Service catalog → Documentation. Define its contract, owner and access permissions in your implementation.
Observability
Observability participates in internal developer platform architecture. Runtime → Observability. Define its contract, owner and access permissions in your implementation.

Questions about this template

What does this internal developer platform architecture diagram show?

It shows 7 components with the core flow Developer → Service catalog → Template workflow → Provisioning API → Runtime. Build a paved path with an escape hatch.

Can I edit this diagram without signing in?

Yes. Open the template in the browser-local canvas to change nodes, connections and source. AI generation and cloud account storage require sign-in.

Is this a complete production implementation?

No. It is an editable reference. Validate the security controls, dependency behavior, capacity and recovery plan against your own requirements before implementation.

Validate your implementation

Use the relevant platform documentation to verify service limits, supported features and configuration. This diagram is an original reference rather than a reproduction of a provider deployment.