This repository contains a PowerShell module with DSC resources that can be used to install and configure an Octopus Deploy Server and Tentacle agent.

There are two main resources:

• cOctopusServer to install and configure an Octopus Server, and
• cTentacleAgent to install and configure a Tentacle.

Server authentication can be configured to use:

• Active Directory with cOctopusServerActiveDirectoryAuthentication
• Azure AD with cOctopusServerAzureADAuthentication
• GoogleApps with cOctopusServerGoogleAppsAuthentication
• Okta with cOctopusServerOktaAuthentication
• Username/passwords stored in Octopus with cOctopusServerUsernamePasswordAuthentication
• Read-only guest account login with cOctopusServerGuestAuthentication

Version 3.0 of OctopusDSC supports Octopus Deploy 4.x with backwards compatibility to 3.x

1. Install PowerShellGet from PowerShell Gallery
2. Install DSC module via PowerShellGet\Install-Module -Name OctopusDSC

1. Download the latest release
2. If required, unblock the zip file
3. Extract the zip file to a folder called OctopusDSC under your modules folder (usually %USERPROFILE%\Documents\WindowsPowerShell\Modules)
4. To confirm it's installed correctly, in a new powershell session run Get-Module -ListAvailable -Name OctopusDSC

The community has also submitted a few other options.

This project is setup to use Vagrant to provide a dev/test environment. Once you've installed Vagrant, you can use the build scripts to spin up a local virtual machine and run the test scenarios (NOTE: The first time you run vagrant up in Virtualbox or Hyper-V it has to download the octopusdeploy/dsc-test-server box and this can take some time depending on your Internet speed, so be patient and go grab a coffee while it downloads).

There are four options provided:

• build-aws.ps1
• build-azure.ps1
• build-hyperv-ps1 - windows virtualisation (new)
• build-virtualbox.ps1 - cross-platform virtualisation

On a build server, you most likely want to use build-aws.ps1 to spin up a virtual machine on AWS to run the tests.

Configuration is handled by environment variables. The shell scripts will show a message letting you know what variables need to be set. The build-* scripts also invoke Pester and PSScriptAnalyzer tests, so you'll need those modules installed.

To run just the scenarios locally, follow these steps:

1. Install Vagrant from vagrantup.com
2. Install VirtualBox from virtualbox.org or Hyper-V (Install-WindowsFeature –Name Hyper-V -IncludeManagementTools -Restart )
3. If you are on a Mac or Linux you need to install PowerShell, see https://github.com/PowerShell/PowerShell/blob/master/docs/installation/linux.md.
4. If you want to test locally using virtualbox
   • Run vagrant plugin install vagrant-dsc
   • Run vagrant plugin install vagrant-winrm
   • Run vagrant plugin install vagrant-winrm-syncedfolders
   • Run vagrant up -- provider virtualbox. This will run all the scenarios under the Tests folder.
5. If you want to test locally using Hyper-V
   • Run vagrant plugin install vagrant-dsc
   • Run vagrant plugin install vagrant-winrm
   • Run vagrant plugin install vagrant-winrm-syncedfolders
   • Run vagrant up -- provider hyperv. This will run all the scenarios under the Tests folder.
6. If you want to test using AWS
   • Run vagrant plugin install vagrant-aws
   • Run vagrant plugin install vagrant-aws-winrm
   • Set an environment variable AWS_ACCESS_KEY_ID to a valid value
   • Set an environment variable AWS_SECRET_ACCESS_KEY to a valid value
   • Set an environment variable AWS_SUBNET_ID to a valid subnet where you want the instance launched
   • Set an environment variable AWS_SECURITY_GROUP_ID to a valid security group you want to assign to the instance
   • Run vagrant up --provider aws. This will run all the scenarios under the Tests folder.
7. If you want to test using Azure
   • Run vagrant plugin install vagrant-azure
   • Set an environment variable AZURE_VM_PASSWORD to a valid value
   • Set an environment variable AZURE_SUBSCRIPTION_ID to a valid value
   • Set an environment variable AZURE_TENANT_ID to a valid value
   • Set an environment variable AZURE_CLIENT_ID to a valid value
   • Srt an environment variable AZURE_CLIENT_SECRET to a valid value
   • Run vagrant up --provider azure. This will run all the scenarios under the Tests folder.
8. Run vagrant destroy -f once you have finished to kill the virtual machine.

Tests are written in ServerSpec, which is an infrastructure oriented layer over RSpec.

When creating a PR, please ensure that all existing tests run succesfully against VirtualBox, and please include a new scenario where possible. Before you start, please raise an issue to discuss your plans so we can make sure it fits with the goals of the project.