前置知识
YAML 是 “YAML Ain’t a Markup Language”(YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:”Yet Another Markup Language”(仍是一种标记语言)。
YAML 的语法和其他高级语言类似,并且可以简单表达清单、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲(例如:许多电子邮件标题格式和YAML非常接近)。
YAML 的配置文件后缀为.yml
- https://www.runoob.com/w3cnote/yaml-intro.html
简介
docker compose 在 Docker 容器运用中具有很大的学习意义,docker compose
是一个整合发布应用的利器。而使用 docker compose 时,懂得如何编排docker compose
配置文件是很重要的。
官方参考文档:https://docs.docker.com/compose/
使用compose
一般有3步:
- 使用
Dockerfile
定义应用的环境 - 在
docker-compose.yml
中定义需要运行的服务 - 执行
docker-compose up
来启动运行整个应用
一个docker-compose.yml
大概长这样
version: "3.9" # optional since v1.27.0
services:
web:
build: .
ports:
- "8000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image: redis
volumes:
logvolume01: {}
使用compose可以管理应用的整个生命周期
- Start, stop, and rebuild services
- View the status of running services
- Stream the log output of running services
- Run a one-off command on a service
实例
官网python flask + redis
的实例,通过走一遍流程来巩固一下基础知识flask+redis启动代码
运行在docker容器中的服务
创建app.py,写入如下内容
import time
import redis
from flask import Flask
app = Flask(__name__)
cache = redis.Redis(host='redis', port=6379)
def get_hit_count():
retries = 5
while True:
try:
return cache.incr('hits')
except redis.exceptions.ConnectionError as exc:
if retries == 0:
raise exc
retries -= 1
time.sleep(0.5)
@app.route('/')
def hello():
count = get_hit_count()
return 'Hello World! I have been seen {} times.\n'.format(count)
创建依赖文件requirements.txt
flask
redis
Dockerfile
通过
Dockerfile
来创建一个docker镜像,这个镜像会解决所有的依赖问题,如python环境、pthon依赖等指令详解:https://yeasy.gitbook.io/docker_practice/image/dockerfile
内容如下:
# syntax=docker/dockerfile:1
FROM python:3.7-alpine
WORKDIR /code
ENV FLASK_APP=app.py
ENV FLASK_RUN_HOST=0.0.0.0
RUN apk add --no-cache gcc musl-dev linux-headers
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
EXPOSE 5000
COPY . .
CMD ["flask", "run"]
解释:
- 以最小的python3.7的镜像为基础构建
- 设置工作目录为
/code
- 设置flask启动时需要的环境变量
- 在容器中安装gcc和一些其他的依赖
- 给
requirements.txt
复制到容器中 - 在容器中安装依赖
- 声明容器开放5000端口(为了规范,好像没啥大用)
- 给当前目录复制到
WORKDIR
中 - 运行
flask run
docker-compose.yml
定义compose需要用到的其他镜像服务
创建docker-compose.yml
,写入如下内容:
version: "3.9"
services:
web:
build: .
ports:
- "8000:5000"
volumes:
- .:/code
environment:
FLASK_ENV: development
redis:
image: "redis:alpine"
定义了2个服务,一个是web
,一个是redis
web服务:通过Dockerfile
编译而来,本地的8000端口对应容器内的5000,code挂载到当前目录,可以实时修改代码,环境变量设置了flask以开发模式运行
redis服务:直接从dockerhub pull下来就能用,所以无需多余的配置
编译和运行
此时文件结构:
.
├── Dockerfile
├── app.py
├── docker-compose.yml
└── requirements.txt
运行
# -d表示后台运行
docker-compose up -d
然后就OK了
扩展
# 查看启动的容器
docker-compose ps
# 执行命令
docker-compose run web env
# 停止compose
docker-compose stop
compose详解
完整的参考:https://yeasy.gitbook.io/docker_practice/compose/compose_file
这里记录一些自己常用的
build
指定 Dockerfile
所在文件夹的路径(可以是绝对路径,或者相对 docker-compose.yml 文件的路径)。 Compose
将会利用它自动构建这个镜像,然后使用这个镜像。
version: '3'
services:
webapp:
build: ./dir
你也可以使用 context
指令指定 Dockerfile
所在文件夹的路径。
使用 dockerfile
指令指定 Dockerfile
文件名。
使用 arg
指令指定构建镜像时的变量。
version: '3'
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1
使用 cache_from
指定构建镜像的缓存
build:
context: .
cache_from:
- alpine:latest
- corp/web_app:3.14
command
覆盖容器启动后默认执行的命令。
command: echo "hello world"
container_name
指定容器名称。默认将会使用 项目名称_服务名称_序号
这样的格式。
container_name: docker-web-container
depends_on
解决容器的依赖、启动先后的问题。以下例子中会先启动 redis
db
再启动 web
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
environment
设置环境变量。你可以使用数组或字典两种格式。
可以通过如下两种方法查看:
docker inspect <CONTAINER-NAME> OR <CONTAINER-ID>
docker exec -it <CONTAINER-NAME> OR <CONTAINER-ID> env
只给定名称的变量会自动获取运行 Compose 主机上对应变量的值,可以用来防止泄露不必要的数据。
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET
如果变量名称或者值中用到 true|false,yes|no
等表达布尔含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
expose
暴露端口,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端口为参数
expose:
- "3000"
- "8000"
image
指定为镜像名称或镜像 ID。如果镜像在本地不存在,Compose
将会尝试拉取这个镜像。
image: ubuntu
image: orchardup/postgresql
image: a4bc65fd
network_mode
设置网络模式。使用和 docker run
的 --network
参数一样的值。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
ports
映射端口信息。
使用宿主端口:容器端口 (HOST:CONTAINER)
格式,或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"
secrets
存储敏感数据,例如 mysql
服务密码。
version: "3.1"
services:
mysql:
image: mysql
environment:
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
secrets:
- db_root_password
- my_other_secret
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: true
volumes
数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER
)或者数据卷名称(VOLUME:CONTAINER
),并且可以设置访问模式 (HOST:CONTAINER:ro
)。
该指令中路径支持相对路径。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
如果路径为数据卷名称,必须在文件中配置数据卷。
version: "3"
services:
my_src:
image: mysql:8.0
volumes:
- mysql_data:/var/lib/mysql
volumes:
mysql_data:
其他指令
此外,还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir
等指令,基本跟 docker run
中对应参数的功能一致。
模拟一个伪终端:
tty: true
指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效,在生产环境中推荐配置为 always
或者 unless-stopped
。
restart: always
读取变量
Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env
文件中的变量。
例如,下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION}
的值,并写入执行的指令中。
version: "3"
services:
db:
image: "mongo:${MONGO_VERSION}"
如果执行 MONGO_VERSION=3.2 docker-compose up
则会启动一个 mongo:3.2
镜像的容器;如果执行 MONGO_VERSION=2.8 docker-compose up
则会启动一个 mongo:2.8
镜像的容器。
若当前目录存在 .env
文件,执行 docker-compose
命令时将从该文件中读取变量。
# 支持 # 号注释
MONGO_VERSION=3.6
扩展
Docker通过代理build
有时候build镜像,源什么都没换,直接国内去访问就很慢很卡,可以通过如下的方法来加快速度。
代理需要改成自己的
docker build --build-arg "HTTP_PROXY=http://10.8.194.13:1081/" --build-arg "HTTPS_PROXY=http://10.8.194.13:1081/" -t testproxy .
测试用dockerfile
FROM ubuntu:latest
RUN apt update && apt install curl -y
RUN curl www.google.com --max-time 3
效果: