[SAMZA-1118] Deprecate the SystemStream configurations in favor of StreamId

• Type: Task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 0.13.0
• Fix Version/s: 0.15.0
• Assignee: Jake Maes
• Reporter: Jake Maes
• Created: 04/Mar/17 00:57
• Updated: 12/Jan/18 19:26

Description

SAMZA-1096 introduced a new config namespace to set properties on a stream:
streams.

{streamId}

.X
which is meant to replace the legacy way to set stream properties:
systems.

{systemName}

.streams.

{streamName}

.X

In the past, streamName was used as both:
1. a logical identifier in samza. e.g. to look up stream properties in the config
2. a physical identifier in the System e.g. as the topic name for Kafka

StreamId and physicalName represent the separation of those two roles and provide the following benefits:

1. StreamId is now a single unique identifier for a stream. A streams ID is no longer coupled to a System, so it's more portable and less verbose.
2. A streamID does not allow special characters so we can guarantee config parsing, etc. Whereas physicalName does, and that enables physical identifiers that have special characters like an HDFS file URN

This task is to deprecate and remove the old configs from documentation. It also involves switching all the code to use streamId to identify a stream, rather than SystemStream, so not trivial.

Issue Links

• is depended upon by: SAMZA-1041 Multi-stage feature for Samza
• is depended upon by: SAMZA-1159 Move StreamSpec from a public API to an ApplicationRunner internal API