yaooqinn commented on code in PR #3178: URL: https://github.com/apache/incubator-kyuubi/pull/3178#discussion_r936413494
########## docs/extensions/server/applications.rst: ########## @@ -20,5 +20,97 @@ Manage Applications against Extra Cluster Managers .. caution:: unstable -.. warning:: - This page is still in-progress. +Build A Custom Application Operation +--------------------- + +Kyuubi supports configuring custom ``ApplicationOperation`` for certain extra cluster manager which provides an ability to control application, including getting information, killing. + +The steps of adding a custom Application Operation +------------------------------------------------------- + +1. reference kyuubi-server + + .. code-block:: xml + + <dependency> + <groupId>org.apache.kyuubi</groupId> + <artifactId>kyuubi-server_2.12</artifactId> + <version>1.5.2-incubating</version> + <scope>provided</scope> + </dependency> + +2. create a custom class which implements the ``org.apache.kyuubi.engine.ApplicationOperation``. + +.. note:: Kyuubi uses Java SPI to load the custom Application Operation + +3. create a directory META-INF.services and a file with the fully-qualified name of the interface ``ApplicationOperation``: + + .. code-block:: java + + META-INF.services/org.apache.kyuubi.engine.ApplicationOperation + + then add your fully-qualified name of custom application operation into the file. + +4. compile and put the jar into ``$KYUUBI_HOME/jars`` + + .. code-block:: scala Review Comment: we used to put this the part of feature desc. -- 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]
