Examples/cTentacleAgent_ListeningTentacle.psm1
|
# Configures a listening tentacle and automatically registers it with the specified server # please see https://github.com/OctopusDeploy/OctopusDSC/blob/master/README-cTentacleAgent.md for all available options # use password from disk $password = Get-Content .\ExamplePassword.txt | ConvertTo-SecureString $ServiceCred = New-Object PSCredential "ServiceUser", $password Configuration SampleConfig { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="ReviewUnusedParameter does not capture parameter usage within a scriptblock. See https://github.com/PowerShell/PSScriptAnalyzer/issues/1472")] param ([string]$ApiKey, [string]$OctopusServerUrl, [string[]]$Environments, [string[]]$Roles, [int]$ListenPort, [string]$Space) Import-DscResource -Module OctopusDSC Node "localhost" { cTentacleAgent OctopusTentacle { Ensure = "Present" State = "Started" # Tentacle instance name. Leave it as 'Tentacle' unless you have more # than one instance Name = "Tentacle" OctopusServerUrl = $OctopusServerUrl ApiKey = $ApiKey Environments = $Environments Roles = $Roles # Spaces are supported for Octopus Server 2019.1 and above. If null or not specified, it uses the default space Space = $Space # How Tentacle will communicate with the server CommunicationMode = "Listen" ListenPort = $ListenPort TentacleServiceCredential = $ServiceCred # Only required if the external port is different to the ListenPort. e.g the tentacle is behind a loadbalancer TentacleCommsPort = 10900 # Where deployed applications will be installed by Octopus DefaultApplicationDirectory = "C:\Applications" # Where Octopus should store its working files, logs, packages etc TentacleHomeDirectory = "C:\Octopus" } } } |