This script displays all projects in a space that target the given role.
Usage
Provide values for:
- Octopus URL
- Octopus API Key
- Name of the role to search for
- Name of the space to search
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"
$roleName = "My role"
# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}
# Get projects for space
$projectList = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $header
# Loop through projects
foreach ($project in $projectList)
{
$deploymentProcessLink = $project.Links.DeploymentProcess
# Check if project is Config-as-Code
if ($project.IsVersionControlled) {
# Get default Git branch for Config-as-Code project
$defaultBranch = $project.PersistenceSettings.DefaultBranch
$deploymentProcessLink = $deploymentProcessLink -Replace "{gitRef}", $defaultBranch
}
$deploymentProcess = Invoke-RestMethod -Method Get -Uri "$octopusURL$deploymentProcessLink" -Headers $header
# Get steps
foreach ($step in $deploymentProcess.Steps)
{
if (($null -ne $step.Properties.'Octopus.Action.TargetRoles') -and ($step.properties.'Octopus.Action.TargetRoles'.Split(',') -Icontains $roleName ))
{
Write-Host "Step $($step.Name) of $($project.Name) is using role $roleName"
}
}
}
PowerShell (Octopus.Client)
Add-Type -Path "path\to\Octopus.Client.dll"
# Octopus variables
$octopusURL = "https://your-octopus-url"
$octopusAPIKey = "API-YOUR-KEY"
$spaceName = "default"
$roleName = "My role"
$endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey
$repository = New-Object Octopus.Client.OctopusRepository $endpoint
$client = New-Object Octopus.Client.OctopusClient $endpoint
# Get space
$space = $repository.Spaces.FindByName($spaceName)
$repositoryForSpace = $client.ForSpace($space)
$projectList = $repositoryForSpace.Projects.GetAll()
"Looking for steps with the role $($roleName) in them..."
foreach($project in $projectList)
{
# Get deployment process
$deploymentProcess = $repositoryForSpace.DeploymentProcesses.Get($project)
# Loop through steps
foreach ($step in $deploymentProcess.Steps)
{
if($step.properties.'Octopus.Action.TargetRoles' -and ($step.Properties.'Octopus.Action.TargetRoles'.Value.Split(',') -Icontains $roleName))
{
"Step [$($step.Name)] from project [$($project.Name)] is using the role [$($roleName )]"
}
}
}
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 roleName = "My role";
// 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 project
var projectList = repositoryForSpace.Projects.GetAll();
// Loop through list
foreach (var project in projectList)
{
// Get the deployment process
var deploymentProcess = repositoryForSpace.DeploymentProcesses.Get(project);
// Loop through steps
foreach (var step in deploymentProcess.Steps)
{
// Get property value
PropertyValueResource propertyValue = null;
if (step.Properties.TryGetValue("Octopus.Action.TargetRoles", out propertyValue))
{
if ((propertyValue != null) && (propertyValue.Value.ToString().ToLower().Split(',').Contains(roleName.ToLower())))
{
Console.WriteLine(string.Format("Step [{0}] from project [{1}] is using the role [{2}]", step.Name, project.Name, roleName));
}
}
}
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return;
}
Python3
import json
import requests
octopus_server_uri = 'https://your-octopus-url/'
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'
role_name = 'My target role'
spaces = get_octopus_resource('{0}/api/spaces/all'.format(octopus_server_uri))
space = next((x for x in spaces if x['Name'] == space_name), None)
projects = get_octopus_resource('{0}/api/{1}/projects/all'.format(octopus_server_uri, space['Id']))
for project in projects:
deployment_process_link = project['Links']['DeploymentProcess']
if project['IsVersionControlled'] == True:
default_branch = project['PersistenceSettings']['DefaultBranch']
deployment_process_link = deployment_process_link.replace('{gitRef}', default_branch)
uri = '{0}{1}'.format(octopus_server_uri, deployment_process_link)
process = get_octopus_resource(uri)
for step in process['Steps']:
properties = step['Properties']
roles_key = 'Octopus.Action.TargetRoles'
roles = properties[roles_key].split(',') if roles_key in properties else None
if roles is None:
continue
if role_name in roles:
print('Step \'{0}\' of project \'{1}\' is using role \'{2}\''.format(step['Name'], project['Name'], role_name))
Go
package main
import (
"fmt"
"log"
"net/url"
"strings"
"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"
roleName := "MyRole"
// Create client object
client := octopusAuth(apiURL, APIKey, "")
// Get space
space := GetSpace(apiURL, APIKey, spaceName)
// Get space specific client
client = octopusAuth(apiURL, APIKey, space.ID)
// Get all projects in space
projects, err := client.Projects.GetAll()
if err != nil {
log.Println(err)
}
// Loop through projects
for _, project := range projects {
if !project.IsVersionControlled {
// Get project deployment process
deploymentProcess, err := client.DeploymentProcesses.GetByID(project.DeploymentProcessID)
if err != nil {
log.Println(err)
}
// Loop through steps
for _, step := range deploymentProcess.Steps {
// Check to see if step is scoped to role
if _, found := step.Properties["Octopus.Action.TargetRoles"]; found {
roles := strings.Split(step.Properties["Octopus.Action.TargetRoles"].Value, ",")
if arrayContains(roles, roleName) {
fmt.Printf("Step %[1]s of project %[2]s is using role %[3]s", step.Name, project.Name, roleName)
}
}
}
}
}
}
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 arrayContains(s []string, str string) bool {
for _, v := range s {
if v == str {
return true
}
}
return false
}
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
}
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023