wenjin272 opened a new issue, #1234: URL: https://github.com/apache/flink-agents/issues/1234
Parent: #1225 ### Problem and scope Operations guidance defines consistency concepts but does not turn them into a clear selection/configuration workflow. Configuration reference mixes unrelated options with long feature tutorials and state-format internals. #### Scope - [ ] Add a concise decision table for no checkpoint consistency, checkpointed output consistency with repeatable external calls, and action consistency with an Action State Store. Give complete required setup steps and links, explain external storage/operations costs, and accurately state side-effect/reconciliation guarantees. - [ ] State normal requirements, such as a dedicated Kafka topic/Fluss table per logical Agent operator, in the main text. Reserve warnings for risks and unexpected restrictions, including digest-versus-encryption implications. - [ ] Establish the supported upgrade/recovery guidance from the agreed product/API compatibility contract: Flink Agents/Flink versions, key/serializer changes, Action naming, user-code changes, and incompatible-state detection. Do not infer compatibility solely from unchanged Action names. - [ ] Move release-specific state-format changes into migration/release notes and keep the evergreen guide focused on supported operations and consequences. - [ ] Group configuration options by user task (observability, condition handling, model/tool calls and retries, runtime/async, memory, action consistency), sorting keys within groups. Retain types/defaults/stable constraints and feature links. - [ ] Move checkpoint-aligned Kafka cleanup guidance, initial enablement, and migration steps from Configuration to Consistency/Action State Store; retain short option descriptions and links in the reference. #### Coordination and acceptance Can start independently of the authoring-page restructuring. Coordinate deployment language with #1227 and option semantics with #1229, #1231, and Improve Metrics and Logging user documentation. The Action State Store compatibility contract is a prerequisite only for finalizing upgrade/reuse claims. Track that product/API decision under #1055 if no dedicated issue exists; documentation edits do not decide supported compatibility. Other guide/reference improvements can proceed. Verify configuration names/defaults, actionable setup examples, migration placement, and reciprocal links. Document the actual consistency guarantees and required user responsibilities without overpromising exactly-once external effects. #### Review coverage DOC-052, DOC-053, DOC-054, DOC-055, DOC-056. These are traceability identifiers; the full actionable scope is described above. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
