主頁(yè) > 知識(shí)庫(kù) > Docker Compose引用環(huán)境變量的方法示例

Docker Compose引用環(huán)境變量的方法示例

熱門(mén)標(biāo)簽:涪陵商都400電話開(kāi)通辦理 安陽(yáng)ai電銷(xiāo)機(jī)器人軟件 外呼系統(tǒng)的經(jīng)營(yíng)范圍 申請(qǐng)400電話價(jià)格多少 廈門(mén)營(yíng)銷(xiāo)外呼系統(tǒng)平臺(tái) 外呼系統(tǒng)不彈窗 云會(huì)外呼系統(tǒng) 智能電話機(jī)器人坐席 柳州市機(jī)器人外呼系統(tǒng)報(bào)價(jià)

在項(xiàng)目中,往往需要在 docker-compose.yml 文件中使用環(huán)境變量來(lái)控制不同的條件和使用場(chǎng)景。本文集中介紹 docker compose 引用環(huán)境變量的方式。

說(shuō)明:本文的演示環(huán)境為 ubuntu 16.04。

Compose CLI 與環(huán)境變量

Compose CLI(compose command-line 即 docker-compose 程序)能夠識(shí)別名稱(chēng)為 COMPOSE_PROJECT_NAME 和 COMPOSE_FILE 等環(huán)境變量(具體支持的環(huán)境變量請(qǐng)參考這里)。比如我們可以通過(guò)這兩個(gè)環(huán)境變量為 docker-compose 指定 project 的名稱(chēng)和配置文件:

$ export COMPOSE_PROJECT_NAME=TestVar
$ export COMPOSE_FILE=~/projects/composecounter/docker-compose.yml

然后啟動(dòng)應(yīng)用,顯示的 project 名稱(chēng)都是我們?cè)诃h(huán)境變量中指定的:

如果設(shè)置了環(huán)境變量的同時(shí)又指定了命令行選項(xiàng),那么會(huì)應(yīng)用命令行選項(xiàng)的設(shè)置:

$ docker-compose -p nickproject up -d

在 compose file 中引用環(huán)境變量

我們還可以在 compose file 中直接引用環(huán)境變量,比如下面的 demo:

version: '3'
 services:
 web:
  image: ${IMAGETAG}
  ports:
  - "5000:5000"
 redis:
  image: "redis:alpine"

我們通過(guò)環(huán)境變量 ${IMAGETAG} 指定了 web 的鏡像,下面通過(guò) export 的方式來(lái)為 compose 配置文件中的環(huán)境變量傳值:

注意,如果對(duì)應(yīng)的環(huán)境變量沒(méi)有被設(shè)置,那么 compose 就會(huì)把它替換為一個(gè)空字符串:

碰到這種情況,我們可以在 compose 的配置文件中為該變量設(shè)置一個(gè)默認(rèn)值:

version: '3'
services:
 web:
 image: ${IMAGETAG:-defaultwebimage}
 ports:
  - "5000:5000"
 redis:
 image: "redis:alpine"

這樣,如果沒(méi)有設(shè)置 IMAGETAG 變量,就會(huì)應(yīng)用 defaultwebimage:

除了這種方式,我們還可以通過(guò)后面將介紹的 .env 文件來(lái)為環(huán)境變量設(shè)置默認(rèn)值。

把環(huán)境變量傳遞給容器

先來(lái)看一下在 compose file 中如何為容器設(shè)置環(huán)境變量:

web:
 environment:
 DEBUG: 1

compose file 中的 environment 節(jié)點(diǎn)用來(lái)為容器設(shè)置環(huán)境變量,上面的寫(xiě)法等同于:

$ docker run -e DEBUG=1

要把當(dāng)前 shell 環(huán)境變量的值傳遞給容器的環(huán)境變量也很簡(jiǎn)單,去掉上面代碼中的賦值部分就可以了:

web:
 environment:
 DEBUG:

這種情況下,如果沒(méi)有在當(dāng)前的 shell 中導(dǎo)出環(huán)境變量 DEBUG,compose file 中會(huì)把它解釋為 null:

在試試導(dǎo)出環(huán)境變量 DEBUG 的情況:

$ export DEBUG=1

這才是我們?cè)O(shè)計(jì)的正確的使用場(chǎng)景!

使用文件為容器設(shè)置多個(gè)環(huán)境變量

如果覺(jué)得通過(guò) environment 為容器設(shè)置環(huán)境變量不夠過(guò)癮,我們還可以像 docker -run 的 --env-file 參數(shù)一樣通過(guò)文件為容器設(shè)置環(huán)境變量:

web:
 env_file:
 - web-variables.env

注意,web-variables.env 文件的路徑是相對(duì)于 docker-compose.yml 文件的相對(duì)路徑。上面的代碼效果與下面的代碼相同:

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

web-variables.env 文件中可以定義一個(gè)或多個(gè)環(huán)境變量:

# define web container env
APPNAME=helloworld
AUTHOR=Nick Li
VERSION=1.0

檢查下結(jié)果:

原來(lái) compose 把 env_file 的設(shè)置翻譯成了 environment!

.env 文件

當(dāng)我們?cè)?docker-compose.yml 文件中引用了大量的環(huán)境變量時(shí),對(duì)每個(gè)環(huán)境變量都設(shè)置默認(rèn)值將是繁瑣的,并且也會(huì)影響 docker-compose.yml 簡(jiǎn)潔程度。此時(shí)我們可以通過(guò) .env 文件來(lái)為 docker-compose.yml 文件引用的所有環(huán)境變量設(shè)置默認(rèn)值!
修改 docker-compose.yml 文件的內(nèi)容如下:

version: '3'
services:
 web:
 image: ${IMAGETAG}     
 environment:
  APPNAME:
  AUTHOR:
  VERSION:
 ports:
  - "5000:5000"
 redis:
 image: "redis:alpine"

然后在相同的目錄下創(chuàng)建 .env 文件,編輯其內(nèi)容如下:

# define env var default value.
IMAGETAG=defaultwebimage
APPNAME=default app name
AUTHOR=default author name
VERSION=default version is 1.0

檢查下結(jié)果,此時(shí)所有的環(huán)境變量都顯示為 .env 文件中定義的默認(rèn)值:

配置不同場(chǎng)景下的環(huán)境變量

從前面的部分中我們可以看到,docker compose 提供了足夠的靈活性來(lái)讓我們?cè)O(shè)置 docker-compose.yml 文件中引用的環(huán)境變量,它們的優(yōu)先級(jí)如下:

  1. Compose file
  2. Shell environment variables
  3. Environment file
  4. Dockerfile
  5. Variable is not defined

首先,在 docker-compose.yml 文件中直接設(shè)置的值優(yōu)先級(jí)是最高的。
然后是在當(dāng)前 shell 中 export 的環(huán)境變量值。
接下來(lái)是在環(huán)境變量文件中定義的值。
再接下來(lái)是在 Dockerfile 中定義的值。
最后還沒(méi)有找到相關(guān)的環(huán)境變量就認(rèn)為該環(huán)境變量沒(méi)有被定義。

根據(jù)上面的優(yōu)先級(jí)定義,我們可以把不同場(chǎng)景下的環(huán)境變量定義在不同的 shell 腳本中并導(dǎo)出,然后在執(zhí)行 docker-compose 命令前先執(zhí)行 source 命令把 shell 腳本中定義的環(huán)境變量導(dǎo)出到當(dāng)前的 shell 中。通過(guò)這樣的方式可以減少維護(hù)環(huán)境變量的地方,下面的例子中我們分別在 docker-compose.yml 文件所在的目錄創(chuàng)建 test.sh 和 prod.sh,test.sh 的內(nèi)容如下:

#!/bin/bash
# define env var default value.
export IMAGETAG=web:v1
export APPNAME=HelloWorld
export AUTHOR=Nick Li
export VERSION=1.0

prod.sh 的內(nèi)容如下:

#!/bin/bash
# define env var default value.
export IMAGETAG=webpord:v1
export APPNAME=HelloWorldProd
export AUTHOR=Nick Li
export VERSION=1.0LTS

在測(cè)試環(huán)境下,執(zhí)行下面的命令:

$ source test.sh
$ docker-compose config

此時(shí) docker-compose.yml 中的環(huán)境變量應(yīng)用的都是測(cè)試環(huán)境相關(guān)的設(shè)置。

而在生產(chǎn)環(huán)境下,執(zhí)行下面的命令:

$ source prod.sh
$ docker-compose config

此時(shí) docker-compose.yml 中的環(huán)境變量應(yīng)用的都是生產(chǎn)環(huán)境相關(guān)的設(shè)置。

總結(jié)

docker compose 對(duì)環(huán)境變量的使用提供了非常豐富支持和靈活的使用方式。希望通過(guò)本文的總結(jié)可以幫助大家理清相關(guān)的用法,并能夠以簡(jiǎn)潔的方式為不同的使用場(chǎng)景提供支持。

參考:

Compose CLI environment variables
Environment variables in Compose
Compose file variable substitution
Declare default environment variables in file

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

標(biāo)簽:福州 蕪湖 撫順 晉城 巴中 孝感 南充 綏化

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《Docker Compose引用環(huán)境變量的方法示例》,本文關(guān)鍵詞  Docker,Compose,引用,環(huán)境,變量,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問(wèn)題,煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無(wú)關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《Docker Compose引用環(huán)境變量的方法示例》相關(guān)的同類(lèi)信息!
  • 本頁(yè)收集關(guān)于Docker Compose引用環(huán)境變量的方法示例的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章