diff --git a/docker/Docker.md b/docker/Docker.md index 3e8479b5f97727c97d1242bccc01efe970adac07..0639ae3454371d7e78dca73b89df4dbad98f0f0b 100644 --- a/docker/Docker.md +++ b/docker/Docker.md @@ -12,6 +12,12 @@ ## Docker 简介 +Docker 是一个开源的应用容器引擎,基于 Go 语言 并遵从 Apache2.0 协议开源。 + +Docker 可以让开发者打包他们的应用以及依赖包到一个轻量级、可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化。 + +容器是完全使用沙箱机制,相互之间不会有任何接口(类似 iPhone 的 app),更重要的是容器性能开销极低。 + ### 三个基本概念 - 镜像(Image):Docker 镜像, @@ -264,12 +270,12 @@ Docker 的默认存储位置 var/lib/docker 登录需要输入用户名和密码,登录成功后,我们就可以从 docker hub 上拉取自己账号下的全部镜像。 -- 登录,docker login -- 退出,docker logout +- 登录,`docker login` +- 退出,`docker logout` ### 拉取镜像 -- 使用 docker search 查找镜像,然后使用 docker pull 将它下载到本地。 +- 使用 `docker search` 查找镜像,然后使用 `docker pull` 将它下载到本地。 ### 推送镜像 @@ -278,3 +284,260 @@ Docker 的默认存储位置 var/lib/docker 2. `docker search username/ubuntu` ## Dockerfile + +Dockerfile 是一个用来构建镜像的文本文件,文本内容包含了一条条构建镜像所需的指令和说明。 + +### 定制镜像 + +例如定制一个 nginx 镜像(构建好的镜像内会有一个 /usr/share/nginx/html/index.html 文件): + +1. 在一个空目录下,新建一个名为 Dockerfile 文件,并在文件内添加以下内容: + + ```bash + FROM nginx + RUN echo '这是一个本地镜像' > /usr/share/nginx/html/index.html + ``` + + - FROM:定制的镜像都是基于 FROM 的镜像,这里的 nginx 就是定制需要的基础镜像。后续的操作都是基于 nginx。 + - RUN:用于执行后面跟着的命令行命令。有以下俩种格式: + - shell 格式: + - `RUN <命令行命令> 参数1 参数2` + - <命令行命令> 等同于,在终端操作的 shell 命令。 + - exec 格式: + - `RUN ["可执行文件", "参数1", "参数2"]` + - 例如: + - `RUN ["./test.php", "dev", "offline"] 等价于 RUN ./test.php dev offline` +1. 在 Dockerfile 文件的存放目录下,执行构建动作。 + - 以下示例,通过目录下的 Dockerfile 构建一个 nginx:v3(镜像名称:镜像标签)。 + - 注:最后的 . 代表本次执行的上下文路径,下一节会介绍。 + +### 上下文路径 + +`docker build -t nginx:v3 .`,指令最后一个 `.` 是上下文路径。 + +- 上下文路径,是指 docker 在构建镜像,有时候想要使用到本机的文件(比如复制),`docker build` 命令得知这个路径后,会将路径下的所有内容打包。 + +- 解析:由于 docker 的运行模式是 C/S。我们本机是 C,docker 引擎是 S。实际的构建过程是在 docker 引擎下完成的,所以这个时候无法用到我们本机的文件。这就需要把我们本机的指定目录下的文件一起打包提供给 docker 引擎使用。 + +- 如果未说明最后一个参数,那么默认上下文路径就是 Dockerfile 所在的位置。 + +**注意:** 上下文路径下不要放无用的文件,因为会一起打包发送给 docker 引擎,如果文件过多会造成过程缓慢。 + +### 指令集 + +#### **COPY** + +复制指令,从上下文目录中复制文件或者目录到容器里指定路径。 + +- 格式: + + ```bash + COPY [--chown=:] <源路径1>... <目标路径> + COPY [--chown=:] ["<源路径1>",... "<目标路径>"] + [--chown=:]:可选参数,用户改变复制到容器内文件的拥有者和属组。 + ``` + + - <源路径>:源文件或者源目录,这里可以是通配符表达式,其通配符规则要满足 Go 的 filepath.Match 规则。例如: + + ```bash + COPY hom* /mydir/ + COPY hom?.txt /mydir/ + ``` + + - <目标路径>:容器内的指定路径,该路径不用事先建好,路径不存在的话,会自动创建。 + +#### **ADD** + +ADD 指令和 COPY 的使用格类似(同样需求下,官方推荐使用 COPY)。功能也类似,不同之处如下: + +ADD 的优点:在执行 <源文件> 为 tar 压缩文件的话,压缩格式为 gzip, bzip2 以及 xz 的情况下,会自动复制并解压到 <目标路径>。 +ADD 的缺点:在不解压的前提下,无法复制 tar 压缩文件。会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。具体是否使用,可以根据是否需要自动解压来决定。 + +#### **CMD** + +类似于 RUN 指令,用于运行程序,但二者运行的时间点不同: + +- CMD 在docker run 时运行。 +- RUN 是在 docker build。 + +作用:为启动的容器指定默认要运行的程序,程序运行结束,容器也就结束。CMD 指令指定的程序可被 docker run 命令行参数中指定要运行的程序所覆盖。 + +**注意:** 如果 Dockerfile 中如果存在多个 CMD 指令,仅最后一个生效。 + +- 格式: + + ```bash + CMD + CMD ["<可执行文件或命令>","","",...] + CMD ["","",...] # 该写法是为 ENTRYPOINT 指令指定的程序提供默认参数 + ``` + +推荐使用第二种格式,执行过程比较明确。第一种格式实际上在运行的过程中也会自动转换成第二种格式运行,并且默认可执行文件是 sh。 + +#### **ENTRYPOINT** + +类似于 CMD 指令,但其不会被 docker run 的命令行参数指定的指令所覆盖,而且这些命令行参数会被当作参数送给 ENTRYPOINT 指令指定的程序。 + +但是, 如果运行 docker run 时使用了 --entrypoint 选项,将覆盖 CMD 指令指定的程序。 + +优点:在执行 docker run 的时候可以指定 ENTRYPOINT 运行所需的参数。 + +注意:如果 Dockerfile 中如果存在多个 ENTRYPOINT 指令,仅最后一个生效。 + +格式: + +ENTRYPOINT ["","","",...] +可以搭配 CMD 命令使用:一般是变参才会使用 CMD ,这里的 CMD 等于是在给 ENTRYPOINT 传参,以下示例会提到。 + +示例: + +假设已通过 Dockerfile 构建了 nginx:test 镜像: + +FROM nginx + +ENTRYPOINT ["nginx", "-c"] # 定参 +CMD ["/etc/nginx/nginx.conf"] # 变参 +1、不传参运行 + +$ docker run nginx:test +容器内会默认运行以下命令,启动主进程。 + +nginx -c /etc/nginx/nginx.conf +2、传参运行 + +$ docker run nginx:test -c /etc/nginx/new.conf +容器内会默认运行以下命令,启动主进程(/etc/nginx/new.conf:假设容器内已有此文件) + +nginx -c /etc/nginx/new.conf + +#### **ENV** + +设置环境变量,定义了环境变量,那么在后续的指令中,就可以使用这个环境变量。 + +格式: + +ENV +ENV = =... +以下示例设置 NODE_VERSION = 7.2.0 , 在后续的指令中可以通过 $NODE_VERSION 引用: + +ENV NODE_VERSION 7.2.0 + +RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz" \ + && curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" + +#### **ARG** + +构建参数,与 ENV 作用一致。不过作用域不一样。ARG 设置的环境变量仅对 Dockerfile 内有效,也就是说只有 docker build 的过程中有效,构建好的镜像内不存在此环境变量。 + +构建命令 docker build 中可以用 --build-arg <参数名>=<值> 来覆盖。 + +格式: + +ARG <参数名>[=<默认值>] + +#### **VOLUME** + +定义匿名数据卷。在启动容器时忘记挂载数据卷,会自动挂载到匿名卷。 + +作用: + +避免重要的数据,因容器重启而丢失,这是非常致命的。 +避免容器不断变大。 +格式: + +VOLUME ["<路径1>", "<路径2>"...] +VOLUME <路径> +在启动容器 docker run 的时候,我们可以通过 -v 参数修改挂载点。 + +#### **EXPOSE** + +仅仅只是声明端口。 + +作用: + +帮助镜像使用者理解这个镜像服务的守护端口,以方便配置映射。 +在运行时使用随机端口映射时,也就是 docker run -P 时,会自动随机映射 EXPOSE 的端口。 +格式: + +EXPOSE <端口1> [<端口2>...] + +#### **WORKDIR** + +指定工作目录。用 WORKDIR 指定的工作目录,会在构建镜像的每一层中都存在。(WORKDIR 指定的工作目录,必须是提前创建好的)。 + +docker build 构建镜像过程中的,每一个 RUN 命令都是新建的一层。只有通过 WORKDIR 创建的目录才会一直存在。 + +格式: + +WORKDIR <工作目录路径> + +#### **USER** + +用于指定执行后续命令的用户和用户组,这边只是切换后续命令执行的用户(用户和用户组必须提前已经存在)。 + +格式: + +USER <用户名>[:<用户组>] + +#### **HEALTHCHECK** + +用于指定某个程序或者指令来监控 docker 容器服务的运行状态。 + +格式: + +HEALTHCHECK [选项] CMD <命令>:设置检查容器健康状况的命令 +HEALTHCHECK NONE:如果基础镜像有健康检查指令,使用这行可以屏蔽掉其健康检查指令 + +HEALTHCHECK [选项] CMD <命令> : 这边 CMD 后面跟随的命令使用,可以参考 CMD 的用法。 + +#### **ONBUILD** + +用于延迟构建命令的执行。简单的说,就是 Dockerfile 里用 ONBUILD 指定的命令,在本次构建镜像的过程中不会执行(假设镜像为 test-build)。当有新的 Dockerfile 使用了之前构建的镜像 FROM test-build ,这时执行新镜像的 Dockerfile 构建时候,会执行 test-build 的 Dockerfile 里的 ONBUILD 指定的命令。 + +格式: + +ONBUILD <其它指令> + +#### **LABEL** + +LABEL 指令用来给镜像添加一些元数据(metadata),以键值对的形式,语法格式如下: + +LABEL = = = ... +比如我们可以添加镜像的作者: + +LABEL org.opencontainers.image.authors="runoob" + +## Compose + +### 简介 + +- Compose 是用于定义和运行多容器 Docker 应用程序的工具。 +- 通过 Compose,可以使用 YML 文件来配置应用程序需要的所有服务。 +- 然后,使用一个命令,就可以从 YML 文件配置中创建并启动所有服务。 + +### 使用步骤 + +1. 使用 Docker 定义应用程序的环境。 +1. 使用 docker-compose.yml 定义构成应用程序的服务,这样它们可以在隔离环境中一起运行。 +1. 最后,执行 `docker-compose up` 这个命令来启动并运行整个应用程序。 + +- docker-compose.yml 配置案例如下: + + ```bash + # yaml 配置实例 + version: '3' + services: + web: + build: . + ports: + - "5000:5000" + volumes: + - .:/code + - logvolume01:/var/log + links: + - redis + redis: + image: redis + volumes: + logvolume01: {} + ``` diff --git a/markdown/Markdown.md b/markdown/Markdown.md index feeec6a7db2139b0fdf72d48d2d452b29b448ed4..34d552965a4e4c8f02e29e3cc173c65d3728039e 100644 --- a/markdown/Markdown.md +++ b/markdown/Markdown.md @@ -2,4 +2,106 @@ ## 参考文档 -- [Markdown]() +- [Markdown 指南中文版](https://www.markdown.xyz/basic-syntax/) + +## 基本语法 + +### 标题 + +- `#` H1 +- `##` H2 +- `###` H3 +- `####` H4 +- `#####` H5 +- `######` H6 +- `===` 一级标题 +- `---` 二级标题 + +### 斜体 + +- 使用一个 `*` 将要格式化的字体包起来。 + +### 加粗 + +- 使用两个 `**` 将要格式化的字体包起来。 + +### 加粗倾斜 + +- 三个 `*` 号包起来,前后各三个 `*` 号。 + +### 删除线 + +- 前后各两个 `~~` + +### 分割线 + +- 使用四个中划线 `----`,并且使用分割线之前必须有一行空行。 + +### 引用 + +- 使用 `>text` 的格式进行引用,并且在引用之前必须有一行是空行。 + +### 列表 + +- 列表使用前必须要加空格 +- 无序列表 + - 使用 -、+、*加上文字 text 的格式 +- 有序列表 + - 使用 num.text 的格式 + +### 表格 + +- 表格前必须空一行 +- 单元格使用 `|` 进行分割,表头的分割符使用 `-` 进行分割。 + - `-` 和 `:-` 表示表头和单元格左对齐 + - `-:` 表示右对齐 + - `:-:` 表示居中对齐。 + +### 代码块 + +- 行内代码,使用前后一个 \` 符号包裹起来,注意这里不是单引号是,是反斜号。 +- 多行代码,使用前后三个 \`\`\` 符号包裹起来。并可以指定一种编程语言进行高亮显示。 + - 例如 + + \```js + + 你好 + + \``` + +### 转义字符 + +- 使用反斜杠,`\` 进行特殊字符的转义。 + +### 链接 + +- `[title](URL)`,例如[百度点这里](https://www.baidu.com),注意这里括号之间没有空格。 +- url 地址需要添加网络协议。 + +### 图片 + +- `![title](URL)` + - title 指的是图片的替代文字 + - URL 是图片的地址 + +## 注意事项 + +### 空格 + +- 中英文之间需要增加空格。 +- 中文与数字之间需要增加空格。 +- 数字与单位之间无需增加空格。 +- 全角标点与其他字符之间不加空格。 + - 例外:裸链接后面需空格,不能紧跟标点,否则有些渲染器会把标点当成链接的一部分。 +- 中文与链接、强调、行内代码等格式间是否加空格取决于内容(即以上规则)。 + - 比如书写 Markdown 的规范需要加,而书写中文的规范不需要加。 + +## 怎么写 Markdown + +- 文件名全部用英文,camelCase。 +- 内容全部用中文写。 +- 图片放到文档所在目录的 images/ 子目录内,使用相对路径引用,比如 `![demo](./images/demo.png)`。 +- 引用同一类目下的文档用相对路径,否则用绝对路径,比如 portal 文档引用 mairpc 文档,应使用 /mairpc/xxx 形式的绝对路径。 +- FAQ 子标题应使用疑问句,问号结尾。 +- 引用人名一律用 @xxx.xxx 的形式。 +- 在书写代码块时,请参考 Prism 支持的语言,否则编译时会出现 'Language does not exist xxx',下面列举了常见的错误写法和对应的正确写法。