ep:start-nodes

Full name:

com.tibco.ep:ep-maven-plugin:2.2.1:start-nodes

Description:

Install and start nodes.

Nodes are installed one at a time but started in parallel.

If a node directory already exists, stop and remove nodes is called first. If the directory still exists, it is deleted.

Example use in pom.xml:

pom

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
<buildtype> BaseExecuteMojo$BuldType 1.0.0

Build type - DEVELOPMENT or PRODUCTION

Determines build type to use when installing nodes and deploying applications.

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: build
<clusterName> String 1.0.0

cluster name to append to the node names.

Nodes are started with a service name obtained by concatenating the node names and the cluster name. For example with a node name of A plus a cluster name of test results in a service name of A.test.

Example use in pom.xml:

pom
Default: ${project.artifactId}
<discoveryHosts> String[] 1.0.0

List of host names for the client discovery.

This is used on each administration client invocation.

Example use in pom.xml:

pom
<discoveryPort> Integer 1.0.0

Port number for discovery. If not set a random free port is selected and persisted to a file

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: discoveryPort
<discoveryPortFile> File 1.0.0

Filename to be used to store generated discovery port

Example use in pom.xml:

pom
Default: ${project.build.directory}/discovery.port
<environmentVariables> Map<String,String> 1.0.0

Environment variables - these environment variables are passed through to created processes.

Example use in pom.xml:

pom

Example use on commandline:

pom

User property is: environmentVariables.

<ignoreLeaks> String[] 1.3.0

List of class names to ignore in leak detection. This is processed to a CSV value to include in unit testing and in jar manifest file.

Example use in pom.xml:

pom
<installArguments> Map<String,String> 1.0.0

Additional parameters supported by install node.

Example use in pom.xml:

pom

Example use on commandline:

pom

User property is: installArguments.

<installOnly> boolean 1.1.0

Set this to 'true' to only install nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: installOnly
<nodeDeployFile> File 1.0.0

Node deployment HOCON file. Applicable for packaging type ep-application only

Example use in pom.xml:

pom
<nodeDirectory> File 1.0.0

Base directory of test nodes.

Example use in pom.xml:

pom
Default: ${project.build.directory}/test-nodes
<nodes> String[] 1.0.0

List of node names to start ready for test cases to run. If not set, a single node A is used.

Example use in pom.xml:

pom
<password> String 1.0.0

Password

Example use in pom.xml:

pom
<productHome> File 1.0.0

Product home location. This path is resolved in the following way :

  • If property com.tibco.ep.ep-maven.product is set, use that, else
  • If environment variable TIBCO_EP_HOME is set, use that, else
  • Use localrepository/../product-group/product-artifact/product-version (so default is ~/.m2/product-group/product-artifact/product-version)

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: com.tibco.ep.ep-maven.product
<skipInstall> boolean 1.1.0

Set this to 'true' to skip installing test nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: skipInstall
<skipStart> boolean 1.0.0

Set this to 'true' to skip starting test nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: skipStart
<skipTests> boolean 1.0.0

Set this to 'true' to skip running tests, but still compile them.

Example use in pom.xml:

pom

Example use on commandline:

pom
User Property: skipTests
<startArguments> Map<String,String> 1.3.0

Additional parameters supported by start node.

Example use on commandline:

pom
<userName> String 1.0.0

User name. If not set authentication is by platform credentials

Example use in pom.xml:

pom

Parameter Details

<buildtype>

Build type - DEVELOPMENT or PRODUCTION

Determines build type to use when installing nodes and deploying applications.

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: com.tibco.ep.buildmavenplugin.BaseExecuteMojo$BuldType
  • Since: 1.0.0
  • Required: No
  • User Property: build

<clusterName>

cluster name to append to the node names.

Nodes are started with a service name obtained by concatenating the node names and the cluster name. For example with a node name of A plus a cluster name of test results in a service name of A.test.

Example use in pom.xml:

pom
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • Default: ${project.artifactId}

<discoveryHosts>

List of host names for the client discovery.

This is used on each administration client invocation.

Example use in pom.xml:

pom
  • Type: java.lang.String[]
  • Since: 1.0.0
  • Required: No

<discoveryPort>

Port number for discovery. If not set a random free port is selected and persisted to a file

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: java.lang.Integer
  • Since: 1.0.0
  • Required: No
  • User Property: discoveryPort

<discoveryPortFile>

Filename to be used to store generated discovery port

Example use in pom.xml:

pom
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • Default: ${project.build.directory}/discovery.port

<environmentVariables>

Environment variables - these environment variables are passed through to created processes.

Example use in pom.xml:

pom

Example use on commandline:

pom

User property is: environmentVariables.

  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.0.0
  • Required: No

<ignoreLeaks>

List of class names to ignore in leak detection. This is processed to a CSV value to include in unit testing and in jar manifest file.

Example use in pom.xml:

pom
  • Type: java.lang.String[]
  • Since: 1.3.0
  • Required: No

<installArguments>

Additional parameters supported by install node.

Example use in pom.xml:

pom

Example use on commandline:

pom

User property is: installArguments.

  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.0.0
  • Required: No

<installOnly>

Set this to 'true' to only install nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: installOnly

<nodeDeployFile>

Node deployment HOCON file. Applicable for packaging type ep-application only

Example use in pom.xml:

pom
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No

<nodeDirectory>

Base directory of test nodes.

Example use in pom.xml:

pom
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • Default: ${project.build.directory}/test-nodes

<nodes>

List of node names to start ready for test cases to run. If not set, a single node A is used.

Example use in pom.xml:

pom
  • Type: java.lang.String[]
  • Since: 1.0.0
  • Required: No

<password>

Password

Example use in pom.xml:

pom
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No

<productHome>

Product home location. This path is resolved in the following way :

  • If property com.tibco.ep.ep-maven.product is set, use that, else
  • If environment variable TIBCO_EP_HOME is set, use that, else
  • Use localrepository/../product-group/product-artifact/product-version (so default is ~/.m2/product-group/product-artifact/product-version)

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User Property: com.tibco.ep.ep-maven.product

<skipInstall>

Set this to 'true' to skip installing test nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: skipInstall

<skipStart>

Set this to 'true' to skip starting test nodes

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: skipStart

<skipTests>

Set this to 'true' to skip running tests, but still compile them.

Example use in pom.xml:

pom

Example use on commandline:

pom
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: skipTests

<startArguments>

Additional parameters supported by start node.

Example use on commandline:

pom
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.3.0
  • Required: No

<userName>

User name. If not set authentication is by platform credentials

Example use in pom.xml:

pom
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No