Update Project Variables for Confg-as-code enabled Project

harsh_tech · 7 December 2022 02:49

Hi there,
Earlier(before config-as-code) I was using process step to update the Project variable via Rest API, however after enabling the config-as-code this started failing because project variables are stored as part of GIT and needs Commit to change it. How can this be fixed with config-as-code?

i.e. How do I get this code

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Variables/CreateEnvironmentScopedVariables.ps1

$baseUri = "http://output.url"           # the address of your octopus server

$apiKey = "API-APIKEYAPIKEYAPIKEY"           # an api-key from an account with permissions to create
                                             # variables on the environment you specify

$projectName = "Project Name" # If you don't know your project Id add your project name here
                              # and the script will print out your project Id on the first run,
                              # then you can add it below

$projectId = ""               # set this if you know it, the script will run faster if it has
                              # a projectId, otherwise it will look up the project using its name

$environment = "Production"   # the name of the environment you want to scope the variables to

$variablesToAdd = "First", "Second", "Third"  #all the variables you want to createe

function Get-OctopusResource([string]$uri) {
    Write-Host "[GET]: $uri"
    return Invoke-RestMethod -Method Get -Uri "$baseUri/$uri" -Headers $headers
}

This file has been truncated. show original

or

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Variables/ModifyOrAddVariableToProject.ps1

function Set-OctopusVariable {
    param(
        $octopusURL = "https://xxx.octopus.app/", # Octopus Server URL
        $octopusAPIKey = "API-xxx",               # API key goes here
        $projectName = "",                        # Replace with your project name
        $spaceName = "Default",                   # Replace with the name of the space you are working in
        $environment = $null,                     # Replace with the name of the environment you want to scope the variables to
        $varName = "",                            # Replace with the name of the variable
        $varValue = ""                            # Replace with the value of the variable
    )

    # Defines header for API call
    $header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }

    # Get space
    $space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}

    # Get project
    $project = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $header) | Where-Object {$_.Name -eq $projectName}

This file has been truncated. show original

work for Confg-as-code enabled project ?

adam.close · 7 December 2022 10:41

Hey @harsh_tech,

Thanks for your question!

I wanted to let you know that earlier this year Octopus changed its policies around providing API scripts for customers. In the past, we’d get a request such as this, maybe ask a few clarification questions, write up an example script for you to modify, and send it over. Then a few days would go by as you attempted to modify it to fit your needs, but you’d find an error or some additional use case that wasn’t mentioned in earlier conversations, slowing down progress. It wasn’t a great experience for anyone.

Our new policy gives you two choices:

We point you in a general direction and provide some pseudo-code and endpoints to consider, but you’d write the script.
We now offer professional services where for a fee we’d write API script(s) for you. We’d meet with you, discuss your use case, conditions of satisfaction, any gotchas specific for your instance, and write something specifically for you.

The pseudo-code hasn’t been updated to accommodate CaC project variables, but we may do in the future. I checked this out, and there are a couple of things you need to do in the script to get this working;

You need to work out if the variable you’re adding is sensitive because sensitive variables are stored in the database still, and the API call to add these into Octopus remains the same.

e.g. https://OCTOPUS_URL/api/Spaces-1/projects/Projects-1/variables

For any none sensitive variables, then you need an additional parameter that includes the branch name you want to add the variables to.

e.g. https://OCTOPUS_URL/api/Spaces-1/projects/Projects-1/refs%2fheads$2fmain/variables

Thanks

harsh_tech · 7 December 2022 10:56

Thanks @adam.close , Can you please point me to the Octopus official documentation that talks about including the branch name? If I could learn to find right documentation on the Octopus official site then probably I would refrain myself from asking the specific question like this as the policies has changed on Octopus side.

harsh_tech · 7 December 2022 11:05

@adam.close one more question, is there a way I can pass commit message too? I got restriction in Git for “commit message” to have JIRA user story number in it…

adam.close · 7 December 2022 14:55

Hey @harsh_tech,

Our API documentation can be found here, but not everything you can do in the API is documented explicitly.

My recommendation is to use dev tools to record your actions in the Octopus UI. This will give you all the API calls Octopus makes when any UI button is clicked, which you can then use in your script. The below example is me adding a new variable in a project and committing it to my git repro with a commit message.

I used chrome dev tools to capture the information.

Thanks