AWS Linux - Install Octopus Tentacle

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "43354ae1-c301-42f8-971d-6e659e4807b3",
  "Name": "AWS Linux - Install Octopus Tentacle",
  "Description": "This step template will install the latest tentacle on an AWS hosted, Linux virtual machine. This will also open the firewall for inbound traffic on port 10933 on the Security Group.\n<hr />\n*Note: Expects the AWS CLI and Powershell to be installed on the worker running this task*<br />\n*Note: Firewall ports will not be opened on the remote machine*</br>\n*Note: Target machines must be added to your AWS System Manager (SSM)*",
  "Version": 3,
  "ExportedAt": "2021-08-23T12:40:10.975Z",
  "ActionType": "Octopus.AwsRunScript",
  "Author": "benjimac93",
  "Packages": [],
  "Parameters": [
    {
      "Id": "dea51842-271f-48fa-901e-243488049f97",
      "Name": "awsInstallLinuxTentacle.AWSAccount",
      "Label": "AWS Account",
      "HelpText": "AWS account with permissions to the virtual machine in which to install the tentacle on",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "AmazonWebServicesAccount"
      }
    },
    {
      "Id": "6a97548c-3b97-4a19-8b9a-45aa58ac62d9",
      "Name": "awsInstallLinuxTentacle.awsRegion",
      "Label": "AWS Region",
      "HelpText": "The name of the aws region. I.E. `us-east-1`",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "d9efb017-65c0-4010-b09f-0a6a34fc009f",
      "Name": "awsInstallLinuxTentacle.awsSGName",
      "Label": "Security Group Name",
      "HelpText": "The name of the AWS security group to create an exception in",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "e4358aec-2798-412a-bcd2-1c7e41a0728d",
      "Name": "awsInstallLinuxTentacle.awsVmInstanceId",
      "Label": "VM Instance ID",
      "HelpText": "The instance ID of the virtual machine to target when ",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "8dbe0a29-4e0f-43f8-8ef2-ae23a2884e85",
      "Name": "awsInstallLinuxTentacle.octoServerThumb",
      "Label": "Server Thumbprint",
      "HelpText": "The Thumbprint of the octopus server",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Sensitive"
      }
    },
    {
      "Id": "a0859551-6c84-45d1-af2b-c57becb4e8ef",
      "Name": "awsInstallLinuxTentacle.octoApiKey",
      "Label": "Octo User API Key",
      "HelpText": "The API key used to configure the tentacle.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Sensitive"
      }
    },
    {
      "Id": "dd07815d-bfb7-43b9-90f8-21ec5a2d2953",
      "Name": "awsInstallLinuxTentacle.octopusRoles",
      "Label": "Roles",
      "HelpText": "Roles to assign to this tentacle installation. <br />\n*Note: Each role should be on it's own line*",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "d3ffb38e-7fcf-4547-be9a-6cd8e46f8e5e",
      "Name": "awsInstallLinuxTentacle.octopusEnvironments",
      "Label": "Environments",
      "HelpText": "Environments to assign this tentacle installation to.<br />\n*Note: Each environment should be on its own line*",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "MultiLineText"
      }
    },
    {
      "Id": "15150827-7bd3-4146-a798-66344851f602",
      "Name": "instrallTentacle.octoServerUrl",
      "Label": "Octo Server Url",
      "HelpText": "The server url to register the tentacle with.  Defaults to the base url",
      "DefaultValue": "#{if Octopus.Web.ServerUri}#{Octopus.Web.ServerUri}#{else}#{Octopus.Web.BaseUrl}#{/if}",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "9bcd6bb5-2db3-453f-b4f6-6a78f3c39b59",
      "Name": "awsInstallLinuxTentacle.tentacleType",
      "Label": "Tentacle Type",
      "HelpText": "Select between a listing or polling tentacle",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Select",
        "Octopus.SelectOptions": "TentaclePassive|Listening\nTentacleActive|Polling"
      }
    },
    {
      "Id": "6bb98570-fe3e-4ab7-adfb-79ef7ce5c2ce",
      "Name": "awsInstallLinuxTentacle.tentacleHostName",
      "Label": "Tentacle Host Name",
      "HelpText": "The host name to register the listening tentacles with. Octopus deploy server uses this value to reach out to the vm.<br />\n*Note: Leave blank to automatically use assigned public IP address.*",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "386d9f39-9e90-4215-b739-53a1af5bd105",
      "Name": "awsInstallLinuxTentacle.tentacleName",
      "Label": "Tentacle Name",
      "HelpText": "The name of the tentacle to use in the infrastructure area of octopus deploy.  Will use the host name if not provided",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "50621684-c2a5-47c0-9bfe-12f004022e60",
      "Name": "awsInstallLinuxTentacle.portNumber",
      "Label": "Port Number",
      "HelpText": "Port number used when installing and registered tentacle.  This is also the port opened on the firewall",
      "DefaultValue": "10933",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "PowerShell",
    "Octopus.Action.Azure.AccountId": "#{awsInstallLinuxTentacle.AWSAccount}",
    "Octopus.Action.Script.ScriptBody": "$sgName = $OctopusParameters[\"awsInstallLinuxTentacle.awsSGName\"]\n$instanceId = $OctopusParameters[\"awsInstallLinuxTentacle.awsVmInstanceId\"]\n$serverUri = $OctopusParameters[\"instrallTentacle.octoServerUrl\"]\n$apiKey = $OctopusParameters[\"awsInstallLinuxTentacle.octoApiKey\"]\n$rolesRaw = $OctopusParameters[\"awsInstallLinuxTentacle.octopusRoles\"]\n$enviroRaw = $OctopusParameters[\"awsInstallLinuxTentacle.octopusEnvironments\"]\n$octoThumb = $OctopusParameters[\"awsInstallLinuxTentacle.octoServerThumb\"]\n$comStyle = $OctopusParameters[\"awsInstallLinuxTentacle.tentacleType\"]\n$hostname = $OctopusParameters[\"awsInstallLinuxTentacle.tentacleHostName\"]\n$tentacleName = $OctopusParameters[\"awsInstallLinuxTentacle.tentacleName\"]\n$portNumber = $OctopusParameters[\"awsInstallLinuxTentacle.portNumber\"]\n\nWrite-Host \"Parsing Parameters\"\n\nif([string]::IsNullOrEmpty($sgName))\n{\n\tthrow \"Security Group name must be provided\"\n}\n\nif([string]::IsNullOrEmpty($instanceId))\n{\n\tthrow \"Instance Id must be provided\"\n}\n\nif([string]::IsNullOrEmpty($apiKey))\n{\n\tthrow \"apiKey must be provided\"\n}\n\nif([string]::IsNullOrEmpty($rolesRaw))\n{\n\tthrow \"At least one role must be defined\"\n}\n\nif([string]::IsNullOrEmpty($enviroRaw))\n{\n\tthrow \"At least one environment must be defined\"\n}\n\nif([string]::IsNullOrEmpty($octoThumb))\n{\n\tthrow \"octo thumbprint must be provided\"\n}\n\n$roles = \"\"\n$rolesRaw -split \"`n\" | ForEach-Object { $roles += \"--role $_ \"}\n$roles = $roles.TrimEnd(' ')\n\n$environments = \"\"\n$enviroRaw -split \"`n\" | ForEach-Object { $environments += \"--env $_ \"}\n$environments = $environments.TrimEnd(' ')\n\nif($comStyle -eq \"TentaclePassive\")\n{\n\tif([string]::IsNullOrEmpty($hostname))\n    {\n    \t$hostname = aws ec2 describe-instances --filters \"Name=instance-id,Values=$instanceId\" --query \"Reservations[].Instances[].NetworkInterfaces[].Association.PublicIp\" --output=text\n        $hostname = $hostname.Trim(\"`n\")\n    }\n    \n    $noListen = \"--port $portNumber --noListen `\"false`\"\"\n    $comStyle += \" --publicHostName='$hostname'\"\n    $openFirewall = 'true'\n}\nelse\n{\n\t$noListen = \"--noListen `\"true`\"\"\n    $openFirewall = 'false'\n}\n\nif([string]::IsNullOrEmpty($tentacleName))\n{\n\t$tentacleName = $hostname\n}\n\nif($openFirewall -eq 'true')\n{\n\tWrite-Host \"Checking SG...\" -NoNewline\n    $sgCheck = aws ec2 describe-security-groups --group-names $sgName --output json --filters Name=ip-permission.from-port,Values=$portNumber Name=ip-permission.cidr,Values='0.0.0.0/0' | convertfrom-json\n    \n    if($sgCheck.SecurityGroups.count -eq 0)\n    {\n\t\tWrite-Host \"Creating SG Rule\"\n    \taws ec2 authorize-security-group-ingress --group-name $sgName --ip-permissions IpProtocol=tcp,ToPort=$portNumber,FromPort=$portNumber,IpRanges='[{CidrIp=0.0.0.0/0,Description=\"OctopusListeningTentacle\"}]'\n\t}\n    else\n    {\n    \tWrite-Host \"Found Existing SG Rule\"\n    }\n}\n\nWrite-Verbose \"hostname: $hostname`nnoListen: $noListen\"\n\n$remoteScript = @\"\n{\n\t\"commands\": [\n    \t\"#!/bin/bash\",\n\t\t\"curl -L https://octopus.com/downloads/latest/Linux_x64TarGz/OctopusTentacle -o /tmp/tentacle-linux_x64.tar.gz -fsS\",\n\t\t\"if [ ! -d \\\"/opt/octopus\\\" ]; then sudo mkdir /opt/octopus; fi\",\n\t\t\"tar xvzf /tmp/tentacle-linux_x64.tar.gz -C /opt/octopus\",\n\t\t\"rm /tmp/tentacle-linux_x64.tar.gz\",\n\t\t\"cd /opt/octopus/tentacle\",\n\t\t\"sudo /opt/octopus/tentacle/Tentacle create-instance --config '/etc/octopus/default/tentacle-default.config'\",\n\t\t\"sudo chmod a+rwx /etc/octopus/default/tentacle-default.config\",\n\t\t\"/opt/octopus/tentacle/Tentacle new-certificate --if-blank\",\n\t\t\"/opt/octopus/tentacle/Tentacle configure --port $portNumber --noListen False --reset-trust --app '/home/Octopus/Applications'\",\n\t\t\"/opt/octopus/tentacle/Tentacle configure --trust $octoThumb\",\n\t\t\"echo 'Registering the Tentacle $name with server $serverUri in environment $environments with role $roles'\",\n\t\t\"/opt/octopus/tentacle/Tentacle register-with --server '$serverUri' --apiKey '$apikey' $environments $roles --comms-style $comStyle --name '$tentacleName' --force\",\n\t\t\"sudo /opt/octopus/tentacle/Tentacle service --install --start\"\n\t]\n}\n\"@\n\nWrite-Host \"Installing tentacle on remote machine\"\n$guid = (new-guid).guid\nSet-Content -Value $remoteScript -Path \"$env:Temp/$guid.json\"\n\nwrite-verbose $remoteScript\n\nwrite-verbose \"aws ssm send-command --document-name `\"AWS-RunShellScript`\" --instance-ids `\"$instanceId`\" --parameters `\"file://$env:Temp/$guid.json`\"\"\ntry {\n\t$cmdResponse = aws ssm send-command --document-name \"AWS-RunShellScript\" --instance-ids \"$instanceId\" --parameters \"file://$env:Temp/$guid.json\" --query \"Command\" --output json | convertfrom-json\n    $cmdId = $cmdResponse.CommandId\n    $errorResponse = aws ssm get-command-invocation --command-id \"$cmdId\" --instance-id \"$instanceId\" --output json | convertfrom-json\n    \n    while($errorResponse.Status -eq 'InProgress')\n    {\n    \twrite-verbose \"`nStatus: $($errorResponse.Status)\"\n    \t$errorResponse = aws ssm get-command-invocation --command-id \"$cmdId\" --instance-id \"$instanceId\" --output json | convertfrom-json\n    }\n    \n    write-verbose \"`nErrorResponse: $errorResponse`n\"\n    \n    if(![string]::IsNullOrEmpty($errorResponse.StandardErrorContent))\n    {\n    \tthrow $errorResponse.StandardErrorContent\n    }\n}\nfinally {\n\tremove-item \"$env:Temp\\$guid.json\"\n}\n",
    "Octopus.Action.Aws.AssumeRole": "False",
    "Octopus.Action.AwsAccount.UseInstanceRole": "False",
    "Octopus.Action.AwsAccount.Variable": "#{awsInstallLinuxTentacle.AWSAccount}",
    "Octopus.Action.Aws.Region": "#{awsInstallLinuxTentacle.awsRegion}"
  },
  "Category": "AWS",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/aws-linux-install-tentacle.json",
  "Website": "/step-templates/43354ae1-c301-42f8-971d-6e659e4807b3",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAADNQTFRF////9o0R/eLD/Nu0/erS95Qg+bhr95sv/vHh+r96/vjw+bFc/NSl+KI++82W+saI+KpNeDqM1wAAA41JREFUeNrsnG2XazAURiuo0Cr//9feliIvR3DvXJFZe3+a6XpW5+xWEpyY2w0AAAAAAAAAAAAAAAAAAADgf1J0bda/9N70q83a3enzUHWVjbR1sW0xp6sd6fPI72VmUt3zA+kymD6N5vnIBMrHsxHTjsUXOX0e+iVaTNU5Q0A/Q+k+4oAp+ixMbw6A4rGVVjGHR92ulNXWuTAlBNJN/FFyr5yy3qN9rawmF9IxR4hqX4U1WMplmGtruVBDuiuswbKkzaGhX+cfXsqbZlXXv0dsYR13nw9fLenGXD7f6U5Ony4yTpzyZLNMUcpMr0xNzfwdRRMR1/LP2cqMctNqKx1LZFydm2U022ueEtLL6HbHfmSRYRn4HDXaXyzU4XRkkZWK/+JlRBBBBBFEEEEEEUQQQQQRRBBB5B9uYJc7SyuLw+nI7R2ptKWJcywd18Utza0rnM4iN66M6qzS5E93Lf1zLaviUL/ISs/Nt6W00DEyuRgiP2Yxvrd15z/Y26ncG76jy1Ta5jEy/L0p/VMWy33woVm8UYN1Y9fqKrzfZ5iedtaV34+kNxHak2Wg2SSkY7djx/bQWkNP6nkE0lH3Lyx7D1aak1Z1erWJ+U130Vz0Sude7mZqv995nW7mZxJd27Sg5XQppuMdWY3xl1XXOge8MasWjZfund0KbvrkE9fK7OPNne+2U9YEWX3nemtSbvLv6LJ7gZ9X45yBl9ZxrZ9d3vjT8rz62tOsny7jXkpYPX9jQmvF8yF55TdaslGviZy1vAmfoTobsZztGNEv7qZZSr/6HRc/0yzlb3HiKhURRBBBBBFEEEEEEUQQQQQRRBD5XSLav38tllbVzeH02Ww/UWA+6XgsHdXFKc2vK5Quoz/duVRnlrb26crpizzXOVU3l2Zb5Pfe+d1OX8ViqW7qH9gt51K44bukr2XxrW54vMaoy7mxa/cgvPRVKcQG7uOCD58HLQLt3r17Iy6AqjYeDG7TUenWW+p9Ot/IOF/lwuHV1nk6o8M469PWXhtr+0BeX/x7Ue40W3xacfb2gXFxUZcX8TYB3Kyfp+GThsjKti2zgZuMiLshxW3gpiQyrn/DXhR/i1NqIte5pkUEEUQQQQQRRBBBBBFEEEEEEUR+g4jQUZBEqjqFO9mOiyeShoXvYoukZOG4GCLpWZgu83/vTNRidhlE0rYAAAAAAAAAAAAAAAAAAACAZPkjwAAMDi+bsnPP/wAAAABJRU5ErkJggg==",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History