Skip to content

Commit 46931e4

Browse files
committed
docs: automate production catalog handoff
1 parent dd0cad5 commit 46931e4

4 files changed

Lines changed: 23 additions & 11 deletions

File tree

‎app/_how-tos/konnect-platform/konnect-reference-platform.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -282,17 +282,23 @@ to the owning service and promote a new artifact.
282282

283283
## Synchronize production Catalog state
284284

285-
After the production Gateway synchronization succeeds, manually dispatch the service's
286-
production Catalog workflow from the exact promoted commit. Protect the job
287-
with a production GitHub Environment and run:
285+
After the production Gateway synchronization succeeds, have the platform
286+
workflow read each changed provenance file and dispatch the owning service's
287+
production Catalog workflow with the exact promoted commit. Use a narrowly
288+
scoped GitHub App token for the cross-repository dispatch. Keep the service job
289+
behind its own production GitHub Environment so the Service Team approves the
290+
Catalog publication using its repository's Konnect identity:
288291

289292
```sh
290293
kongctl sync -f konnect/prod.yaml --base-dir . \
291294
--require-namespace <service>-prod
292295
```
293296

294-
This ordering ensures the governed runtime change exists before the service
295-
publishes its production Catalog state.
297+
The service workflow verifies that it checked out the requested commit before
298+
running kongctl. This ordering ensures the governed runtime change exists
299+
before the service publishes its production Catalog state. Keep manual
300+
workflow dispatch available as an explicit recovery path, not the normal
301+
release process.
296302

297303
## Scope deletion safely
298304

‎app/_landing_pages/konnect-reference-platform.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ rows:
147147
Main --> Promote[Open platform promotion PR]
148148
Promote --> Review[Platform review]
149149
Review --> Gateway[Aggregate production Gateway sync]
150-
Gateway --> Catalog[Approved production Catalog sync]
150+
Gateway --> Dispatch[Dispatch from provenance]
151+
Dispatch --> Catalog[Approved production Catalog sync]
151152
152153
- header:
153154
type: h2

‎app/konnect-reference-platform/apiops.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,11 @@ Production uses an explicit ownership boundary:
155155
4. The Platform Team reviews and merges the Gateway change.
156156
5. The platform workflow synchronizes all four production files in one kongctl
157157
`_deck` operation against `kongairlines-prod`.
158-
6. The Service Team manually dispatches its production Catalog synchronization from the
159-
exact promoted service commit.
160-
7. A protected GitHub Environment supplies production approval.
158+
6. After the Gateway synchronization succeeds, the platform workflow reads
159+
the changed provenance and dispatches the owning service's production
160+
Catalog workflow with the exact promoted commit.
161+
7. The Service Team approves its protected GitHub Environment, and the
162+
service-owned identity synchronizes the Catalog state.
161163

162164
<!--vale off -->
163165
{% mermaid %}
@@ -170,6 +172,7 @@ sequenceDiagram
170172
S->>P: Open promotion PR with provenance
171173
P->>P: Platform review
172174
P->>G: Aggregate kongctl sync with _deck
175+
P->>S: Dispatch Catalog sync from provenance
173176
S->>C: Approved kongctl sync from promoted commit
174177
{% endmermaid %}
175178
<!--vale on -->

‎app/konnect-reference-platform/faq.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,10 @@ assigns each existing account to its service team. The Platform Team owns the
132132
shared roles that repository accounts inherit. Issuing each service account
133133
token and storing it in the repository's development and protected production
134134
environments are human bootstrap steps. Production promotion uses a separate
135-
GitHub credential that can open a PR in the platform repository and is never
136-
exposed to fork jobs.
135+
GitHub App credential that can open a PR in the platform repository and
136+
dispatch the owning service's protected production Catalog workflow after the
137+
Gateway synchronization succeeds. It is never exposed to fork jobs and does
138+
not receive a service's Konnect token.
137139

138140
## What if a synchronization fails immediately after an RBAC change?
139141

0 commit comments

Comments
 (0)