Variable Substitution in OctopusDeploy

Question

I'm trying to substitute a #{port} variable during by deployment using OctopusDeploy. I am able to do it if I directly add it in my App.Config as follows:

<services>
  <service name="SampleService" behaviorConfiguration="ServiceBehaviour">
    <host>
      <baseAddresses>
        <add baseAddress="http://localhost:#{port}/SampleService/" />
      </baseAddresses>
    </host>
    ..
  </service>

Is there a way I can add a default port here (say 25555, so that developers can use it without replacing #{port} always), but still specify to OctopusDeploy that this particular port has to be modified? (I'm using multi-tenant deployments)

James Reed · Accepted Answer · 2016-11-11 19:17:34Z

1

You can use the XML transform feature of config files in conjunction with Octopus deploy.

Octopus itself can run these transforms. When you compile your code, the app.config is renamed [applicationName].exe.config If you create a file called [applicationName].exe.release.config and add this to your package then you can use the same style of transform, that you would normally use in web.config transforms, in that file. If Octopus sees a file called *.release.config it will run any transforms during the deployment process.

Alternatively This blog contains instructions of extending your project so you can use the transform ability of web.config files in app.config files.

So you could do this several ways. Have the hard coded value in you "base" app.config then have the Octopus Variable as a transform in the app.release.config. When you build and package your code, so long as you use the "release" configuration the transform will fire and the hard coded value will be replaced by your build and added to the package.

Or you could do it the other way round, have the hard coded value in the app.debug.config and the Octopus Variable in the app.config. When a developer runs a debug build the Variable would be replaced by the value in the debug.config.

answered Nov 11, 2016 at 19:17

James Reed

14.1k55 silver badges63 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Narayana Over a year ago

Thanks, I used app.config transforms itself and OctopusDeploy's substitute variables..

gvee · Accepted Answer · 2016-11-14 11:16:02Z

1

Octopus supports if and unless in variable substitutions (docs: http://docs.octopusdeploy.com/display/OD/Variable+Substitution+Syntax)

That means you could apply a default with relative ease.

Firstly, if the variable exists, use it:

#{if port}#{port}#{/if}

Secondly, if the variable does not exists, use your default:

#{unless port}25555#{/unless}

So just combine them together:

#{if port}#{port}#{/if}#{unless port}25555#{/unless}

answered Nov 14, 2016 at 11:16

gvee

17.2k42 silver badges50 bronze badges

Comments

Satish Kumar Nadarajan · Accepted Answer · 2019-11-06 18:23:25Z

0

While you create a variable using Project variable template , you have the option to provide a default value. Check the image in the link - Shows Variable template with default value

Unless overridden the default value is substituted while deployed.

So in this case you could create a #{port} variable add the reference variable to project variable template with default value of 25555, which unless overridden will always substitute to 25555 while deployments .

edited Nov 6, 2019 at 18:23

answered Nov 6, 2019 at 14:44

Satish Kumar Nadarajan

3062 silver badges8 bronze badges

Collectives™ on Stack Overflow

Variable Substitution in OctopusDeploy

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related