Repository navigation
docs: network adapter deployment modes -- ADR-0001, READMEs, CHANGELOGs, Postman (#55, #66) - #89
Open
kelvinprabhu wants to merge 10 commits into
Open
kelvinprabhu wants to merge 10 commits into
kelvinprabhu wants to merge 10 commits into
Conversation
…Gs, Postman (#55, #66) - docs/adr: ADR template, index, and ADR-0001 (single and multi deployment modes on role network), with implementation notes holding the reasoning that code comments no longer carry. - charts/adapter-service: README (modes, multi-mode guide) and CHANGELOG 0.6.0. - charts/openbao-secrets: CHANGELOG 0.1.1. - quick-start/README.md: modes, switching, upgrade and multi notes. - api-collection: Postman environment for the local adapter ports. Companion to #87 (Helm) and #88 (quick-start).
kelvinprabhu
commented
Oct 22, 2026
- charts/adapter-service/SETUP.md: guidelines, then single and multi steps (Secrets, install, check), the openbao-secrets changes multi needs, switching, and a symptom table. Steps verified on k3d. - charts/adapter-service/README.md rewritten short: roles, modes, the three values the render really requires, the identity Secret, key rotation; install steps live in SETUP.md. - quick-start/README.md: "Two modes" rewritten as guidelines; single-mode log checks; publish example on 9201 (multi: 9200). - CHANGELOG and ADR-0001 follow #87 and #88: networkTierKeys with default Secret names, lint-values back to role network, the single template is an exact copy of the tier modules.
kelvinprabhu
commented
Oct 22, 2026
kelvinprabhu
left a comment
kelvinprabhu
left a comment
Collaborator
Author
There was a problem hiding this comment.
Self Reviewed @manjudr
…med (#55, #66) - SETUP.md: the network release is one command in both modes; only --set networkAdapterDeploymentMode=single|multi changes. Install, multi and multi-to-single steps use examples/network.yaml. quick-start: MODE=single|multi make up. - README and CHANGELOG: examples/network.yaml serves both modes; networkTierKeys.upstreamSecret (default provider-upstream). - quick-start/README.md: MODE=single|multi make up in the modes table. - ADR-0001: the probe keys were renamed because common.probes never read probes.liveness/readiness, so no adapter pod had probes. Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
…#55, #66) Follows the #87 and #88 review fixes: - Roles consumer-adapter / network-adapter / provider-adapter (old names still work), deploymentMode single-adapter | multi-adapter, adapterKeys. - Chart configs under config/single-adapter/ and config/multi-adapter/; quick-start templates under config/adapters/single-adapter/ and multi-adapter/. - Module names consumer-adapter, network-adapter, oanProvider, oanProviderPublish. - quick-start: make up / make up-core, MODE=multi for multi. Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
#66) - SETUP.md, README and the 0.6.0 CHANGELOG use examples/consumer-adapter.yaml, network-adapter.yaml and provider-adapter.yaml (#87). - quick-start README: routing files live in config/adapters/multi-adapter/ and single-adapter/ (#88). Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
#66) From the code review: - quick-start reset deletes only the rendered configs; the routing files now in config/adapters/{multi,single}-adapter/ are tracked and must stay. - ADR-0001: the rejected alternative is a separate Helm role; the chosen role-plus-mode design's upgrade cost is stated, matching the CHANGELOG. Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
…er (#55, #66) Follows #88: MODE=multi-adapter make up, NETWORK_ADAPTER_DEPLOYMENT_MODE= single-adapter and profile multi-adapter in the quick-start README, SETUP.md and ADR-0001. Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
The quick-start reads only NETWORK_ADAPTER_DEPLOYMENT_MODE now; the examples in the README, SETUP.md and ADR-0001 use it. Refs: #55, #66, OpenAgriNet/network-adapter#55, OpenAgriNet/engineering-tracker#171
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #55, #66 · Refs OpenAgriNet/network-adapter#55 · Parent: OpenAgriNet/engineering-tracker#171
Objective
Document the single and multi deployment modes so anyone can set up and switch between them.
Solution
charts/adapter-service/SETUP.md: guidelines, Secrets, install and switching for both modes, verified on k3d.Merge with or after #87 (Helm) and #88 (docker compose).