Chapter 30. Installing and configuring Smart Router

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.12
2. Download Red Hat Process Automation Manager 7.12.0 Add-Ons.
3. Extract the downloaded rhpam-7.12.0-add-ons.zip file to a temporary directory. The rhpam-7.12.0-smart-router.jar file is in the extracted rhpam-7.12.0-add-ons directory.
4. Copy the rhpam-7.12.0-smart-router.jar file to the location where you will run the file.

5. Enter the following command to start Smart Router:

   java
   -Dorg.kie.server.router.host=<ROUTER_HOST>
   -Dorg.kie.server.router.port=<ROUTER_PORT>
   -Dorg.kie.server.controller=<CONTROLLER_URL>
   -Dorg.kie.server.controller.user=<CONTROLLER_USER>
   -Dorg.kie.server.controller.pwd=<CONTROLLER_PWD>
   -Dorg.kie.server.router.config.watcher.enabled=true
   -Dorg.kie.server.router.repo=<NFS_STORAGE>
   -jar rhpam-7.12.0-smart-router.jar

   The properties in the preceding command have the following default values:

   org.kie.server.router.host=localhost
   org.kie.server.router.port=9000
   org.kie.server.controller= N/A
   org.kie.server.controller.user=kieserver
   org.kie.server.controller.pwd=kieserver1!
   org.kie.server.router.repo= <CURRENT_WORKING_DIR>
   org.kie.server.router.config.watcher.enabled=false

   org.kie.server.controller is the URL of the server controller, for example:

   org.kie.server.controller=http://<HOST>:<PORT>/controller/rest/controller

   org.kie.server.router.config.watcher.enabled is an optional settings to enable the watcher service system property.

   Note

   Instead of specifying configuration properties in the command line, you can use a configuration file. For information about configuring Smart Router using a file, see Section 30.5, “Configuring Smart Router settings using a configuration file”.

6. On every KIE Server instance that must connect to the Smart Router, set the org.kie.server.router system property to the Smart Router URL.

7. To access Smart Router from the client side, use the Smart Router URL instead of the KIE Server URL, for example:

   KieServicesConfiguration config = KieServicesFactory.newRestConfiguration("http://smartrouter.example.com:9000", "USERNAME", "PASSWORD");

   In this example, smartrouter.example.com is the Smart Router URL, and USERNAME and PASSWORD are the log in credentials for the Smart Router configuration.

8. To create a new container in an umanaged KIE Server so that you can fill it with example data, send the following HTTP request:

   $ curl -v -X POST -H 'Content-type: application/xml' -H 'X-KIE-Content-Type: xstream' -d @create-container.xml -u ${KIE_CRED} http://${KIE-SERVER-HOST}:${KIE-SERVER-PORT}/kie-server/services/rest/server/config/

9. Review the contents the create-container.xml file:

   <script>
     <create-container>
       <container container-id="example:timer-test:1.1">
         <release-id>
           <group-id>example</group-id>
           <artifact-id>timer-test</artifact-id>
           <version>1.1</version>
         </release-id>
         <config-items>
           <itemName>RuntimeStrategy</itemName>
           <itemValue>PER_PROCESS_INSTANCE</itemValue>
           <itemType></itemType>
         </config-items>
       </container>
     </create-container>
   </script>

   A message about the deployed container is displayed in the Smart Router console. For example:

   INFO: Added http://localhost:8180/kie-server/services/rest/server as server location for container example:timer-test:1.1

10. To display a list of containers, enter the following command:

    $ curl http://localhost:9000/mgmt/list

    The list of containers is displayed:

    {
      "containerInfo": [{
        "alias": "timer-test",
        "containerId": "example:timer-test:1.1",
        "releaseId": "example:timer-test:1.1"
      }],
      "containers": [
        {"example:timer-test:1.1": ["http://localhost:8180/kie-server/services/rest/server"]},
        {"timer-test": ["http://localhost:8180/kie-server/services/rest/server"]}
      ],
      "servers": [
        {"kieserver2": []},
        {"kieserver1": ["http://localhost:8180/kie-server/services/rest/server"]}
      ]
    }

11. To initiate a process using the Smart Router URL, enter the following command:

    $ curl -s -X POST -H 'Content-type: application/json' -H 'X-KIE-Content-Type: json' -d '{"timerDuration":"9s"}' -u kieserver:kieserver1! http://localhost:9000/containers/example:timer-test:1.1/processes/timer-test.TimerProcess/instances

Procedure

1. Create a configuration file. This file can contain any number of lines in the property=value format.

   The file can include any of the following properties. All of the properties are optional.

   Expand

   Table 30.2. Supported properties in the Smart Router configuration file

   Property name	Description	Default value
   org.kie.server.router.id	Identifier of the Smart Router, for identification to other components.	N/A
   org.kie.server.router.name	Name of the Smart Router, for identification to other components.	N/A
   org.kie.server.router.host	The host name for the machine that runs the Smart Router	localhost
   org.kie.server.router.port	The port for incoming HTTP connections. If you configure TLS connections, you can set this property to 0 to disable HTTP connections.	9000
   org.kie.server.router.url.external	The external URL for access to the Smart Router	N/A
   org.kie.server.router.tls.port	The port for incoming TLS connections	N/A
   org.kie.server.router.tls.keystore	The keystore file for TLS connections	N/A
   org.kie.server.router.tls.keystore.password	The password for the keystore for TLS connections	N/A
   org.kie.server.router.tls.keystore.keyalias	The alias name that refers to the TLS certificate in the keystore	N/A
   org.kie.server.router.repo	The directory for storing the current repository	The current working directory
   org.kie.router.identity.provider	The optional custom provider class for authenticating KIE Server instances with Smart Router. This class must implement the org.kie.server.router.identity.IdentityManager interface, For the source code of this interface, see the GitHub repository.	N/A
   org.kie.server.controller	The URL for connecting to the controller	N/A
   org.kie.server.controller.user	The user name for connecting to the controller	kieserver
   org.kie.server.controller.pwd	The password for connecting to the controller	kieserver1!
   org.kie.server.controller.token	The authentication token for connecting to the controller	N/A
   org.kie.server.controller.retry.interval	The interval, in seconds, for retrying connection to the controller if it failed	10
   org.kie.server.controller.retry.limit	The maximum number of retries for connection to the controller if it failed	infinite
   org.kie.server.router.config.watcher.enabled	If set to true, Smart Router periodically scans the configuration file and applies any changes	false
   org.kie.server.router.config.watcher.interval	The interval, in seconds, for rescanning the configuration file	5
   org.kie.server.router.management.password	If set to true, Smart Router requires a password to authenticate a connection from KIE Server	false

   Show more

2. Start Smart Router using the following command line:

   java -Dorg.kie.server.router.config.file=<CONFIG_FILE> -jar rhpam-7.12.0-smart-router.jar

   Replace <CONFIG_FILE> with the name of the configuration file.