解决 Docker 中 ‘The input device is not a TTY’ 错误

技术背景

在使用 Docker 运行容器时，有时会遇到 “The input device is not a TTY” 错误。TTY 是一种支持转义序列、光标移动等功能的终端接口，源于早期连接到大型机的哑终端，如今由 Linux 命令终端和 SSH 接口提供。当 Docker 尝试分配 TTY（使用 -t 选项），但运行环境没有可用的 TTY 时，就会出现该错误。例如在 Jenkins 等自动化工具中执行 Docker 命令时，就可能遇到此问题。

实现步骤

1. 移除 -it 标志

若不需要交互式模式和 TTY 支持，可直接从 docker run 命令中移除 -it 标志。例如，将原命令 docker run -v $PWD:/foobar -it cloudfoundry/cflinuxfs2 /foobar/script.sh 改为 docker run -v $PWD:/foobar cloudfoundry/cflinuxfs2 /foobar/script.sh。

2. 根据输入情况调整标志

• 有输入但非 TTY 输入：若有输入通过管道传递给 Docker 命令（如 xyz | docker ... 或 docker ... < input），可将 -it 改为 -i。
• 需要 TTY 支持但输入设备无 TTY：若应用程序需要 TTY 来启用输出的颜色格式化，或后续要使用合适的终端连接到容器，可将 -it 改为 -t。

3. 针对不同命令行接口的处理

• Windows 下使用 PowerShell：若在 Linux 或 macOS 上非终端环境中需要交互式终端，可使用 PowerShell，它支持 -it 标志。
• Windows 下使用 Git Bash：在 Git Bash 中，可在 docker 命令前添加 winpty，如 winpty docker exec -it some_container bash。

4. 使用 docker-compose 时的处理

使用 docker-compose exec 命令时，可使用 -T 标志禁用伪 TTY 分配。例如：docker-compose -f /srv/backend_bigdata/local.yml exec -T postgres backup。

5. 脚本中动态分配 TTY

在脚本中，可根据是否有可用的 TTY 动态决定是否使用 -t 选项。示例代码如下：

test -t 1 && USE_TTY="-t" 
docker run ${USE_TTY} ...

核心代码

动态分配 TTY 的脚本示例

DOCKER_RUN_OPTIONS="-i --rm"

# Only allocate tty if we detect one
if [ -t 0 ] && [ -t 1 ]; then
    DOCKER_RUN_OPTIONS="$DOCKER_RUN_OPTIONS -t"
fi

docker run $DOCKER_RUN_OPTIONS --name my-container-name my-image-tag

docker-compose 禁用 TTY 分配示例

docker-compose exec -T containerName php script.php

最佳实践

• 自动化脚本：在自动化脚本（如 Jenkins 管道）中，建议默认不使用 -it 标志，以避免 TTY 分配问题。若需要交互功能，可根据具体情况使用 -i 标志。
• 本地测试与生产环境分离：在本地开发环境中，可使用 TTY 分配以方便调试和交互；在生产环境或自动化流程中，移除 -it 标志或根据情况调整。
• 脚本灵活性：编写脚本时，可采用动态分配 TTY 的方式，使脚本在不同环境下都能正常工作。

常见问题

1. 使用 mysql -p 时密码提示不显示或无法输入

在使用 mysql -p 且未指定密码时，仅添加 -i 可能导致密码提示不显示，仅添加 -t 可能导致输入不被读取。此问题较复杂，可能需进一步调试或采用其他方式输入密码。

2. winpty 使用时出现文件路径错误

在使用 winpty 时，可能会出现类似 “OCI runtime exec failed: exec failed: container_linux.go:344: starting container process caused ‘exec: "D:/Git/usr/bin/bash.exe": stat D:/Git/usr/bin/bash.exe: no such file or directory’: unknown” 的错误。这是因为 winpty 会将类 Unix 文件路径参数转换为 Windows 格式，可使用 MSYS_NO_PATHCONV=1 关闭此行为。

3. 脚本中 -t 检查的疑惑

有人可能会疑惑为何 Docker 提示输入设备不是 TTY，但检查时需检查输出设备是否为 TTY。这是因为在判断是否分配 TTY 时，通常是基于输出设备的状态来决定的。