SaltStack 远程命令实行中文乱码问题

问题

我在一台服务器上写了一个简单的 Python 脚本 haha.py，内容如下：

1. [root@localhost ~]# cat haha.py
2. print("你好")

复制代码

当我在本地直接运行这个脚本时，一切正常，但当我通过 SaltStack 的 cmd.run 模块，在另一台机器上远程实行这个脚本时，问题就出现了：

1. [root@localhost ~]# salt 192.168.149.130 cmd.run  "python3 /root/haha.py"                                      
2. 192.168.149.130:
3.     Traceback (most recent call last):
4.       File "/root/haha.py", line 1, in <module>
5.         print("\u4f60\u597d")
6.     UnicodeEncodeError: 'ascii' codec can't encode characters in position 0-1: ordinal not in range(128)
7. ERROR: Minions returned with non-zero exit code

复制代码

从 Minion 返回的错误可以看出，UnicodeEncodeError 指向的是字符编码问题，Python 在输出中文字符时试图使用 ASCII 编码，但碰到了无法编码的字符，导致程序报错。
这个问题只在通过 SaltStack 远程实行时出现，而在本地运行并无任何异常，因此可以初步判断是远程实行环境下的字符集设置（locale）引起的编码错误。
排查

在本地实行 locale 命令，结果如下：

1. [root@localhost ~]# locale
2. LANG=zh_CN.UTF-8
3. LC_CTYPE="zh_CN.UTF-8"
4. LC_NUMERIC="zh_CN.UTF-8"
5. LC_TIME="zh_CN.UTF-8"
6. LC_COLLATE="zh_CN.UTF-8"
7. LC_MONETARY="zh_CN.UTF-8"
8. LC_MESSAGES="zh_CN.UTF-8"
9. LC_PAPER="zh_CN.UTF-8"
10. LC_NAME="zh_CN.UTF-8"
11. LC_ADDRESS="zh_CN.UTF-8"
12. LC_TELEPHONE="zh_CN.UTF-8"
13. LC_MEASUREMENT="zh_CN.UTF-8"
14. LC_IDENTIFICATION="zh_CN.UTF-8"
15. LC_ALL=

复制代码

但是如果通过 salt 远程实行，结果如下：

1. [root@localhost ~]# salt 192.168.149.130 cmd.run  "locale"
2. 192.168.149.130:
3.     locale: Cannot set LC_CTYPE to default locale: No such file or directory
4.     locale: Cannot set LC_ALL to default locale: No such file or directory
5.     LANG=zh_CN.UTF-8
6.     LC_CTYPE=c
7.     LC_NUMERIC=c
8.     LC_TIME=C
9.     LC_COLLATE=C
10.     LC_MONETARY=C
11.     LC_MESSAGES=C
12.     LC_PAPER=C
13.     LC_NAME=C
14.     LC_ADDRESS=C
15.     LC_TELEPHONE=C
16.     LC_MEASUREMENT=C
17.     LC_IDENTIFICATION=C
18.     LC_ALL=

复制代码

可以看到，通过 Salt 远程实行时，locale 设置与本地环境存在明显差别，字符集从 zh_CN.UTF-8 被回退为 C。这会导致在 Salt 进程中实行某些脚本时出现字符编码相关的问题，比方中文乱码、编码异常等。

• locale
  

在 CentOS（或任何 Linux 体系）中，locale 指的是本地化环境设置，即体系如何根据用户所在的地区、语言和文化习惯来展示信息。
locale 包含多个变量，常见的有：
变量控制内容LANG默认语言和编码设置（全局默认）LC_ALL一键覆盖全部其他变量（最高优先级）LC_CTYPE字符分类与编码，如大小写、字符集等LC_TIME时间和日期格式LC_NUMERIC小数点和数字分隔符LC_MONETARY钱币符号与格式LC_MESSAGES体系消息语言LC_COLLATE字符串排序规则（如按拼音或 ASCII）

• LANG 和 LC_*
  

在 CentOS 或任何基于 Linux 的体系中，LANG 和 LC_* 都属于语言环境（Locale）配置变量，用于控制体系的语言、字符编码和区域设置（如时间格式、钱币符号、数字格式等）。
它们之间是有层级和覆盖关系的，不是对立的，而是协同工作的。

LANG 是默认语言环境设置，而 LC_* 是针对具体区域功能（如时间、数字、字符处置惩罚等）的细化设置，优先级高于 LANG。

优先级：

• LC_ALL（最高优先级）：一旦设置，覆盖全部 LC_* 和 LANG 的值
  
• LC_* 单独变量：控制特定功能区域的行为
  
• LANG（最低优先级）：仅作为默认值使用
  

举个例子：

1. LANG=en_US.UTF-8
2. LC_TIME=zh_CN.UTF-8

复制代码

默认体系语言是英文（由 LANG 控制），但显示时间时使用中文格式（由 LC_TIME 控制），如果设置了 LC_ALL=ja_JP.UTF-8，上面两个设置都会被忽略，统一使用日文格式。
查看当前设置：

1. locale

复制代码

临时设置：（当前 shell 有效）：

1. export LC_TIME=zh_CN.UTF-8

复制代码

永久设置：（写入 /etc/locale.conf 或 ~/.bash_profile）：

1. echo 'LANG=zh_CN.UTF-8' >> /etc/locale.conf

复制代码

我们注意到，在使用 salt 命令实行远程命令时，其内部调用的是 cmd.run 模块。接下来，我们查看其源代码文件 /usr/lib/python3.6/site-packages/salt/modules/cmdmod.py，查找与 locale 相关的设置。
在源码中可以看到如下片断：

1.     if reset_system_locale is True:
2.         if not salt.utils.platform.is_windows():
3.             # Default to C!
4.             # Salt only knows how to parse English words
5.             # Don't override if the user has passed LC_ALL
6.             env.setdefault("LC_CTYPE", "c")
7.             env.setdefault("LC_NUMERIC", "c")
8.             env.setdefault("LC_TIME", "C")
9.             env.setdefault("LC_COLLATE", "C")
10.             env.setdefault("LC_MONETARY", "C")
11.             env.setdefault("LC_MESSAGES", "C")
12.             env.setdefault("LC_PAPER", "C")
13.             env.setdefault("LC_NAME", "C")
14.             env.setdefault("LC_ADDRESS", "C")
15.             env.setdefault("LC_TELEPHONE", "C")
16.             env.setdefault("LC_MEASUREMENT", "C")
17.             env.setdefault("LC_IDENTIFICATION", "C")
18.             env.setdefault("LANGUAGE", "C")

复制代码

从上面的代码可以看出，当 reset_system_locale=True 且非 Windows 体系时，Salt 会强制将实行命令时的环境变量 LC_* 和 LANGUAGE 设置为 "C"。这是为了确保 Salt 在解析命令输出时使用英文环境，制止因本地化语言导致的格式差别。
也正因如此，当我们通过 salt 实行 locale 命令时，会看到字符集与本地登录环境差别等，从而可能引发编码、字符处置惩罚等问题。
办理

针对 Salt 远程实行命令时字符集异常的问题，可以采用以下几种方式进行办理：

• 方法一：在 Salt 命令中显式禁用默认 locale 重置
  

Salt 默认会重置实行环境的 locale，我们可以通过设置 reset_system_locale=False 参数来克制该行为，从而保存本地的字符集设置。

1. [root@localhost ~]# salt 192.168.149.130 cmd.run "locale" reset_system_locale=False

复制代码

• 办法二：使用 source /etc/locale.conf 加载体系字符集配置
  

可以先在目标机器上配置好 /etc/locale.conf 文件，设置合适的 locale 值：

1. [root@localhost ~]# cat /etc/locale.conf
2. LANG="zh_CN.UTF-8"
3. LC_CTYPE="zh_CN.UTF-8"

复制代码

然后，在实行 Salt 命令时通过 source 命令加载该配置，使 Minion 进程继承这些环境变量：

1. [root@localhost ~]# salt 192.168.149.130 cmd.run  "source /etc/locale.conf && locale"

复制代码

• 办法三：修改 Minion 的 systemd 服务文件，注入环境变量
  

你也可以从体系服务层面为 Minion 进程注入环境变量，确保其启动时即继承正确的 locale 设置。
方案 A：直接在服务文件中设置环境变量

1. [root@localhost ~]# cat /usr/lib/systemd/system/salt-minion.service
2. [Unit]
3. Description=The Salt Minion
4. Documentation=man:salt-minion(1) file:///usr/share/doc/salt/html/contents.html https://docs.saltstack.com/en/latest/contents.html
5. After=network.target salt-master.service
7. [Service]
8. Environment="LC_CTYPE=zh_CN.UTF-8"
9. KillMode=process
10. Type=notify
11. NotifyAccess=all
12. LimitNOFILE=8192
13. ExecStart=/usr/bin/salt-minion
15. [Install]
16. WantedBy=multi-user.target

复制代码

方案 B：使用 EnvironmentFile 引用体系 locale 配置
首先在 /etc/locale.conf 中写入所需配置：

1. [root@localhost ~]# cat /etc/locale.conf
2. LANG="zh_CN.UTF-8"
3. LC_CTYPE="zh_CN.UTF-8"

复制代码

然后修改服务文件，引用该配置文件：

1. [root@localhost ~]# cat /usr/lib/systemd/system/salt-minion.service
2. [Unit]
3. Description=The Salt Minion
4. Documentation=man:salt-minion(1) file:///usr/share/doc/salt/html/contents.html https://docs.saltstack.com/en/latest/contents.html
5. After=network.target salt-master.service
7. [Service]
8. EnvironmentFile=/etc/locale.conf
9. KillMode=process
10. Type=notify
11. NotifyAccess=all
12. LimitNOFILE=8192
13. ExecStart=/usr/bin/salt-minion
15. [Install]
16. WantedBy=multi-user.target

复制代码

修改完后，别忘了实行以下命令使配置生效：

1. systemctl daemon-reload
2. systemctl restart salt-minion

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。