This script demonstrates how to programmatically add an environment scope to an existing step so that it only runs in specific environments.
Usage
Provide values for:
- Octopus URL
- Octopus API Key
- Name of the space you want to use
- Name of the step to add the environment to
- List of environments to add to the step
- Name of project to modify
Script
PowerShell (REST API)
$ErrorActionPreference = "Stop";
# Define working variables
$octopusURL = "https://your-octopus-url"
$octopusAPIKey = "API-YOUR-KEY"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }
$spaceName = "default"
$projectName = "MyProject"
$stepName = "Run a script"
$environmentNames = @("Development", "Test")
$environments = @()
# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}
# Get environments
$environments += (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/environments/all" -Headers $header) | Where-Object {$environmentNames -contains $_.Name} | Select -Property Id
# Get project
$project = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.id)/projects/all" -Headers $header) | Where-Object {$_.Name -eq $projectName}
# Get project deployment process
$deploymentProcess = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/deploymentprocesses/$($project.DeploymentProcessId)" -Headers $header
# Get specific step
$step = $deploymentProcess.Steps | Where-Object {$_.Name -eq $stepName}
# Loop through the actions of the step and apply environment(s)
foreach ($action in $step.Actions)
{
# Add/update environment(s)
$action.Environments += $environments.Id
}
# Update the deployment process
Invoke-RestMethod -Method Put -Uri "$octopusURL/api/$($space.Id)/deploymentprocesses/$($project.DeploymentProcessId)" -Headers $header -Body ($deploymentProcess | ConvertTo-Json -Depth 10)
PowerShell (Octopus.Client)
Add-Type -Path "path\to\Octopus.Client.dll"
$apikey = "API-YOUR-KEY"
$octopusURL = "https://your-octopus-url"
$spaceName = "default"
$stepName = "Run a script"
$environmentNames = @("Development", "Test")
$projectName = "MyProject"
# Create endpoint and client
$endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $apikey
$client = New-Object Octopus.Client.OctopusClient $endpoint
try
{
$repository = $client.ForSystem()
# Get space specific repository and get all projects in space
$space = $repository.Spaces.FindByName($spaceName)
$repositoryForSpace = $client.ForSpace($space)
$project = $repositoryForSpace.Projects.FindByName($projectName)
$environments = $repositoryForSpace.Environments.GetAll() | Where-Object {$environmentNames -contains $_.Name} | Select -Property Id
# Get process
$deploymentProcess = $repositoryForSpace.DeploymentProcesses.Get($project.DeploymentProcessId)
# Get step
$step = $deploymentProcess.Steps | Where-Object {$_.Name -eq $stepName}
# Update the action
foreach ($action in $step.Actions)
{
foreach ($id in $environments.Id)
{
$action.Environments.Add($id)
}
}
# Update deployment process
$repositoryForSpace.DeploymentProcesses.Modify($deploymentProcess)
}
catch
{
Write-Host $_.Exception.Message
}
C#
// If using .net Core, be sure to add the NuGet package of System.Security.Permissions
#r "path\to\Octopus.Client.dll"
using Octopus.Client;
using Octopus.Client.Model;
// Declare working variables
var octopusURL = "https://your-octopus-url";
var octopusAPIKey = "API-YOUR-KEY";
string spaceName = "default";
string projectName = "MyProject";
string[] environmentNames = { "Development", "Test" };
string stepName = "Run a script";
// Create repository object
var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey);
var repository = new OctopusRepository(endpoint);
var client = new OctopusClient(endpoint);
try
{
// Get space
var space = repository.Spaces.FindByName(spaceName);
var repositoryForSpace = client.ForSpace(space);
// Get environment ids
List<string> environmentIds = new List<string>();
foreach (var environmentName in environmentNames)
{
environmentIds.Add(repositoryForSpace.Environments.FindByName(environmentName).Id);
}
// Get project
var project = repositoryForSpace.Projects.FindByName(projectName);
// Get deployment process
var deploymentProcess = repositoryForSpace.DeploymentProcesses.Get(project.DeploymentProcessId);
// Get the step
var step = deploymentProcess.Steps.Where(s => s.Name == stepName).FirstOrDefault();
// Update the action
foreach (var action in step.Actions)
{
foreach (string environmentId in environmentIds)
{
action.Environments.Add(environmentId);
}
}
// Update the deployment process
repositoryForSpace.DeploymentProcesses.Modify(deploymentProcess);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return;
}
Python3
import json
import requests
octopus_server_uri = 'https://your-octopus-url/api'
octopus_api_key = 'API-YOUR-KEY'
headers = {'X-Octopus-ApiKey': octopus_api_key}
def get_octopus_resource(uri):
response = requests.get(uri, headers=headers)
response.raise_for_status()
return json.loads(response.content.decode('utf-8'))
space_name = 'Default'
project_name = 'Your Project'
step_name = 'Your Step'
environment_names = ['Development', 'Test']
environments = []
spaces = get_octopus_resource('{0}/spaces/all'.format(octopus_server_uri))
space = next((x for x in spaces if x['Name'] == space_name), None)
environments = get_octopus_resource('{0}/{1}/environments/all'.format(octopus_server_uri, space['Id']))
environments = [e['Id'] for e in environments if e['Name'] in environment_names]
projects = get_octopus_resource('{0}/{1}/projects/all'.format(octopus_server_uri, space['Id']))
project = next((x for x in projects if x['Name'] == project_name), None)
uri = '{0}/{1}/deploymentprocesses/{2}'.format(octopus_server_uri, space['Id'], project['DeploymentProcessId'])
process = get_octopus_resource(uri)
step = next((s for s in process['Steps'] if s['Name'] == step_name), None)
for action in step['Actions']:
new_environments = set(action['Environments'] + environments)
action['Environments'] = list(new_environments)
response = requests.put(uri, headers=headers, json=process)
response.raise_for_status()
Go
package main
import (
"fmt"
"log"
"net/url"
"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
)
func main() {
apiURL, err := url.Parse("https://your-octopus-url")
if err != nil {
log.Println(err)
}
APIKey := "API-YOUR-KEY"
spaceName := "Default"
environmentNames := []string{"Development", "Production"}
environments := []octopusdeploy.Environment{}
projectName := "MyProject"
stepName := "MyStep"
// Get reference to space
space := GetSpace(apiURL, APIKey, spaceName)
// Get reference to project
project := GetProject(apiURL, APIKey, space, projectName)
deploymentProcess := GetProjectDeploymentProcess(apiURL, APIKey, space, project)
// Get references to environments
for i := 0; i < len(environmentNames); i++ {
environment := GetEnvironment(apiURL, APIKey, space, environmentNames[i])
environments = append(environments, *environment)
}
// Loop through deployment process
for i := 0; i < len(deploymentProcess.Steps); i++ {
// Check to see if it's the step we want
if deploymentProcess.Steps[i].Name == stepName {
// Loop through actions
for j := 0; j < len(deploymentProcess.Steps[i].Actions); j++ {
// Loop through environments to add
for e := 0; e < len(environments); e++ {
if !contains(deploymentProcess.Steps[i].Actions[j].Environments, environments[e].ID) {
// Add environment
fmt.Println("Adding " + environments[e].Name + " to step " + deploymentProcess.Steps[i].Name)
deploymentProcess.Steps[i].Actions[j].Environments = append(deploymentProcess.Steps[i].Actions[j].Environments, environments[e].ID)
}
}
}
}
}
// Update deployment process
client := octopusAuth(apiURL, APIKey, space.ID)
client.DeploymentProcesses.Update(deploymentProcess)
}
func octopusAuth(octopusURL *url.URL, APIKey, space string) *octopusdeploy.Client {
client, err := octopusdeploy.NewClient(nil, octopusURL, APIKey, space)
if err != nil {
log.Println(err)
}
return client
}
func GetSpace(octopusURL *url.URL, APIKey string, spaceName string) *octopusdeploy.Space {
client := octopusAuth(octopusURL, APIKey, "")
spaceQuery := octopusdeploy.SpacesQuery{
Name: spaceName,
}
// Get specific space object
spaces, err := client.Spaces.Get(spaceQuery)
if err != nil {
log.Println(err)
}
for _, space := range spaces.Items {
if space.Name == spaceName {
return space
}
}
return nil
}
func GetEnvironment(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, EnvironmentName string) *octopusdeploy.Environment {
client := octopusAuth(octopusURL, APIKey, space.ID)
// Get environment
environmentsQuery := octopusdeploy.EnvironmentsQuery {
Name: environmentName,
}
environments, err := client.Environments.Get(environmentsQuery)
if err != nil {
log.Println(err)
}
// Loop through results
for _, environment := range environments.Items {
if environment.Name == environmentName {
return environment
}
}
return nil
}
func GetProject(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, projectName string) *octopusdeploy.Project {
// Create client
client := octopusAuth(octopusURL, APIKey, space.ID)
projectsQuery := octopusdeploy.ProjectsQuery {
Name: projectName,
}
// Get specific project object
projects, err := client.Projects.Get(projectsQuery)
if err != nil {
log.Println(err)
}
for _, project := range projects.Items {
if project.Name == projectName {
return project
}
}
return nil
}
func GetProjectDeploymentProcess(octopusURL *url.URL, APIKey string, space *octopusdeploy.Space, project *octopusdeploy.Project) *octopusdeploy.DeploymentProcess {
client := octopusAuth(octopusURL, APIKey, space.ID)
deploymentProcess, err := client.DeploymentProcesses.GetByID(project.DeploymentProcessID)
if err != nil {
log.Println(err)
} else {
fmt.Println("Retrieved deployment process for project " + project.Name)
}
return deploymentProcess
}
func contains(s []string, str string) bool {
for _, v := range s {
if v == str {
return true
}
}
return false
}
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023