Define and use variables

Getting Started - Variables

Octopus lets you define variables and scope them for use in different phases of your deployments. Variables allow you to have a consistent deployment process across your infrastructure without having to hard-code or manually update configuration settings that differ across environments, deployment targets, channels, or tenants.

Add a variable

1. From the Hello world project you created earlier, click Project Variables in the left menu.
2. Click Create Variables.
3. Add Helloworld.Greeting in the Name column,
4. Add Hello, Development in the Value column,
5. Click the Scope column and select the Development environment.
6. Click Add another value.
7. Add Hello, Staging and scope it to the Staging environment.
8. Click Add another value.
9. Add Hello, Production and scope it to the Production environment.
10. Click Save.

Update deployment process

Steps in the deployment process can reference variables.

1. Click Process in the left menu.
2. Select the previously created Run a Script step.

Inline Source Code

3. Based on your selected language, copy the appropriate script from below.
4. Replace the script in the code editor with the new script.

Write-Host $OctopusParameters["Helloworld.Greeting"]

greeting=$(get_octopusvariable "Helloworld.Greeting")
echo $greeting

5. Click Save
6. Click Create Release.

As you promote through the environments, you will see the greeting change.

Great job! Next, let’s build on your deployment process and add an approval process using manual interventions.

All guides in this tutorial series

1. First deployment
2. Define and use variables (this page)
3. Approvals with manual interventions
4. Add deployment targets
5. Deploy a sample package

Further reading for variables

• Variable Documentation
• Deployment Documentation
• Patterns and Practices

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Wednesday, November 13, 2024