个人中心
gpt4 book ai didi

Docker Compose引用环境变量的方法示例

转载 作者：qq735679552 更新时间：2022-09-27 22:32:09 31 4
gpt4 key购买 nike

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Docker Compose引用环境变量的方法示例由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

在项目中，往往需要在 docker-compose.yml 文件中使用环境变量来控制不同的条件和使用场景。本文集中介绍 docker compose 引用环境变量的方式.

说明：本文的演示环境为 ubuntu 16.04.

compose cli 与环境变量 。

compose cli(compose command-line 即 docker-compose 程序)能够识别名称为 compose_project_name 和 compose_file 等环境变量(具体支持的环境变量请参考这里)。比如我们可以通过这两个环境变量为 docker-compose 指定 project 的名称和配置文件:

?
1
2
$ export compose_project_name=testvar
$ export compose_file=~ /projects/composecounter/docker-compose .yml

Docker Compose引用环境变量的方法示例

然后启动应用，显示的 project 名称都是我们在环境变量中指定的:

Docker Compose引用环境变量的方法示例

如果设置了环境变量的同时又指定了命令行选项，那么会应用命令行选项的设置:

?
1
$ docker-compose -p nickproject up -d

Docker Compose引用环境变量的方法示例

在 compose file 中引用环境变量 。

我们还可以在 compose file 中直接引用环境变量，比如下面的 demo:

?
1
2
3
4
5
6
7
8
version: '3'
  services:
  web:
   image: ${imagetag}
   ports:
   - "5000:5000"
  redis:
   image: "redis:alpine"

我们通过环境变量 ${imagetag} 指定了 web 的镜像，下面通过 export 的方式来为 compose 配置文件中的环境变量传值:

Docker Compose引用环境变量的方法示例

注意，如果对应的环境变量没有被设置，那么 compose 就会把它替换为一个空字符串:

Docker Compose引用环境变量的方法示例

碰到这种情况，我们可以在 compose 的配置文件中为该变量设置一个默认值:

?
1
2
3
4
5
6
7
8
version: '3'
services:
  web:
  image: ${imagetag:-defaultwebimage}
  ports:
   - "5000:5000"
  redis:
  image: "redis:alpine"

这样，如果没有设置 imagetag 变量，就会应用 defaultwebimage:

Docker Compose引用环境变量的方法示例

除了这种方式，我们还可以通过后面将介绍的 .env 文件来为环境变量设置默认值.

把环境变量传递给容器 。

先来看一下在 compose file 中如何为容器设置环境变量:

?
1
2
3
web:
  environment:
  debug: 1

compose file 中的 environment 节点用来为容器设置环境变量，上面的写法等同于:

?
1
$ docker run -e debug=1

要把当前 shell 环境变量的值传递给容器的环境变量也很简单，去掉上面代码中的赋值部分就可以了:

?
1
2
3
web:
  environment:
  debug:

这种情况下，如果没有在当前的 shell 中导出环境变量 debug，compose file 中会把它解释为 null:

Docker Compose引用环境变量的方法示例

在试试导出环境变量 debug 的情况:

?
1
$ export debug=1

Docker Compose引用环境变量的方法示例

这才是我们设计的正确的使用场景！ 。

使用文件为容器设置多个环境变量 。

如果觉得通过 environment 为容器设置环境变量不够过瘾，我们还可以像 docker -run 的 --env-file 参数一样通过文件为容器设置环境变量:

?
1
2
3
web:
  env_file:
  - web-variables.env

注意，web-variables.env 文件的路径是相对于 docker-compose.yml 文件的相对路径。上面的代码效果与下面的代码相同:

?
1
$ docker run -- env - file =web-variables. env

web-variables.env 文件中可以定义一个或多个环境变量:

?
1
2
3
4
# define web container env
appname=helloworld
author=nick li
version=1.0

检查下结果:

Docker Compose引用环境变量的方法示例

原来 compose 把 env_file 的设置翻译成了 environment！ 。

.env 文件 。

当我们在 docker-compose.yml 文件中引用了大量的环境变量时，对每个环境变量都设置默认值将是繁琐的，并且也会影响 docker-compose.yml 简洁程度。此时我们可以通过 .env 文件来为 docker-compose.yml 文件引用的所有环境变量设置默认值！ 修改 docker-compose.yml 文件的内容如下:

?
1
2
3
4
5
6
7
8
9
10
11
12
version: '3'
services:
  web:
  image: ${imagetag}    
  environment:
   appname:
   author:
   version:
  ports:
   - "5000:5000"
  redis:
  image: "redis:alpine"

然后在相同的目录下创建 .env 文件，编辑其内容如下:

?
1
2
3
4
5
# define env var default value.
imagetag=defaultwebimage
appname=default app name
author=default author name
version=default version is 1.0

检查下结果，此时所有的环境变量都显示为 .env 文件中定义的默认值:

Docker Compose引用环境变量的方法示例

配置不同场景下的环境变量 。

从前面的部分中我们可以看到，docker compose 提供了足够的灵活性来让我们设置 docker-compose.yml 文件中引用的环境变量，它们的优先级如下:

  1. compose file
  2. shell environment variables
  3. environment file
  4. dockerfile
  5. variable is not defined

首先，在 docker-compose.yml 文件中直接设置的值优先级是最高的。 然后是在当前 shell 中 export 的环境变量值。 接下来是在环境变量文件中定义的值。 再接下来是在 dockerfile 中定义的值。 最后还没有找到相关的环境变量就认为该环境变量没有被定义.

根据上面的优先级定义，我们可以把不同场景下的环境变量定义在不同的 shell 脚本中并导出，然后在执行 docker-compose 命令前先执行 source 命令把 shell 脚本中定义的环境变量导出到当前的 shell 中。通过这样的方式可以减少维护环境变量的地方，下面的例子中我们分别在 docker-compose.yml 文件所在的目录创建 test.sh 和 prod.sh，test.sh 的内容如下:

?
1
2
3
4
5
6
#!/bin/bash
# define env var default value.
export imagetag=web:v1
export appname=helloworld
export author=nick li
export version=1.0

prod.sh 的内容如下:

?
1
2
3
4
5
6
#!/bin/bash
# define env var default value.
export imagetag=webpord:v1
export appname=helloworldprod
export author=nick li
export version=1.0lts

在测试环境下，执行下面的命令:

?
1
2
$ source test .sh
$ docker-compose config

Docker Compose引用环境变量的方法示例

此时 docker-compose.yml 中的环境变量应用的都是测试环境相关的设置.

而在生产环境下，执行下面的命令:

?
1
2
$ source prod.sh
$ docker-compose config

Docker Compose引用环境变量的方法示例

此时 docker-compose.yml 中的环境变量应用的都是生产环境相关的设置.

总结 。

docker compose 对环境变量的使用提供了非常丰富支持和灵活的使用方式。希望通过本文的总结可以帮助大家理清相关的用法，并能够以简洁的方式为不同的使用场景提供支持.

参考:

compose cli environment variables environment variables in compose compose file variable substitution declare default environment variables in file 。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我.

原文链接：https://www.cnblogs.com/sparkdev/p/9826520.html 。

最后此篇关于Docker Compose引用环境变量的方法示例的文章就讲到这里了,如果你想了解更多关于Docker Compose引用环境变量的方法示例的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

31 4 0
文章推荐： Docker-compose部署gitlab的方法步骤
文章推荐： 详解Docker创建支持ssh服务的容器和镜像
文章推荐： 利用docker搭建php7和nginx运行环境全过程（官方镜像）
文章推荐： 亲测中0.38 同花顺7月高温补贴抽随机现金红包
qq735679552
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com