confd:process

Full name:

com.github.nodevops:confd-maven-plugin:0.1.0-SNAPSHOT:process

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-resources.

Required Parameters

Name Type Since Description
dictionary File - The path to the file containing a list of key/value that are referenced in the templates
processor ProcessorConfig -

The confd processor to use.

Can be either "local-confd-processor" to use a local confd binary, or "java-processor" to use a very simple confd compatible parser written in java.

Two processors are supported for the moment: the java-processor that takes no extra parameter

<processor>
  <name>java-processor</name>
</processor>

and the local-confd-processor that takes a single parameter binary.path used to specify where the confd binary can be found

<processor>
  <name>local-confd-processor</name>
  <properties>
    <property>
      <name>binary.path</name>
      <value>/path/to/confd</value>
    </property>
  </properties>
</processor>



workingDirectory File - The output directory into which the resources will be copied.
Default value is: ${project.basedir}/target/confd.

Optional Parameters

Name Type Since Description
encoding String - The character encoding scheme to be applied when filtering resources.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
mkdirs boolean - If true (default), the plugin will create directories if needed in order to be able to create the target files
Default value is: true.
User property is: confd.mkdirs.
skipProcess boolean - Set skipProcess to true on the command line if you want to disable the process goal
Default value is: false.
User property is: confd.skipProcess.

Parameter Details

dictionary:

The path to the file containing a list of key/value that are referenced in the templates
  • Type: java.io.File
  • Required: Yes

encoding:

The character encoding scheme to be applied when filtering resources.
  • Type: java.lang.String
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

mkdirs:

If true (default), the plugin will create directories if needed in order to be able to create the target files
  • Type: boolean
  • Required: No
  • User Property: confd.mkdirs
  • Default: true

processor:

The confd processor to use.

Can be either "local-confd-processor" to use a local confd binary, or "java-processor" to use a very simple confd compatible parser written in java.

Two processors are supported for the moment: the java-processor that takes no extra parameter

<processor>
  <name>java-processor</name>
</processor>

and the local-confd-processor that takes a single parameter binary.path used to specify where the confd binary can be found

<processor>
  <name>local-confd-processor</name>
  <properties>
    <property>
      <name>binary.path</name>
      <value>/path/to/confd</value>
    </property>
  </properties>
</processor>


  • Type: com.github.nodevops.confd.maven.plugin.model.ProcessorConfig
  • Required: Yes

skipProcess:

Set skipProcess to true on the command line if you want to disable the process goal
  • Type: boolean
  • Required: No
  • User Property: confd.skipProcess
  • Default: false

workingDirectory:

The output directory into which the resources will be copied.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.basedir}/target/confd