octopuslabs/tentacle-nodejsworker

Docker NodeJS Linux Worker 镜像文档

镜像概述和主要用途

这是一个基于Linux的Docker镜像，包含Octopus Deploy的tentacle组件，支持执行nodejs命令。该镜像基于https://hub.docker.com/r/octopuslabs/tentacle%E6%9E%84%E5%BB%BA%EF%BC%8C%E9%9B%86%E6%88%90%E4%BA%86%E5%A4%9A%E7%A7%8D%E5%BC%80%E5%8F%91%E8%BF%90%E7%BB%B4%E5%B7%A5%E5%85%B7%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E6%B3%A8%E5%86%8C%E4%B8%BAOctopus Server的worker或target，以支持自动化部署任务。

注意：此镜像为Octopus Advisory Team提供的示例，用于帮助用户构建自定义镜像，内部使用且适用于99%的使用场景，但非官方支持。如遇问题，请不要联系支持团队。如需创建自定义镜像，建议使用https://hub.docker.com/r/octopuslabs/tentacle%E8%80%8C%E9%9D%9E%E6%AD%A4%E9%95%9C%E5%83%8F%E3%80%82

核心功能和特性

该镜像包含以下工具和组件：

• PowerShell Core
• Octopus Deploy CLI
• python
• groff
• az modules
• azure cli（Azure命令行工具）
• gcp cli（Google Cloud命令行工具）
• aws cli（AWS命令行工具）
• eks cli（Amazon EKS命令行工具）
• ecs cli（Amazon ECS命令行工具）
• aws IAM authenticator（AWS IAM认证工具）
• openssh-client（SSH客户端）
• git（版本控制工具）
• terraform（基础设施即代码工具）
• nodejs（JavaScript运行时环境）

使用场景和适用范围

适用于需要在Octopus Deploy中执行以下任务的场景：

• 运行nodejs相关部署脚本
• 使用云服务（AWS、Azure、GCP）的命令行工具进行资源管理
• 通过terraform管理基础设施
• 执行Git操作或SSH远程任务
• 进行PowerShell Core脚本编写和执行

推荐将此镜像用作worker，以处理Octopus Deploy中的自动化部署任务。

使用限制

容器存在以下限制：

1. 仅允许运行一个tentacle实例。
2. 只能作为target或worker，不能同时作为两者。推荐作为worker使用。

环境变量配置

以下环境变量用于配置tentacle与Octopus Server的注册和通信：

• SERVER_API_KEY：tentacle注册到Octopus Server所需的https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key%E3%80%82
• SERVER_USERNAME：不使用API密钥时，注册tentacle到Octopus Server的用户名。
• SERVER_PASSWORD：不使用API密钥时，注册tentacle的密码。
• SERVER_URL：tentacle需要注册的Octopus Server的URL。
• TARGET_WORKER_POOL：要添加到目标的https://octopus.com/docs/infrastructure/workers/worker-pools%E9%80%97%E5%8F%B7%E5%88%86%E9%9A%94%E5%88%97%E8%A1%A8%E3%80%82%E5%A6%82%E6%9E%9C%E8%AE%BE%E7%BD%AE%E6%AD%A4%E5%8F%98%E9%87%8F%EF%BC%8C%E5%AE%B9%E5%99%A8%E5%B0%86%E6%B3%A8%E5%86%8C%E4%B8%BAworker%EF%BC%9B%E5%A6%82%E4%BD%9C%E4%B8%BAtarget%E5%88%99%E4%B8%8D%E9%9C%80%E8%A6%81%E3%80%82
• REGISTRATION_NAME：可选的目标名称，默认为主机名。
• SERVER_PORT：tentacle轮询工作的Octopus Server端口，默认为***。
• LISTENING_PORT：Octopus Server连接tentacle的端口，默认为***。
• SPACE：注册tentacle的https://octopus.com/docs/administration/spaces%E5%90%8D%E7%A7%B0%EF%BC%8C%E9%BB%98%E8%AE%A4%E4%B8%BA%22Default%22%E3%80%82
• COMMUNICATION_TYPE：tentacle通信类型，可选https://octopus.com/docs/infrastructure/deployment-targets/windows-targets/tentacle-communication%EF%BC%8C%E9%BB%98%E8%AE%A4%E4%B8%BA%22Polling%22%EF%BC%88%E8%BD%AE%E8%AF%A2%EF%BC%89%E3%80%82
• MACHINE_POLICY_NAME：关联容器的https://octopus.com/docs/infrastructure/deployment-targets/machine-policies%E5%90%8D%E7%A7%B0%EF%BC%8C%E9%BB%98%E8%AE%A4%E4%B8%BA%22Default Machine Policy"。
• ACCEPT_EULA：必须接受https://octopus.com/legal/customer-agreement%E3%80%82

端口说明

• *******：当tentacle处于监听模式时的监听端口。

使用示例

Docker Compose - 轮询模式Worker

.ENV文件

OCTOPUS_LINUX_TENTACLE=octopuslabs/tentacle-nodejsworker: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文件

yaml
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}