tzulitai commented on a change in pull request #63: [FLINK-16557][docs]
Document YAML-ized Kafka egresses / ingresses in …
URL: https://github.com/apache/flink-statefun/pull/63#discussion_r396062901
##########
File path: statefun-docs/docs/io_module/index.rst
##########
@@ -32,70 +32,115 @@ Based on the concept of Ingress (input) and Egress
(output) points, and built on
.. _ingress:
Ingress
-^^^^^^^^
+=======
An Ingress is an input point where data is consumed from an external system
and forwarded to zero or more functions.
-An ``IngressIdentifier`` and an ``IngressSpec`` define it.
+It is defined via an ``IngressIdentifier`` and an ``IngressSpec``.
An ingress identifier, similar to a function type, uniquely identifies an
ingress by specifying its input type, a namespace, and a name.
-.. literalinclude::
../../src/main/java/org/apache/flink/statefun/docs/io/ingress/Identifiers.java
- :language: java
- :lines: 18-
+The spec defines the details of how to connect to the external system, which
is specific to each individual I/O module. Each identifier-spec pair is bound
to the system inside an stateful function module.
-The spec defines the details of how to connect to the external system, which
is specific to each individual I/O module.
-Each identifier-spec pair is bound to the system inside an stateful function
module.
+.. tabs::
-.. literalinclude::
../../src/main/java/org/apache/flink/statefun/docs/io/ingress/ModuleWithIngress.java
- :language: java
- :lines: 18-
+ .. group-tab:: Java
+
+ .. literalinclude::
../../src/main/java/org/apache/flink/statefun/docs/io/ingress/Identifiers.java
+ :language: java
+ :lines: 18-
+
+ .. literalinclude::
../../src/main/java/org/apache/flink/statefun/docs/io/ingress/ModuleWithIngress.java
+ :language: java
+ :lines: 18-
+
+ .. group-tab:: Yaml
+
+ .. code-block:: Yaml
+
+ version: "1.0"
+
+ module:
+ meta:
+ type: remote
+ spec:
+ ingresses:
+ - ingress:
Review comment:
Indentation seems a bit off here:
```suggestion
ingresses:
- ingress:
```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
