Search

Blog posts

Automation with Octopus.Client

One of the benefits of being API first is that you can do anything that the Octopus UI does via web requests. We have a handy library called Octopus.Client that wraps the API and makes it easy to perform operations on your Octopus Deploy Server. This article will focus on some common operations using PowerShell.

Worker friendly custom step templates

How to make worker friendly custom step templates.

Running manual tests against cloud infrastructure deployed by Octopus

Learn how to run tests against infrastructure that was previously deployed by Octopus.

ASP.NET Core 1 build & deployment pipelines with TeamCity and Octopus

ASP.NET Core 1 and the dotnet CLI makes publishing applications a first-class feature of the platform. This post explains how to hook it into your build & deployment pipeline.

Documentation

Getting started

Getting started with the Octopus.Client.

Using in an Octopus Step

How to use the Octopus.Client library from inside Octopus, for example within a script step.

Troubleshooting OctoPack

Troubleshooting NuGet packages and Octopack

Customizing an Octopus Server extension

Octopus Deploy built-in server extensions are available on GitHub and can be forked and customized.

Installing a custom server extension

To install a custom server extension, you need to copy the extension dll into a folder on the machine that is running the Octopus Server.

Managing server configuration

The Octopus Server configuration can be managed programmatically through the Octopus.Client library and the API

List deployments to environment

An example script to retrieve a list of deployments to an environment

Service Fabric PowerShell scripts

Service Fabric PowerShell scripts allow you to manage your Service Fabric clusters using the Service Fabric SDK as part of your deployment process.

Update release variable snapshot

An example script that updates the variable snapshot for a release.

Adding Environments

An example script to create environments in a Space.

Create a Google Cloud account

An example script to create a Google Cloud (GCP) account in Octopus.

Create a new scheduled runbook trigger

An example script to create and publish a new runbook scheduled trigger

Authoring an Octopus Server extension

Technical details of how to author an Octopus Server extension.

Delete projects with no process

An example script that deletes projects that have no deployment process in Octopus using the REST API and Octopus.Client.

Change feed

An example script that changes an existing feed by updating the feed name in Octopus using the REST API and Octopus.Client.

Add a target role

An example script that adds a target role to a deployment target.

Delete targets by name

An example script to delete targets by matching a specified name.

Create a feed

An example script that creates a nuget feed in Octopus.

Enable/disable machine

An example script that enables or disables a machine in Octopus.

Delete a feed

An example script that deletes an existing feed in Octopus using the REST API and Octopus.Client.

Retrieve all feeds

An example script that retrieves all feeds in Octopus.

Disable project triggers

An example script that disables a project's triggers in Octopus using the REST API and Octopus.Client.

Delete targets by role

An example script to delete targets by role.

Run a published runbook

An example script to run a published runbook.

Delete a Space

An example script to delete a space.

Run a health check

An example script that creates and runs a health check task.

Can't find what you are looking for? You can also search our support forum.