octopusdeploy/tentacle

Octopus Tentacle Docker 镜像文档

镜像概述和主要用途

本镜像用于在容器中部署和运行 Octopus Tentacle。Octopus Tentacle 是 Octopus Deploy 的代理服务，负责与 Octopus Server 通信、执行部署任务、管理目标节点资源等核心功能。容器化部署使 Tentacle 的配置、扩展和维护更加便捷。

核心功能和特性

• 容器化部署：简化 Tentacle 在 Windows 容器环境中的安装与配置流程。
• 灵活的注册配置：通过环境变量自定义注册参数（如 Octopus Server 地址、API 密钥、环境、角色等）。
• 多模式通信：支持监听模式（Tentacle 开放端口等待 Server 连接）和轮询模式（Tentacle 主动轮询 Server）。
• Docker-in-Docker 支持：可选启用 Docker-in-Docker (DinD)，用于在 Tentacle 容器内运行其他容器镜像。
• 多环境与角色管理：可通过环境变量指定目标环境、角色、租户等属性，实现精细化部署目标分组。
• 多空间支持：支持将 Tentacle 注册到 Octopus Server 的指定空间（默认使用默认空间）。

使用场景和适用范围

适用系统环境

• Windows Server 2016 及以上版本
• Windows 10 及以上版本（专业版/企业版）

典型使用场景

• CI/CD 流水线中的容器化部署目标节点。
• 需要动态扩展或临时部署的 Tentacle 实例。
• 隔离环境中的部署测试（如开发、测试环境）。
• 统一管理多租户或多空间的部署目标。

详细的使用方法和配置说明

前提条件

系统要求

• 启用 Windows 容器功能：

  powershell
  Enable-WindowsOptionalFeature -Online -FeatureName containers –All
  

• （可选）若使用 Hyper-V 隔离模式，需启用 Hyper-V：

  powershell
  Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V –All
  

• 安装 Docker for Windows。

注意事项

• Linux 容器端口变更：对于 Linux 容器，版本 6.1.1271 及以上调整了内部监听端口。若升级至此版本，需更新端口映射配置：
  • 旧版本（<6.1.1271）：若使用 -p 10934:10934（自定义端口），需调整为 -p 10934:10933（容器内端口统一为 ***）。

部署示例

1. 基础 docker run 命令

在 Windows Server 2016 或 Windows 10 环境中执行以下命令启动 Tentacle 容器：

powershell
docker run --publish 10931:10933 `
           --tty --interactive `
           --env ListeningPort="10931" `
           --env ServerApiKey="API-WZ27UDXXAPCKUPZSH1WTG8YC80G" `
           --env TargetEnvironment="Test" `
           --env TargetRole="app-server" `
           --env ServerUrl="https://octopus.example.com" `
           --env PublicHostNameConfiguration="ComputerName" `
           --env ACCEPT_EULA="Y" `
           octopusdeploy/tentacle

2. Docker Compose 部署

推荐使用 docker-compose 管理容器网络和配置，示例参考 https://github.com/OctopusDeploy/OctopusTentacle/blob/main/docker-compose.yml%E3%80%82%E8%8B%A5%E6%89%8B%E5%8A%A8%E9%85%8D%E7%BD%AE%EF%BC%8C%E9%9C%80%E9%80%9A%E8%BF%87 docker network 创建自定义网络以确保容器间通信。

环境变量配置

端口说明

• *******：Tentacle 默认监听端口（监听模式下用于接收 Octopus Server 连接）。容器启动时需通过 -p 参数映射宿主机端口（如示例中的 10931:10933）。

附加信息

版本注意事项

• Linux 容器：版本 >=6.1.1271 调整了内部监听端口，由 ListeningPort 环境变量控制改为固定 10933。若升级前使用非默认端口（如 -p 10934:10934），需更新为 -p 10934:10933。

支持与反馈

如需技术支持，请联系 Octopus Support。

源码与示例

镜像源码及更多配置示例见 https://github.com/OctopusDeploy/OctopusTentacle%E3%80%82