Fork me on GitHub
Built by Maven

zookeeper:start

Full name:

net.revelc.code:zookeeper-maven-plugin:1.2.0:start

Description:

Starts a service which runs the ZooKeeper server.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<clientPort> int 1.0.0 The port on which to run the ZooKeeper server.
Default value is: 2181.
User property is: zmp.clientPort.
Alias is: clientPort.
<shutdownPort> int 1.0.0 The port on which to listen for the shutdown string.
Default value is: 52000.
User property is: zmp.shutdownPort.
Alias is: shutdownPort.
<shutdownString> String 1.0.0 The string which triggers a shutdown when received on the shutdown port.
Default value is: shutdown.
User property is: zmp.shutdownString.
Alias is: shutdownString.

Optional Parameters

Name Type Since Description
<clientPortAddress> String 1.0.0 The local address on which to run the ZooKeeper server. This also affects the shutdownPort.
Default value is: 127.0.0.1.
User property is: zmp.clientPortAddress.
Alias is: clientPortAddress.
<ignoreSkipITs> boolean 1.0.0 When set, this enables the plugin to ignore the skipITs property. By default, the plugin will not execute if the system property skipITs is set.
Default value is: false.
User property is: zmp.ignoreSkipITs.
Alias is: ignoreSkipITs.
<ignoreSkipTests> boolean 1.0.0 When set, this enables the plugin to ignore the skipTests property. By default, the plugin will not execute if the system property skipTests is set.
Default value is: false.
User property is: zmp.ignoreSkipTests.
Alias is: ignoreSkipTests.
<initLimit> int 1.0.0 The initLimit ZooKeeper option.
Default value is: 10.
User property is: zmp.initLimit.
Alias is: initLimit.
<jvmArgs> List 1.2.0 When set, this adds the configured JVM args to the Java command line. This can also be used to set Java system properties used by ZooKeeper to control its behavior, such as enabling 4lw commands or enabling the AdminServer (ZooKeeper defaults to enabling the AdminServer, but this plugin defaults to disabled; users can override the plugin's default and reenable it here).
Alias is: jvmArgs.
<keepPreviousState> boolean 1.1.0 Keep previous ZooKeeper data and state. Best used with non-default directory.
Default value is: false.
User property is: zmp.keepPreviousState.
Alias is: keepPreviousState.
<maxClientCnxns> int 1.0.0 The maximum number of concurrent client connections to ZooKeeper.
Default value is: 100.
User property is: zmp.maxClientCnxns.
Alias is: maxClientCnxns.
<skip> boolean 1.0.0 Allows skipping execution of this plugin.
Default value is: false.
User property is: zmp.skip.
Alias is: skip.
<syncLimit> int 1.0.0 The syncLimit ZooKeeper option.
Default value is: 5.
User property is: zmp.syncLimit.
Alias is: syncLimit.
<tickTime> int 1.0.0 The tickTime ZooKeeper option.
Default value is: 2000.
User property is: zmp.tickTime.
Alias is: tickTime.
<zmpDir> File 1.1.0 The directory to use to store plugin data and state.
Default value is: ${project.build.directory}/zmp.
User property is: zmp.directory.
Alias is: zmpDir.

Parameter Details

<clientPort>

The port on which to run the ZooKeeper server.
  • Type: int
  • Since: 1.0.0
  • Required: Yes
  • User Property: zmp.clientPort
  • Default: 2181
  • Alias: clientPort

<clientPortAddress>

The local address on which to run the ZooKeeper server. This also affects the shutdownPort.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.clientPortAddress
  • Default: 127.0.0.1
  • Alias: clientPortAddress

<ignoreSkipITs>

When set, this enables the plugin to ignore the skipITs property. By default, the plugin will not execute if the system property skipITs is set.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.ignoreSkipITs
  • Default: false
  • Alias: ignoreSkipITs

<ignoreSkipTests>

When set, this enables the plugin to ignore the skipTests property. By default, the plugin will not execute if the system property skipTests is set.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.ignoreSkipTests
  • Default: false
  • Alias: ignoreSkipTests

<initLimit>

The initLimit ZooKeeper option.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.initLimit
  • Default: 10
  • Alias: initLimit

<jvmArgs>

When set, this adds the configured JVM args to the Java command line. This can also be used to set Java system properties used by ZooKeeper to control its behavior, such as enabling 4lw commands or enabling the AdminServer (ZooKeeper defaults to enabling the AdminServer, but this plugin defaults to disabled; users can override the plugin's default and reenable it here).
  • Type: java.util.List
  • Since: 1.2.0
  • Required: No
  • Alias: jvmArgs

<keepPreviousState>

Keep previous ZooKeeper data and state. Best used with non-default directory.
  • Type: boolean
  • Since: 1.1.0
  • Required: No
  • User Property: zmp.keepPreviousState
  • Default: false
  • Alias: keepPreviousState

<maxClientCnxns>

The maximum number of concurrent client connections to ZooKeeper.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.maxClientCnxns
  • Default: 100
  • Alias: maxClientCnxns

<shutdownPort>

The port on which to listen for the shutdown string.
  • Type: int
  • Since: 1.0.0
  • Required: Yes
  • User Property: zmp.shutdownPort
  • Default: 52000
  • Alias: shutdownPort

<shutdownString>

The string which triggers a shutdown when received on the shutdown port.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: zmp.shutdownString
  • Default: shutdown
  • Alias: shutdownString

<skip>

Allows skipping execution of this plugin.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.skip
  • Default: false
  • Alias: skip

<syncLimit>

The syncLimit ZooKeeper option.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.syncLimit
  • Default: 5
  • Alias: syncLimit

<tickTime>

The tickTime ZooKeeper option.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: zmp.tickTime
  • Default: 2000
  • Alias: tickTime

<zmpDir>

The directory to use to store plugin data and state.
  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User Property: zmp.directory
  • Default: ${project.build.directory}/zmp
  • Alias: zmpDir