Docker-compose项目介绍及命令说明_docker-compose expose

目录

一、前言

二、命令对象格式和选项：

三、命令使用说明

四、compose模版文件 

1、模版文件名称：docker-compose.yml，

2、build:

五、Docker-compose使用注意点

---

一、前言

二、命令对象格式和选项：

• -f, --file FILE 指定使用的 Compose 模板文件，默认为 docker-compose.yml，可以多次指定。
• -p, --project-name NAME 指定项目名称，默认将使用所在目录名称作为项目名。
• --x-networking 使用 Docker 的可拔插网络后端特性
• --x-network-driver DRIVER 指定网络后端的驱动，默认为 bridge
• --verbose 输出更多调试信息。
• -v, --version 打印版本并退出。

三、命令使用说明

• --force-rm 删除构建过程中的临时容器。
• --no-cache 构建镜像过程中不使用 cache（这将加长构建过程）。
• --pull 始终尝试通过 pull 来获取更新版本的镜像。

• --protocol=proto 指定端口协议，tcp（默认值）或者 udp。
• --index=index 如果同一服务存在多个容器，指定命令对象容器的序号（默认为 1）。

• -q 只打印容器的 ID 信息。

• --ignore-pull-failures 忽略拉取镜像过程中的错误。

• -t, --timeout TIMEOUT 指定重启前停止容器的超时（默认为 10 秒）。

• -f, --force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
• -v 删除容器所挂载的数据卷。

• 给定命令将会覆盖原有的自动运行命令；
• 不会自动创建端口，以避免冲突。

• -d 后台运行容器。
• --name NAME 为容器指定一个名字。
• --entrypoint CMD 覆盖默认的容器启动指令。
• -e KEY=VAL 设置环境变量值，可多次使用选项来设置多个环境变量。
• -u, --user="" 指定运行容器的用户名或者 uid。
• --no-deps 不自动启动关联的服务容器。
• --rm 运行命令后自动删除容器，d 模式下将忽略。
• -p, --publish=[] 映射容器端口到本地主机。
• --service-ports 配置服务端口并映射到本地主机。
• -T 不分配伪 tty，意味着依赖 tty 的指令将无法运行。

• -t, --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

• -d 在后台运行服务容器。
• --no-color 不使用颜色来区分不同的服务的控制台输出。
• --no-deps 不启动服务所链接的容器。
• --force-recreate 强制重新创建容器，不能与 --no-recreate 同时使用。
• --no-recreate 如果容器已经存在了，则不重新创建，不能与 --force-recreate 同时使用。
• --no-build 不自动构建缺失的服务镜像。
• -t, --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

四、compose模版文件 

1、模版文件名称：docker-compose.yml，

格式：YAML

version:'3'
 
 
 
services:
 
webapp:
 
images:
 
ports:
 
-"80:80 "
 
volumes:
 
-"/data"

每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。

如果使用 build 指令，在 Dockerfile 中设置的选项(例如：CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取，无需在 docker-compose.yml 中再次设置

2、build:

1、指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）

version: '3'
 
services:
 
webapp:
 
build: ./dir

2、可用context指令指定Dockerfile所在文件夹路径

使用dockerfile指令指定Dockerfile文件名

使用arg指令指定构建镜像时的变量

version: '3'
 
servives:
 
webapp:
 
build:
 
context: ./dir
 
dockerfile:Docker-alternate
 
args:
 
buildno:1

3、使用cache_from指定构建镜像的缓存

build:
 
context: .
 
cache_from:
 
-alpine:latest

4、cap_add,cap_drop:指定容器的内核能力分配

让容器拥有所有能力：

cap_add:
 
-ALL
去掉NET_ADMIN:
 
cap_drop:
 
-NET_ADMIN

5、command:覆盖容器启动后默认执行的命令

command:echo "hello"

6、cgroup_parent:指定父cgroup组，即继承该组的资源限制

例如，创建了一个 cgroup 组名称为 cgroups_1。

cgroup_parent: cgroups_1

7、container_name:指定容器名称。默认使用项目名称_服务名称_序号

cotainer_name:docker-web-container

注：指定容器名称后，该服务将无法进行扩展，因为Docker不允许多个容器具有相同的名称

8、devices:指定设备映射关系

devices:
 
-" /dev/ttyUSB1:/dev/ttyUSB0"

9、depends_on:解决容器的依赖，启动问题

例如先启动redis db再启动web

version: '3'
 
serivices:
 
web:
 
build: .
 
depends_on:
 
-db
 
-redis
 
 
 
redis:
 
images:redis
 
db:
 
images:postgres

注：web服务不会等待redis db完全启动后才启动

10、dns:自定义DNS服务，可以是一个值，也可以是一个列表

dns: 8.8.8.8
 
dns:
 
-8.8.8.8
 
-114.114.114.114

11、配置DNS搜索域，可以是一个值也可以是一个列表

dns_search: example.com
 
dns_search:
 
-domain1.example.com
 
-domain2.example.com

12、tmpfs：挂载一个tmpfs文件系统到容器

tmpfs: /run
 
tmpfs:
 
- /run
 
- /tmp

13、env_file：从环境中获取环境变量，可以为单独文件路径或列表

如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

env_file: .env
 
env_file:
 
- ./common.env
 
- ./apps/web.env
 
- /opt/secrets.env
 
PROG_EMV=development

14、environment:设置环境变量，可以使用数组或字典两种格式

只给定名称的变量会自动获取运行compose主机上对应变量的值，可以用来防止泄漏不必要的数据

environment:

RACK_ENV：deveploment

SESSION_SECRET

如果变量名称或者值中用到true|false,yes|no等布尔表达式词汇，最好放在引号里

15、expose：暴露端口，但不映射到宿主机，只被连接的服务访问

只可以指定内部端口为参数

expose:
 
-"3000"
 
-"8000"

16、链接到docker-compose.yml外部容器，甚至并非compose管理的外部容器

external_links:
 
-redis_1
 
-project_db_1:mysql
 
-project_db_1:postgresql

17、extra_hosts

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息。

extra_hosts: - "googledns:8.8.8.8" - "dockerhub:52.1.157.61"

会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。

8.8.8.8 googledns52.1.157.61 dockerhub

18、healthcheck

通过命令检查容器是否健康运行

healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] interval: 1m30s timeout: 10s retries: 3

19、image

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

image: ubuntuimage: orchardup/postgresql

20、labels

为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels: com.startupteam.description: "webapp for a startup team" com.startupteam.department: "devops department" com.startupteam.release: "rc3 for v1.0"

21、logging

配置日志选项。

logging: driver: syslog options: syslog-address: "tcp://192.168.0.42:123"

目前支持三种日志驱动类型。

driver: "json-file"driver: "syslog"driver: "none"

options 配置日志驱动的相关参数。

options: max-size: "200k" max-file: "10"

22、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]"

23、networks

配置容器连接的网络。

version: "3"services: some-service: networks: - some-network - other-networknetworks: some-network: other-network:

24、pid

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。

pid: "host"

25、ports

暴露端口信息。

使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports: - "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001"

注意：当使用 HOST:CONTAINER 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

26、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_secretsecrets: my_secret: file: ./my_secret.txt my_other_secret: external: true

27、security_opt

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名。

security_opt: - label:user:USER - label:role:ROLE

28、stop_signal

设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。

stop_signal: SIGUSR1

29、ulimits

指定容器的 ulimits 限制值。

例如，指定最大进程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制） 和 40000（系统硬限制，只能 root 用户提高）。

ulimits: nproc: 65535 nofile: soft: 20000 hard: 40000

30、volumes

数据卷所挂载路径设置。可以设置宿主机路径 （HOST:CONTAINER） 或加上访问模式 （HOST:CONTAINER:ro）。

该指令中路径支持相对路径。

volumes: - /var/lib/mysql - cache/:/tmp/cache - ~/configs:/etc/configs/:ro

五、Docker-compose使用注意点

在使用Docker Compose时，需要注意以下几点：

1. 版本兼容性：确保使用的Docker Compose版本与Docker引擎版本兼容。可以查看官方文档了解哪些版本是兼容的。

2. 环境变量配置：在docker-compose.yml文件中，可以设置环境变量，这些环境变量可以在容器中使用。但是，需要注意环境变量的引用方式。

3. 网络配置：Docker Compose 默认创建一个私有网络，容器之间可以通过容器名称来互相通信。如果需要与外部进行通信，可以通过端口映射来实现。

4. 数据卷挂载：使用-v选项或--mount选项可以将数据卷挂载到容器中。需要注意数据卷对应的位置必须存在，否则会导致容器启动失败。

5. 容器依赖关系：在Docker Compose中，可以指定容器之间的依赖关系。如果容器A依赖容器B，必须先启动容器B，再启动容器A。

6. 缩放服务：Docker Compose可以通过指定副本数的方式来扩展服务。需要注意，副本数必须小于等于可用的物理资源。

7. 指定容器命令：通过command选项可以指定容器启动时运行的命令。需要注意，这个命令将覆盖容器中的默认命令。

8. 环境变量文件：可以将环境变量保存到文件中，并在docker-compose.yml文件中通过env_file选项进行引用。

9. 多环境支持：可以通过指定不同的docker-compose文件来支持多个环境的部署。比如，docker-compose-dev.yml和docker-compose-prod.yml。

10. 容器重启策略：可以通过restart选项指定容器出现故障时的重启策略。常用的策略有no、always、on-failure和unless-stopped等。