Skip to content

Commit 189bcdb

Browse files
committed
docs(weather-agent): correct Step 3 to combined-sidecar (2/2) layout
Hai is right — on kagenti main, AuthBridge ships as a single combined sidecar image (kagenti-extensions#411). The weather-service pod is 2/2 regardless of SPIRE: spiffe-helper is bundled inside the combined image and activated per workload via SPIRE_ENABLED, not as a separate container. The deployment guide explicitly lists "1 combined sidecar" for both proxy-sidecar and envoy-sidecar modes (docs/authbridge/deployment-guide.md and charts/kagenti/values.yaml). The 3/3 separate-spiffe-helper layout I introduced in 8dacc17 described the pre-#411 / v0.6 model — wrong for main. Revert the container-count claim to 2/2 in both "Check pod status" and "Verify injected containers" sections, and update the explanatory note to match the combined-sidecar architecture. Container names returned by kubectl ... containers[*].name are 'agent authbridge-proxy' (proxy mode) or 'agent envoy-proxy' (envoy mode) regardless of SPIRE. Addresses huang195's review on PR #439. Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com> Signed-off-by: Mariusz Sabath <mrsabath@gmail.com>
1 parent 8dacc17 commit 189bcdb

1 file changed

Lines changed: 15 additions & 17 deletions

File tree

authbridge/demos/weather-agent/demo-ui.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -227,21 +227,22 @@ Wait for the Shipwright build to complete and the deployment to become ready.
227227
kubectl get pods -n team1
228228
```
229229
230-
Expected output (Step 2 defaults — `proxy-sidecar` mode with SPIRE identity enabled):
230+
Expected output (Step 2 defaults — `proxy-sidecar` mode):
231231
232232
```text
233233
NAME READY STATUS RESTARTS AGE
234-
weather-service-58768bdb67-xxxxx 3/3 Running 0 2m
234+
weather-service-58768bdb67-xxxxx 2/2 Running 0 2m
235235
weather-tool-7f8c9d6b44-yyyyy 1/1 Running 0 5m
236236
```
237237
238-
> **Note:** The container count depends on the AuthBridge mode and whether
239-
> SPIRE identity is enabled. With Step 2's defaults — `proxy-sidecar` mode
240-
> plus SPIRE identity — `weather-service` runs `agent` + `authbridge-proxy`
241-
> + `spiffe-helper` (`3/3`). If you unchecked **Enable SPIRE identity**, the
242-
> `spiffe-helper` container is absent (`2/2`). With `envoy-sidecar` mode
243-
> you'll see `agent` + `envoy-proxy` (plus a `proxy-init` init container)
244-
> instead of `authbridge-proxy`. See the
238+
> **Note:** AuthBridge ships as a single combined sidecar image (since
239+
> kagenti-extensions#411). `weather-service` runs `agent` + the combined
240+
> AuthBridge sidecar — `2/2` — regardless of whether SPIRE identity is
241+
> enabled. The `spiffe-helper` is bundled inside the combined image and
242+
> activated per workload via `SPIRE_ENABLED` (driven by the
243+
> `kagenti.io/spire: enabled` label); it is not a separate container. In
244+
> `envoy-sidecar` mode the pod is still `2/2` (`agent` + the combined
245+
> sidecar) plus a `proxy-init` init container for iptables setup. See the
245246
> [AuthBridge deployment guide](https://github.com/kagenti/kagenti/blob/main/docs/authbridge/deployment-guide.md)
246247
> for the full mode/label reference.
247248
@@ -251,24 +252,21 @@ weather-tool-7f8c9d6b44-yyyyy 1/1 Running 0 5m
251252
kubectl get pod -n team1 -l app.kubernetes.io/name=weather-service -o jsonpath='{.items[0].spec.containers[*].name}'
252253
```
253254
254-
Expected (Step 2 defaults — `proxy-sidecar` mode with SPIRE identity):
255-
256-
```text
257-
agent authbridge-proxy spiffe-helper
258-
```
259-
260-
Without SPIRE identity (Step 2 checkbox unchecked):
255+
Expected (Step 2 defaults — `proxy-sidecar` mode):
261256
262257
```text
263258
agent authbridge-proxy
264259
```
265260
266-
Or, in envoy-sidecar mode:
261+
Or, in `envoy-sidecar` mode:
267262
268263
```text
269264
agent envoy-proxy
270265
```
271266
267+
The container *names* don't change with SPIRE — `spiffe-helper` runs inside
268+
the combined sidecar, not as a separate container.
269+
272270
### Check operator-managed client registration
273271
274272
After kagenti-extensions#411 / kagenti-operator#361, client registration runs

0 commit comments

Comments
 (0)