Skip to content

Expand embedded server docs with standalone vs embedded trade-offs (GH-1203)#3249

Open
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-embedded-server-tradeoffs
Open

Expand embedded server docs with standalone vs embedded trade-offs (GH-1203)#3249
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-embedded-server-tradeoffs

Conversation

@won-seoop

Copy link
Copy Markdown

Summary

Closes GH-1203

The existing embedding.adoc page only explains how to embed the Config Server but says nothing about when you should choose embedded vs. standalone — which is exactly what the issue requested.

Changes

Added an [[embedded-vs-standalone]] section with a comparison table covering:

Concern Embedded Standalone
Operational overhead None Requires dedicated service
Git credential management Distributed (each app holds keys) Centralized
Encryption key management Distributed Centralized
Configuration drift Higher risk Lower risk
High availability Each app manages its own HA Config Server is a shared point of failure
Network round-trips Zero (in-process) Startup + refresh network calls
Security/access control No per-application isolation Can enforce per-app access control
Suitable for Monolith/single-app, local dev Microservices with many apps

Also added an [IMPORTANT] callout about secret distribution in multi-app embedded deployments.

Test plan

  • Verify AsciiDoc renders correctly
  • Check that the cross-reference to security.adoc resolves

🤖 Generated with Claude Code

…pring-cloudGH-1203)

Add an 'Embedded vs. Standalone' comparison table to embedding.adoc
documenting the key trade-offs between running the Config Server as
an embedded module vs. a standalone application:

- Operational overhead (none vs. separate service)
- Credential management (distributed vs. centralized)
- Encryption key management
- Configuration drift risk
- High availability characteristics
- Network overhead
- Security isolation and per-app access control
- Recommended use cases for each approach

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Spring cloud config embedded server documentation

2 participants