PHILO-HE commented on code in PR #10308: URL: https://github.com/apache/incubator-gluten/pull/10308#discussion_r2257557099
########## gluten-flink/docs/Flink.md: ########## @@ -91,24 +91,51 @@ Submit test script from `flink run`. You can use the `StreamSQLExample` as an ex ### Flink local cluster After deploying flink binaries, please add gluten-flink jar to flink library path, -including gluten-flink-runtime-1.4.0.jar, gluten-flink-loader-1.4.0.jar and Velox4j jars above. +including gluten-flink-runtime-1.5.0.jar, gluten-flink-loader-1.5.0.jar and Velox4j jars above. +Take following command as an example: Review Comment: Let's make it concise. Suggestion for the above: After deploying Flink binaries, please configure the paths of gluten-flink jars and the dependency jars for Flink to use, as follows: ########## gluten-flink/docs/Flink.md: ########## @@ -91,24 +91,51 @@ Submit test script from `flink run`. You can use the `StreamSQLExample` as an ex ### Flink local cluster After deploying flink binaries, please add gluten-flink jar to flink library path, -including gluten-flink-runtime-1.4.0.jar, gluten-flink-loader-1.4.0.jar and Velox4j jars above. +including gluten-flink-runtime-1.5.0.jar, gluten-flink-loader-1.5.0.jar and Velox4j jars above. +Take following command as an example: + +```shell +# notice: first set your own specified project home, you may set it mannualy in you .bash_profile so that it can auto take effect. Review Comment: Nit: break this long line into two. ########## gluten-flink/docs/Flink.md: ########## @@ -91,24 +91,51 @@ Submit test script from `flink run`. You can use the `StreamSQLExample` as an ex ### Flink local cluster After deploying flink binaries, please add gluten-flink jar to flink library path, -including gluten-flink-runtime-1.4.0.jar, gluten-flink-loader-1.4.0.jar and Velox4j jars above. +including gluten-flink-runtime-1.5.0.jar, gluten-flink-loader-1.5.0.jar and Velox4j jars above. +Take following command as an example: + +```shell +# notice: first set your own specified project home, you may set it mannualy in you .bash_profile so that it can auto take effect. +export VELOX4J_HOME= +export GLUTEN_FLINK_HOME= +export FLINK_HOME= + +cd $FLINK_HOME +mkdir -p gluten_lib +ln -s $VELOX4J_HOME/target/velox4j-0.1.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/velox4j-0.1.0-SNAPSHOT.jar +ln -s $GLUTEN_FLINK_HOME/runtime/target/gluten-flink-runtime-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-runtime-1.5.0.jar +ln -s $GLUTEN_FLINK_HOME/loader/target/gluten-flink-loader-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-loader-1.5.0.jar +``` + And make them loaded before flink libraries. + +#### How to make sure gluten packages loaded first in Flink? + +Gluten packages need to be loaded first in Flink, you can edit the `bin/config.sh` in Flink dir, +and change the `constructFlinkClassPath` function like this: Review Comment: Let's make it concise, suggestion: *** you can modify the `constructFlinkClassPath` function in `$FLINK_HOME/bin/config.sh` like this: ########## gluten-flink/docs/Flink.md: ########## @@ -82,7 +82,7 @@ mvn test ## Dependency library deployment You need to get the Velox4j packages and used them with gluten. -Velox4j jar available now is velox4j-0.1.0-SNAPSHOT.jar. +Velox4j jar available now is under velox4j project target/velox4j-0.1.0-SNAPSHOT.jar. Review Comment: This "Dependency library deployment" section looks unnecessary. The jar deployment is clear according to "Flink local cluster" section. I think we can remove the above section. ########## gluten-flink/docs/Flink.md: ########## @@ -91,24 +91,51 @@ Submit test script from `flink run`. You can use the `StreamSQLExample` as an ex ### Flink local cluster After deploying flink binaries, please add gluten-flink jar to flink library path, -including gluten-flink-runtime-1.4.0.jar, gluten-flink-loader-1.4.0.jar and Velox4j jars above. +including gluten-flink-runtime-1.5.0.jar, gluten-flink-loader-1.5.0.jar and Velox4j jars above. +Take following command as an example: + +```shell +# notice: first set your own specified project home, you may set it mannualy in you .bash_profile so that it can auto take effect. +export VELOX4J_HOME= +export GLUTEN_FLINK_HOME= +export FLINK_HOME= + +cd $FLINK_HOME +mkdir -p gluten_lib +ln -s $VELOX4J_HOME/target/velox4j-0.1.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/velox4j-0.1.0-SNAPSHOT.jar +ln -s $GLUTEN_FLINK_HOME/runtime/target/gluten-flink-runtime-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-runtime-1.5.0.jar +ln -s $GLUTEN_FLINK_HOME/loader/target/gluten-flink-loader-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-loader-1.5.0.jar +``` + And make them loaded before flink libraries. + +#### How to make sure gluten packages loaded first in Flink? + +Gluten packages need to be loaded first in Flink, you can edit the `bin/config.sh` in Flink dir, Review Comment: Ditto. Please also revise the trouble shooting doc. ########## gluten-flink/docs/Flink.md: ########## @@ -91,24 +91,51 @@ Submit test script from `flink run`. You can use the `StreamSQLExample` as an ex ### Flink local cluster After deploying flink binaries, please add gluten-flink jar to flink library path, -including gluten-flink-runtime-1.4.0.jar, gluten-flink-loader-1.4.0.jar and Velox4j jars above. +including gluten-flink-runtime-1.5.0.jar, gluten-flink-loader-1.5.0.jar and Velox4j jars above. +Take following command as an example: + +```shell +# notice: first set your own specified project home, you may set it mannualy in you .bash_profile so that it can auto take effect. +export VELOX4J_HOME= +export GLUTEN_FLINK_HOME= +export FLINK_HOME= + +cd $FLINK_HOME +mkdir -p gluten_lib +ln -s $VELOX4J_HOME/target/velox4j-0.1.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/velox4j-0.1.0-SNAPSHOT.jar +ln -s $GLUTEN_FLINK_HOME/runtime/target/gluten-flink-runtime-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-runtime-1.5.0.jar +ln -s $GLUTEN_FLINK_HOME/loader/target/gluten-flink-loader-1.5.0-SNAPSHOT.jar $FLINK_HOME/gluten_lib/gluten-flink-loader-1.5.0.jar +``` + And make them loaded before flink libraries. + +#### How to make sure gluten packages loaded first in Flink? Review Comment: packages -> classes -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
