Octopose

Octopose is a manifest / state driven deployment framework for Octopus Deploy. Octopose allows you to create a manifest file based on your releases or deployments that are in Octopus Deploy.

Why Octopose?

Installation

pip install octopose

Configuration

Running Octopose requires various configuration variables which can be found in config.master.yaml:

OCTOPUS_URI: ""
OCTOPUS_HEADERS:
  "x-octopus-apikey": ""
PROJECTS:
  - ""
STAGING: "~\\StagingLocation"
PACKAGE_SOURCES:
  - ""

Create a copy of this file called config.yaml with your desired variables and copy it to ~\.octopose\config.yaml

Usage

Creating a Manifest File

Create a manifest file from the projects in config.yaml:

octopose generate

This will output to stdout a manifest based on those projects and the packages within them:

{
    'Projects':
    {
        'Huddle.ABC':
            {
                'Packages': ['Huddle.ABC']
            },
        'Huddle.XYZ':
            {
                'Packages': ['Huddle.XYZ1', 'Huddle.XYZ2']
            }
    },
    'StagingLocation': 'D:\\dev\\huddle\\StagingLocation'
}

Generate a manifest based on packages in a given environment

octopose generate -e uklive

This will add the specific versions of the releases that are currently deployed into that environment:

{
    'Projects':
    {
        'Huddle.ABC':
            {
                'Packages': ['Huddle.ABC'],
                'Version': '1.0.0'
            },
        'Huddle.XYZ':
            {
                'Packages': ['Huddle.XYZ1', 'Huddle.XYZ2'],
                'Version': '2.3.0'
            }
    },
    'StagingLocation': 'D:\\dev\\huddle\\StagingLocation'
}

Generate a manifest to only deploy certain packages

octopose generate -p Huddle.ABC Huddle.XYZ

This will only add the specified projects to the manifest:

{
    'Projects':
    {
        'Huddle.ABC':
            {
                'Packages': ['Huddle.ABC'],
                'Version': '1.0.0'
            },
        'Huddle.XYZ':
            {
                'Packages': ['Huddle.XYZ1', 'Huddle.XYZ2']
            }
    },
    'StagingLocation': 'D:\\dev\\huddle\\StagingLocation'
}

Generate a manifest and ignore certain packages

octopose generate -i Tasks Publishing
octopose generate --ignore Tasks 

This will remove projects from the manfest.

Generate a manifest for a specific project and version

octopose generate -p Huddle.ABC -v '{\"Huddle.ABC\" : \"1.99.9.999\"}'

This will generate manifest only for the specified projects and versions:

{
    'Projects':
    {
        'Huddle.ABC':
            {
                'Packages': ['Huddle.ABC'],
                'Version': '1.99.9.999'
            }
    },
    'StagingLocation': 'D:\\StagingLocation'
}

It is also possible to generate manifest based on packages in an environment and override version of one specfic project. Eg:

octopose generate -e uklive -v '{\"Huddle.ABC\" : \"1.99.9.999\"}'

{
    'Projects':
    {
        'Huddle.ABC':
            {
                'Packages': ['Huddle.ABC'],
                'Version': '1.99.9.999'
            }
    },
    'Huddle.XYZ':
            {
                'Packages': ['Huddle.XYZ1', 'Huddle.XYZ2'],
                'Version': '2.3.0'
            }
    },
    'StagingLocation': 'D:\\StagingLocation'
}

Save manifest to a file

octopose generate > manifest.json

Deploy to local environment

Deploying to a local environment helps set up developers with the latest code or reproduce a given environment for debugging on your developer workstation.

It reads in the manifest file supplied that describes the state of the local environment.

octopose deploy .\manifest.json

Or

cat .\manifest.json | octopose deploy .\octopose.py

This will pull down releases (or given versions) from the NuGet package sources specified in config.yaml. The run through the PreDeploy.ps1, Deploy.ps1, and PostDeploy.ps1 executing them for the given release.

The commands can also be piped together:

octopose generate | octopose deploy

Deploy to a known Octopus Deploy environment

Octopose can also be used to deployed to remote environments such as staging and production using the releases and versions specified in the manifest.json file.

The following command will deploy the state described in the supplied manifest.json to the environment uklive.

octopose deploy -e uklive .\manifest.json

--force flag will ensure the package is re-downloaded even if it is already deployed into the target environment.

--wait flag will cause octopose to continually poll the Octopus Deploy Tasks till they are complete.

--verbose (or -v) flag will cause octopose to output all logs from the *Deploy.ps1 files. Otherwise there will only be logs from a script if a non-zero exit code is returned.

octopose deploy -e staging --wait --force --verbose