Octopus command line script

sohilberg · 21 September 2018 13:51

Hi,

I am looking for a possible way to trigger Octopus deployment from a command line utility. Please let me know if there is a provision to do this and send the script for it.

Thanks,
Sohil

Kenneth_Bates · 24 September 2018 00:22

Hi Sohil,

Thanks for getting in touch! There are a number of options to trigger deployments in Octopus from outside of the web portal. You can use Octo.exe deploy-release command as outlined in the following documentation.

You can use the Octopus.Client (an open source .NET library), of which we have sample scripts in our API repository.

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/Octopus.Client/PowerShell/Deployments/DeployRelease.ps1

# You can this dll from your Octopus Server/Tentacle installation directory or from
# https://www.nuget.org/packages/Octopus.Client/
Add-Type -Path 'Octopus.Client.dll' 

$apikey = 'API-xxx' # Get this from your profile
$octopusURI = 'http://localhost' # Your Octopus Server address

$releaseId = "Releases-1" # Get this from /api/releases
$environmentId = "Environments-1" # Get this from /api/environments

$endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURI,$apikey 
$repository = New-Object Octopus.Client.OctopusRepository $endpoint

$release = $repository.Releases.Get($releaseId); 
$deployment = new-object Octopus.Client.Model.DeploymentResource
$deployment.ReleaseId = $release.Id
$deployment.ProjectId = $release.ProjectId
$deployment.EnvironmentId = $environmentId

$repository.Deployments.Create($deployment)

Or via the REST API directly.

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Deployments/CreateReleaseAndDeployment.ps1

##CONFIG##

$apiKey = "" #Octopus API Key
$OctopusURL = "" #Octopus URL
 
$ProjectName = "" #project name
$EnvironmentName = "" #environment name

##PROCESS##

$Header =  @{ "X-Octopus-ApiKey" = $apiKey }
 
#Getting Environment and Project By Name
$Project = Invoke-WebRequest -Uri "$OctopusURL/api/projects/$ProjectName" -Headers $Header| ConvertFrom-Json
 
$Environment = Invoke-WebRequest -Uri "$OctopusURL/api/Environments/all" -Headers $Header| ConvertFrom-Json
 
$Environment = $Environment | ?{$_.name -eq $EnvironmentName}

#Getting Deployment Template to get Next version

This file has been truncated. show original

I hope this helps! Let me know if you have any further questions moving forward.

Best regards,

Kenny

system · 24 October 2018 00:22

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