Docker Linux Tentacle

This repository contains the docker files to build a sample Linux-based Docker image that houses a tentacle for Octopus Deploy.

Please note that this is not the docker file used by Octopus Tentacle.

This docker image is provided as is

This docker image was created by the Octopus Advisory Team as an example for our users so they could build their own docker images. It is used internally and it should work for 99% of your use cases, it is not officially supported. Please do not contact support if you run into issues with this image.

Images

There are seven images to help get you started.

• tentacle: this is the base image which includes just enough to run the tentacle. Based on mcr.microsoft.com/dotnet/core/runtime-deps.
• tentacle-worker: includes a variety of software to get started using this tentacle as a worker. Based on tentacle.
• tentacle-k8sworker: similar to the tentacle-worker but only includes the software useful for kubernetes deployments. Based on tentacle.
• tentacle-dotnetcoreworker: similar to the tentacle-worker but only includes the software useful when deployments need to do work with .NET Core. Based on tentacle.
• tentacle-javaworker: similar to the tentacle-worker but only includes the software useful when deployments need to do work with Java. Based on tentacle.
• tentacle-nodejsworker: similar to the tentacle-worker but only includes the software useful when deployments need to do work with Node.js. Based on tentacle.
• tentacle-executioncontainer: only includes the necessary software to run the execution container feature in Octopus Deploy. Based on mcr.microsoft.com/dotnet/core/runtime-deps.
• tentacle-multiserverpolling: modified tentacle container that supports registering with multiple servers using a comma separated list in the ServerUrl environment variable. Based on octopusdeploy/tentacle.

Tentacle

This is the bare bones to run a tentacle as a docker container. It is based on the latest .NET Core runtime dependencies 3.1-bionic image provided by Microsoft.

It includes the following software:

• wget
• unzip
• apt-utils
• curl
• software-properties-common

If you are going to create a custom image, this is the one to create it from.

Tentacle-Worker

Built on top of the tentacle image. It includes useful software so it can be used as a worker. It includes all the software from the tentacle image plus:

• PowerShell Core
• Octopus Client
• Octopus Deploy CLI
• python
• groff
• az modules
• azure cli
• jdk
• maven
• gradle
• gcp cli
• aws cli
• eks cli
• ecs cli
• aws IAM authenticator
• openssh-client
• git
• kubectl
• terraform
• nodejs
• helm
• istio
• linkerd
• skopeo
• .NET Core SDK

Tentacle-K8sWorker

Built on top of the tentacle image. Unlike the tentacle-worker, this only includes the software necessary for kubernetes deployments.

• az modules
• azure cli
• gcp cli
• aws cli
• eks cli
• ecs cli
• aws IAM authenticator
• openssh-client
• git
• kubectl
• helm
• istio
• linkerd
• skopeo

Tentacle-dotnetcoreworker

Built on top of the tentacle image. Unlike the tentacle-worker, this only includes the software necessary when the deployment needs to invoke .NET core commands.

• PowerShell Core
• Octopus Client
• Octopus Deploy CLI
• python
• groff
• az modules
• azure cli
• gcp cli
• aws cli
• eks cli
• ecs cli
• aws IAM authenticator
• openssh-client
• git
• terraform
• nodejs
• .NET Core SDK

Tentacle-javaworker

Built on top of the tentacle image. Unlike the tentacle-worker, this only includes the software necessary when the deployment needs to invoke Java SDK commands.

• PowerShell Core
• Octopus Deploy CLI
• python
• groff
• az modules
• azure cli
• jdk
• maven
• gradle
• gcp cli
• aws cli
• eks cli
• ecs cli
• aws IAM authenticator
• openssh-client
• git
• terraform
• nodejs

Tentacle-nodejsworker

Built on top of the tentacle image. Unlike the tentacle-worker, this only includes the software necessary when the deployment needs to invoke nodejs commands.

• PowerShell Core
• Octopus Deploy CLI
• python
• groff
• az modules
• azure cli
• gcp cli
• aws cli
• eks cli
• ecs cli
• aws IAM authenticator
• openssh-client
• git
• terraform
• nodejs
• helm

Tentacle-ExecutionContainer

Built on top of the tentacle image. It includes all the software from the base tentacle image plus the necessary software to use the execution container feature in Octopus Deploy.

Tentacle-MultiServerPolling

Built on top of the tentacle image. Does not include any additional tooling, but instead supports registering with multiple servers by passing a comma delimited list to the ServerUrl environment variable.

Docker Image information

The docker container has a few self-imposed limitations.

1. Only one tentacle instance allowed.
2. Can either be a target OR a worker. It cannot be both.

Environment variables

• SERVER_API_KEY: The API Key of the Octopus Server the Tentacle should register with.
• SERVER_USERNAME: If not using an api key, the user to use when registering the Tentacle with the Octopus Server.
• SERVER_PASSWORD: If not using an api key, the password to use when registering the Tentacle
• SERVER_URL: The Url of the Octopus Server the Tentacle should register with.
• TARGET_ENVIRONMENT: Comma-delimited list of environments to add this target to.
• TARGET_ROLE: Comma delimited list of roles to add to this target.
• TARGET_WORKER_POOL: Comma-delimited list of worker pools to add to this target to. Not needed if this container will be a target. If set then the container will be registered as a worker.
• REGISTRATION_NAME: Optional Target name, defaults to host.
• SERVER_PORT: The port on the Octopus Server that the Tentacle will poll for work. Defaults to 10943.
• LISTENING_PORT: The port that the Octopus Server will connect back to the Tentacle with. Defaults to 10933.
• SPACE: The name of the space to register the tentacle with. Default is Default.
• COMMUNICATION_TYPE: Whether you are using polling tentacles or listening tentacles. Default is Polling.
• MACHINE_POLICY_NAME: The name of the machine policy to associate the container with. Defaults to Default Machine Policy.
• DISABLE_DIND: Indicates if docker in docker should be disabled. Defaults to N. Only for tentacle-executioncontainer image only.
• ACCEPT_EULA: You must accept the Octopus Deploy EULA.

Ports

• 10933: Port tentacle will be listening on (if in listening mode).

Examples

Here are some examples to help get you started using the tentacle

Docker Compose - Polling Deployment Target

.ENV File

OCTOPUS_LINUX_TENTACLE=octopuslabs/tentacle:latest
ACCEPT_OCTOPUS_EULA=Y
OCTOPUS_SERVER_URL=https://yoururltooctopus.com
OCTOPUS_SERVER_API_KEY=YOUR API KEY
OCTOPUS_ENVIORNMENT="Test,Production"
OCTOPUS_ROLE="TestRole01,TestRole-02"
OCTOPUS_TARGET_NAME=DockerTarget-01

docker-compose.yml file

version: '3'
services:  
  octopusworker:
    image: ${OCTOPUS_LINUX_TENTACLE}
    privileged: true
    environment:
      ACCEPT_EULA: ${ACCEPT_OCTOPUS_EULA}
      SERVER_URL: ${OCTOPUS_SERVER_URL}
      SERVER_API_KEY: ${OCTOPUS_SERVER_API_KEY}            
      TARGET_ENVIRONMENT: ${OCTOPUS_ENVIORNMENT}      
      TARGET_ROLE: ${OCTOPUS_ROLE}
      REGISTRATION_NAME: ${OCTOPUS_TARGET_NAME}

Docker Compose - Polling Worker

.ENV File

OCTOPUS_LINUX_TENTACLE=octopuslabs/tentacle:latest
ACCEPT_OCTOPUS_EULA=Y
OCTOPUS_SERVER_URL=https://yoururltooctopus.com
OCTOPUS_SERVER_API_KEY=YOUR API KEY
OCTOPUS_WORKER_POOL="DEMO WORKER POOL"
OCTOPUS_TARGET_NAME=DockerWORKER-01

docker-compose.yml file

version: '3'
services:  
  octopusworker:
    image: ${OCTOPUS_LINUX_TENTACLE}
    privileged: true
    environment:
      ACCEPT_EULA: ${ACCEPT_OCTOPUS_EULA}
      SERVER_URL: ${OCTOPUS_SERVER_URL}
      SERVER_API_KEY: ${OCTOPUS_SERVER_API_KEY}            
      TARGET_WORKER_POOL: ${OCTOPUS_WORKER_POOL}            
      REGISTRATION_NAME: ${OCTOPUS_TARGET_NAME}