confd:prepare

Full name:

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

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
templates List -

A list of TemplateConfig elements.

A TemplateConfig element mimics the content of a confd TOML file (see https://github.com/kelseyhightower/confd/blob/master/docs/quick-start-guide.md#create-a-template-resource-config) so you can specify the src of the template to parse (src), the destination (dest) and a list of keys (full list of main namespaces) that are needed by the template.

<templates>
  <template>
    <id>application.yml</id>
    <src>src/main/confd/templates/application.yml.tmpl</src>
    <dest>${project.basedir}/target/generated-configuration/application.yml</dest>
    <keys>
      <value>/your/namespace</value>
      <value>/runtime</value>
    </keys>
  </template>
</templates>



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

Optional Parameters

Name Type Since Description
forceDestToLocalFileSystemType boolean -

by default, the dest param is a String that will be preserved as-is. If you set forceDestToLocalFileSystemType to true, then it will be transformed as a valid path according to the OS where the current build is running (for instance, /a/unix/path will be transformed in \\a\\unix\\path under windows)

The typical usage will be to set forceDestToLocalFileSystemType to true if you have a population of developers that work with more than one operating systems (eg: Windows, Mac and Linux, typically in the context of an OSS project) and to set it to false when you want to generate a non-local target configuration (the target directory written into the confd toml file is then independent of the OS of the people collaborating on the project)


Default value is: false.
User property is: confd.forceDestToLocalFileSystemType.
skipPrepare boolean - Set skipPrepare to true on the command line if you want to disable the prepare goal
Default value is: false.
User property is: confd.skipPrepare.

Parameter Details

forceDestToLocalFileSystemType:

by default, the dest param is a String that will be preserved as-is. If you set forceDestToLocalFileSystemType to true, then it will be transformed as a valid path according to the OS where the current build is running (for instance, /a/unix/path will be transformed in \\a\\unix\\path under windows)

The typical usage will be to set forceDestToLocalFileSystemType to true if you have a population of developers that work with more than one operating systems (eg: Windows, Mac and Linux, typically in the context of an OSS project) and to set it to false when you want to generate a non-local target configuration (the target directory written into the confd toml file is then independent of the OS of the people collaborating on the project)

  • Type: boolean
  • Required: No
  • User Property: confd.forceDestToLocalFileSystemType
  • Default: false

skipPrepare:

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

templates:

A list of TemplateConfig elements.

A TemplateConfig element mimics the content of a confd TOML file (see https://github.com/kelseyhightower/confd/blob/master/docs/quick-start-guide.md#create-a-template-resource-config) so you can specify the src of the template to parse (src), the destination (dest) and a list of keys (full list of main namespaces) that are needed by the template.

<templates>
  <template>
    <id>application.yml</id>
    <src>src/main/confd/templates/application.yml.tmpl</src>
    <dest>${project.basedir}/target/generated-configuration/application.yml</dest>
    <keys>
      <value>/your/namespace</value>
      <value>/runtime</value>
    </keys>
  </template>
</templates>


  • Type: java.util.List
  • Required: Yes

workingDirectory:

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