Keep learning, keep living...

0%

Docker环境中systemd环境变量实验

发表于 更新于 分类于

我们的业务Docker镜像是在centos/systemd镜像基础上构建的，业务进程由systemd来启动。最近需要对业务逻辑进行改造，需要识别传入的环境变量。看上去是相当简单的改动，但在我们的进程中加入读取环境变量的逻辑却发现读取不到传入的变量内容，最终定位原因是在systemd的环境变量的处理。

下面用简单的示例来说明。

首先基于centos/systemd构建实验镜像。创建三个文件:
Dockerfile, envdemo.service, envdemo.sh。

Dockerfile内容如下:

1
2
3
4
5
6
7
8
9
10
FROM centos/systemd:latest

COPY envdemo.service /usr/lib/systemd/system/

RUN mkdir /app
COPY envdemo.sh /app
RUN chmod a+x /app/envdemo.sh
WORKDIR /app

RUN systemctl enable envdemo.service

envdemo.service内容如下:

1
2
3
4
5
6
7
8
9
[Unit]
Description=Environment Variables Demo Service

[Service]
Type=simple
ExecStart=/app/envdemo.sh

[Install]
WantedBy=multi-user.target

envdemo.sh内容如下:

1
2
3
4
5
6
7
8
9
10
#!/bin/bash

exec >>/var/log/envdemo.log 2>&1

while true
do
    date
    echo "ENV_DEMO=${ENV_DEMO}"
    sleep 3
done

systemd镜像的CMD为/usr/sbin/init, 它实际链接的就是systemd:

1
2
[root@c6b3a7575cf6 app]# ls -l /usr/sbin/init
lrwxrwxrwx. 1 root root 22 Dec  5  2018 /usr/sbin/init -> ../lib/systemd/systemd

我们的进程/app/envdemo.sh由systemd启动运行。尽管docker推荐在一个镜像中只运行一个进程，但在一些需要运行多个服务的场景，用systemd启动这种方式还是比较优雅的。

构建我们的镜像:

1
docker build --rm --no-cache -t envdemo .

然后执行容器:

1
docker run --name envdemo --rm -d --privileged -e ENV_DEMO="hello" envdemo

之后进行容器查看:

1
2
3
[root@default envdemo]# docker exec -it envdemo bash
[root@fe4ced9ca691 app]# env |grep ENV_DEMO
ENV_DEMO=hello

从我们的bash进程中可以看到传入的环境变量的值。
查看日志/var/log/envdemo.log, 却看到环境变量的值为空:

1
2
3
4
5
6
7
[root@bb3f18d5bd77 app]# cat /var/log/envdemo.log
Tue Feb 22 09:16:45 UTC 2022
ENV_DEMO=
Tue Feb 22 09:16:48 UTC 2022
ENV_DEMO=
Tue Feb 22 09:16:51 UTC 2022
ENV_DEMO=

调研后发现原来是systemd启动进程时会清空所有的环境变量。知道了具体原因，就可以找到许多种不同的解决方案。

因为systemd本身是容器的1号进程，它会继承父进程的环境变量，因而在容器内可以从/proc/1/environ中获取所有的环境变量信息。

修改envdemo.sh为:

1
2
3
4
5
6
7
8
9
10
11
#!/bin/bash

exec >>/var/log/envdemo.log 2>&1

ENV_DEMO=`cat /proc/1/environ | tr '\0' '\n' | grep 'ENV_DEMO' | awk -F'=' '{print $2}'`
while true
do
    date
    echo "ENV_DEMO=${ENV_DEMO}"
    sleep 3
done

重新build镜像并执行之后，可以看到成功获取到环境变量:

1
2
3
4
5
6
7
8
[root@default envdemo]# docker exec -it envdemo bash
[root@c12073fa2585 app]# cat /var/log/envdemo.log
Tue Feb 22 09:26:39 UTC 2022
ENV_DEMO=hello
Tue Feb 22 09:26:42 UTC 2022
ENV_DEMO=hello
Tue Feb 22 09:26:45 UTC 2022
ENV_DEMO=hello

除了上边的方法，也可以使用systemd本身设置环境变量的方法来解决。systemd支持两种设置环境变量的方式:

  • 在service文件中通过Environment指令设置，如:
1
2
Environment=ENV_FOO="foo"
Environment=ENV_BAR="bar"
  • 也可以在使用EnvironmentFile指定一个文件，在文件中设置环境变量:
1
EnvironmentFile=/app/env.file

将envdemo.service文件修改为:

1
2
3
4
5
6
7
8
9
10
[Unit]
Description=Environment Variables Demo Service

[Service]
Type=simple
EnvironmentFile=/app/env.file
ExecStart=/app/envdemo.sh

[Install]
WantedBy=multi-user.target

将envdemo.sh恢复为最初版本:

1
2
3
4
5
6
7
8
9
10
#!/bin/bash

exec >>/var/log/envdemo.log 2>&1

while true
do
    date
    echo "ENV_DEMO=${ENV_DEMO}"
    sleep 3
done

重新build镜像。
创建环境变量文件env.file:

1
ENV_DEMO="env from file"

启动容器时将env.file映射到容器:

1
docker run --name envdemo --rm -d --privileged -v `pwd`/env.file:/app/env.file envdemo

进入容器查看, 可以看到env.file中设置的环境变量:

1
2
3
4
5
6
7
8
[root@default envdemo]# docker exec -it envdemo bash
[root@a55340c4b7d9 app]# cat /var/log/envdemo.log
Tue Feb 22 09:50:46 UTC 2022
ENV_DEMO=env from file
Tue Feb 22 09:50:49 UTC 2022
ENV_DEMO=env from file
Tue Feb 22 09:50:52 UTC 2022
ENV_DEMO=env from file

使用这种方式需要准备不同的文件并映射到不同的容器实例。我们实际部署使用docker-compose, 更倾向使用只需要在docker-compose.yml中设置不同的环境变量，而不用准备不同环境变量文件的方式。

能够解决问题的方法多种多样，也可以通过Dockerfile中CMD指定处理环境变量的程序来覆盖原有的CMD, 在这程序最后再exec调用/usr/sbin/init, 比如:

1
2
3
4
5
6
7
#!/bin/bash

exec >>/var/log/another.log 2>&1
date
echo $ENV_DEMO

exec /usr/sbin/init

参考: