From 5360502f2786553becc309593a257ffc1399f004 Mon Sep 17 00:00:00 2001 From: Rami Mohamed Date: Mon, 3 Aug 2026 20:58:39 +0400 Subject: [PATCH] docs: align config server with SIT profiles --- AGENTS.md | 6 +++--- README.md | 20 ++++++++++---------- src/main/resources/application.yml | 4 ++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 0e5bf9b..a5b026e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -32,9 +32,9 @@ helm lint helm --strict --values helm/values-sit.yaml ## Runtime Notes -- Default local endpoint: `http://localhost:8888` -- Local runtime config source is the `config-repo` repository. -- SIT and higher environments should use Git-backed configuration, not hardcoded local files. +- Default workstation endpoint: `http://localhost:8888` +- The runtime configuration source is the `config-repo` repository. +- Supported platform environments use Git-backed configuration; a workstation process is a debugging technique, not a separate environment. ## Dependency Notes diff --git a/README.md b/README.md index 83b27a5..82ff8b3 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,10 @@ The sibling `config-repo` repository contains configuration served to client ser ```text config-repo/ ├── application.yml -├── application-local.yml +├── application-sit.yml └── customer-service/ ├── customer-service.yml - └── customer-service-local.yml + └── customer-service-sit.yml ``` - `application.yml` contains defaults shared by all client services. @@ -67,7 +67,7 @@ kubectl config current-context helm version --short ``` -## Run Locally +## Run From A Workstation Clone `config-repo` beside this repository. The default local repository URI is `file:../config-repo`: @@ -116,22 +116,22 @@ Retrieve the default configuration for `customer-service`: curl --fail http://localhost:8888/customer-service/default ``` -Retrieve the local-profile configuration: +Retrieve the SIT configuration: ```bash -curl --fail http://localhost:8888/customer-service/local +curl --fail http://localhost:8888/customer-service/sit ``` -The local response combines configuration from: +The SIT response combines configuration from: ```text -config-repo/customer-service/customer-service-local.yml -config-repo/application-local.yml +config-repo/customer-service/customer-service-sit.yml +config-repo/application-sit.yml config-repo/customer-service/customer-service.yml config-repo/application.yml ``` -More specific profile and service configuration takes precedence over shared defaults. The response `version` identifies the exact `config-repo` Git commit used. +More specific profile and service configuration takes precedence over shared defaults. The response `version` identifies the exact `config-repo` Git commit used. Supported runtime profiles are `sit`, `uat`, and `prod`; `local` is not a platform environment. ## Run With Docker @@ -168,7 +168,7 @@ Verify the container and stop it: ```bash curl --fail http://localhost:8888/actuator/health -curl --fail http://localhost:8888/customer-service/local +curl --fail http://localhost:8888/customer-service/sit docker stop digital-bank-java-config-server test -n "$CONFIG_REPO_FIXTURE" && rm -rf "$CONFIG_REPO_FIXTURE" unset CONFIG_REPO_FIXTURE diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index ffe5db5..5e549a2 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -24,7 +24,7 @@ spring: repositories: config-repo: name: customer-service - profiles: local + profiles: sit label: "${CONFIG_REPO_DEFAULT_LABEL:main}" management: @@ -35,4 +35,4 @@ management: endpoint: health: probes: - enabled: true \ No newline at end of file + enabled: true