modules/teamcityExtensions/_deploy/deploy.ps1
|
<#
The MIT License (MIT) Copyright (c) 2015 Objectivity Bespoke Software Specialists Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> <# .SYNOPSIS Starts the deployment process using configuration scripts residing in $DeployConfigurationPath. .DESCRIPTION It will deploy packages available in $PackagesPath to the $Environment, using configuration scripts at $DeployConfigurationPath. .PARAMETER ProjectRootPath Base directory of the project, relative to the directory where this script resides. It is used as a base directory for other directories. .PARAMETER PSCILibraryPath Base directory where PSCI library resides, relative to $ProjectRootPath. .PARAMETER PackagesPath Path to the directory where packages reside, relative to $ProjectRootPath. .PARAMETER DeployConfigurationPath Path to the directory where configuration files reside, relative to $ProjectRootPath. By default '$ProjectRootPath\deploy' or '$PackagesPath\DeployScripts\deploy'. .PARAMETER Environment Environment where the packages should be deployed (chooses ServerRoles / Tokens specified in the configuration scripts). .PARAMETER TokensOverride A hashtable containing tokens to override during this deployment. For example, if you don't want to store Live credentials in your configuration files, you can pass them using this parameter. It should be a 'flat' hashtable containing only token names and their values (no categories). .PARAMETER ServerRolesFilter Allows to limit server roles to deploy. .PARAMETER NodesFilter List of Nodes where steps will be deployed - can be used if you don't want to deploy to all nodes defined in the configuration files. If not set, steps will be deployed to all nodes according to the ServerRoles defined in the configuration files. .PARAMETER StepsFilter List of Steps to deploy - can be used if you don't want to deploy all steps defined in the configuration files. If not set, steps will be deployed according to the ServerRoles defined in the configuration files. .PARAMETER DeployType Deployment type: - All - deploy everything according to configuration files (= Provision + Deploy) - Provision - deploy only provisioning steps (-StepsProvision) - Deploy - deploy only deploy steps (-StepsDeploy / -Steps) - Adhoc - deploy steps defined in $StepsFilter to server roles defined in $ServerRolesFilter and/or nodes defined in $NodesFilter (note the steps do not need to be defined in server roles) #> param( [Parameter(Mandatory=$false)] [string] $ProjectRootPath = '.', # Modify this path according to your project structure. This is relative to the directory where deploy.ps1 resides ($PSScriptRoot). [Parameter(Mandatory=$false)] [string] $PSCILibraryPath = '..\..\..', # Modify this path according to your project structure. This is absolute or relative to $ProjectRootPath. [Parameter(Mandatory=$false)] [string] $PackagesPath = '', # Modify this path according to your project structure. This is absolute or relative to $ProjectRootPath. Leave empty for packageless deployment. [Parameter(Mandatory=$false)] [string] $DeployConfigurationPath = '', # Modify this path according to your project structure. This is absolute or relative to $ProjectRootPath (by default '$ProjectRootPath\deploy' or '$PackagePath\DeployScripts\deploy'). [Parameter(Mandatory=$false)] [string[]] $Environment = 'Default', [Parameter(Mandatory=$false)] [hashtable] $TokensOverride, [Parameter(Mandatory=$false)] [string[]] $ServerRolesFilter = 'Psci', [Parameter(Mandatory=$false)] [string[]] $StepsFilter, [Parameter(Mandatory=$false)] [string[]] $NodesFilter, [Parameter(Mandatory=$false)] [ValidateSet('All', 'Provision', 'Deploy', 'Adhoc')] [string] $DeployType = 'All' ) $global:ErrorActionPreference = "Stop" try { ############# Initialization Push-Location -Path $PSScriptRoot if (![System.IO.Path]::IsPathRooted($PSCILibraryPath)) { $PSCILibraryPath = Join-Path -Path $ProjectRootPath -ChildPath $PSCILibraryPath } if (!(Test-Path "$PSCILibraryPath\PSCI.psd1")) { Write-Output -InputObject "Cannot find PSCI library at '$PSCILibraryPath'. Please ensure your ProjectRootPath and PSCILibraryPath parameters are correct." exit 1 } Import-Module "$PSCILibraryPath\PSCI.psd1" -Force $PSCIGlobalConfiguration.LogFile = "$PSScriptRoot\deploy.log.txt" Remove-Item -LiteralPath $PSCIGlobalConfiguration.LogFile -ErrorAction SilentlyContinue Initialize-ConfigurationPaths -ProjectRootPath $ProjectRootPath -PackagesPath $PackagesPath -DeployConfigurationPath $DeployConfigurationPath -ValidatePackagesPath ############# Deployment - no custom code here, you need to put your configuration scripts under 'configuration' directory # This will start the deployment according to configuration files from $DeployConfigurationPath Start-Deployment -Environment $Environment ` -ServerRolesFilter $ServerRolesFilter ` -StepsFilter $StepsFilter ` -NodesFilter $NodesFilter ` -TokensOverride $TokensOverride ` -DeployType $DeployType } catch { Write-ErrorRecord -ErrorRecord $_ } finally { Pop-Location } |