[ISSUE-3114][Improve] Improve streampark-testcontainer module based o…

…n [3.7 Code Comments Rule]
apache · Oct 10, 2023 · 3f4b451 · 3f4b451
1 parent 1f35c80
commit 3f4b451
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/...testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java b/...testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkComponent.java
@@ -19,8 +19,10 @@
 
 import javax.annotation.Nonnull;
 
+/** The enum is used to represent the type of the flink component. */
 enum FlinkComponent {
   JOBMANAGER("jobmanager"),
+
   TASKMANAGER("taskmanager");
 
   private final String name;

diff --git a/...testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java b/...testcontainer/src/main/java/org/apache/streampark/testcontainer/flink/FlinkContainer.java
@@ -31,6 +31,10 @@
 import static org.apache.streampark.testcontainer.flink.FlinkComponent.JOBMANAGER;
 import static org.apache.streampark.testcontainer.flink.FlinkComponent.TASKMANAGER;
 
+/**
+ * The Flink container class. It would be created as a flink jobmanager container or a taskmanaager
+ * container. Note: It's an internal class to construct a flink session cluster.
+ */
 class FlinkContainer extends GenericContainer<FlinkContainer> {
 
   public static final AtomicInteger TM_INDEX_SUFFIX = new AtomicInteger(0);

diff --git a/...rc/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java b/...rc/main/java/org/apache/streampark/testcontainer/flink/FlinkStandaloneSessionCluster.java
@@ -37,9 +37,9 @@
 import static org.apache.streampark.testcontainer.flink.FlinkComponent.TASKMANAGER;
 
 /**
- * Class to start a couple of flink 1-jobmanager & n-taskmanagers. The priority of flinkYamlConfStr
- * is the highest. But: The 'jobmanager.rpc.address' is always 'jobmanager'. The 'rest.port' always
- * is 8081.
+ * Class to start a couple of flink 1-jobmanager & n-taskmanagers. The priority of
+ * flinkYamlConfContent is the highest. But: The 'jobmanager.rpc.address' is always 'jobmanager'.
+ * The 'rest.port' always is 8081.
  */
 public class FlinkStandaloneSessionCluster implements Startable {
 
@@ -135,6 +135,7 @@ private void renderJmRpcConfIfNeeded(@Nullable String yamlConfStr) {
                 : String.format("%s\n%s\n", this.yamlConfContent, yamlConfStr));
   }
 
+  /** A tool class to create a flink standalone session cluster quickly. */
   public static class Builder {
 
     private DockerImageName dockerImageName =