Post

1 follower Follow
0
Avatar

deployit-defaults.properties

Why is everything commented out in the deployit-defaults.properties file? When we change a default, do we need to uncomment it?

 

Example

...

The order of the step in the step list for the noop operation. (inherited from: generic.CopiedArtifact.noopOrder)

#www.PublishedWebContent.noopOrder=50

Noop Verb (inherited from: generic.CopiedArtifact.noopVerb)

#www.PublishedWebContent.noopVerb=Modify

if true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation). (inherited from: generic.CopiedArtifact.preserveExistingFiles)

#www.PublishedWebContent.preserveExistingFiles=false

...

Bernie Durfee Answered

Please sign in to leave a comment.

4 comments

0
Avatar

Hi Bernie,

The property file shows all the possible values in this way. It is like a document written with comments.

When you change a default, you need to uncomment it and restart the deployit server.

For example, the following is from http://docs.xebialabs.com/releases/3.8/deployit/upgrademanual.html

Placeholder scanning in archives (EAR, WAR, etc.) is now disabled by default. To enable it, edit deployit-defaults.properties and add the following line:

udm.BaseDeployableArchiveArtifact.scanPlaceholders=true
Levent Tutar 0 votes
0
Avatar

Okay, thanks. But if those defaults are not be read, unless they're uncommented, then are they hardcoded somewhere else? Just seems strange to have a list of default in a properties file that are all commented out.

Either way, it might be good to state that you need to uncomment the value and bounce DeployIT (err... XL Deploy) in the docs and probably in the file. For example, in the docs you say...

You can change this list by setting the textFileNamesRegex property on the udm.BaseDeployableArtifact in the deployit-defaults.properties  file. Note that it takes a regular expression. It is also possible to change this on any of its subtypes which is important if you only want to change that for certain types of artifacts.

But if you just read that, it's not clear that you need to uncomment the line and bounce XL Deploy. So maybe just have section with a couple sentences on how to modify that file, the reference that.

 

Thanks!

Bernie Durfee 0 votes
0
Avatar

Hi Bernie,

Lines that start with a comment character (#) are ignored, so that means you'll have to remove that character when you want to override a provided default value. The reasoning behind this is that the provided default value might change and you want to get that new value_ unless_ you have explicitly overridden it.

The deployit-defaults.properties file is automatically updated every time XL Deploy is started. All default values provided by the plugins installed in XL Deploy (including some built-in plugins such as the remoting-plugin that provides the overthere.SshHost type amongst others) are written to this file, except for those default values that have been explicitly overridden.

On a Unix machine, you can use the following command to see all the default values you have explicitly overridden:

grep -v ^# conf/deployit-defaults.properties 

To ensure this is explained in the next iteration of the documentation, I have created issue DEPL-5801 in our internal issue tracker.

Regards, Vincent.

 

XebiaLabs Support 0 votes