Update Octopus variables through deployment

Sheena.Agrawal · 10 June 2020 10:45

I am trying to create new various clients using scripts that will run with every deployment.

After the deployment completes, I want to update those client Ids and client secrets as octopus variables, so that I can directly pick up those values from variables instead of re-creating those clients again.

I can see that variables could be used within the scope of a single deployment. But is it possible to add variables that can be used for subsequent deployments?

paul.calvert · 10 June 2020 11:07

Hi @Sheena.Agrawal,

Thanks for getting in touch!

This is possible but it would require a script to interact with the API to add the variables to the project.
We have a sample script here that you could modify for your purposes (by default it creates variables as plain text so that may need changing for your secrets):

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/Octopus.Client/PowerShell/Variables/UpdateVariableInProject.ps1

cls
function UpdateVarInProject {
    Param (
        [Parameter(Mandatory=$true)][string] $UserApiKey,
        [Parameter(Mandatory=$true)][string] $OctopusUrl,
        [Parameter(Mandatory=$true)][string] $ProjectName,
        [Parameter(Mandatory=$true)][string] $VariableToModify,
        [Parameter(Mandatory=$true)][string] $VariableValue,
        [Parameter()][string] $EnvironmentScope,
        [Parameter()][string] $RoleScope,
        [Parameter()][string] $MachineScope,
        [Parameter()][string] $ActionScope
    )
    Process {
        Set-Location "C:\Program Files\Octopus Deploy\Tentacle"
        Add-Type -Path 'Newtonsoft.Json.dll'
        Add-Type -Path 'Octopus.Client.dll'
        $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $OctopusUrl,$UserApiKey
        $repository = New-Object Octopus.Client.OctopusRepository $endpoint
        $project = $repository.Projects.FindByName($ProjectName)

This file has been truncated. show original

I hope this helps, please let me know if you have any further questions.

Regards,
Paul

system · 11 July 2020 11:07

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.