Merge branch 'master' into japanese-translation

This commit is contained in:
Yoni Goldberg
2021-02-03 10:35:30 +02:00
committed by GitHub
65 changed files with 6089 additions and 1470 deletions

View File

@ -0,0 +1,92 @@
# 清理编译过程中的秘钥,避免使用秘钥作为参数
<br/><br/>
### 一段解释
Docker映像不仅仅是一堆文件而是展示构建期间所发生的层级关系。在普通场景中开发人员在构建过程中需要知道npm令牌主要是对于私有registry- 会通过把令牌作为构建参数来传递但这种实现是错误的。这可能看起来是没什么问题并且安全但此令牌可以从开发人员机器中的Docker历史记录、Docker registry和CI中获得。获取到该令牌的攻击者就能够拥有写入此组织私有npm registry的权限。还有两个更安全的替代方法完美无瑕的一个替代方案是使用Docker --secret功能截至2020年7月还在实验阶段它只允许在构建期间挂载mount文件。第二种方法是使用带args的多阶段multi-stage构建然后只将必要的文件复制到生产环境。后一种技术将不会同时一起提供秘钥与镜像但秘钥将出现在本地Docker的历史记录中 - 对大多数组织来说,这通常被认为足够安全。
<br/><br/>
### 代码示例 使用Docker挂载秘钥实验功能但稳定
<details>
<summary><strong>Dockerfile</strong></summary>
```
# syntax = docker/dockerfile:1.0-experimental
FROM node:12-slim
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN --mount=type=secret,id=npm,target=/root/.npmrc npm ci
# 剩余部分
```
</details>
<br/><br/>
### 代码示例 使用多阶段multi-stage build安全构建
<details>
<summary><strong>Dockerfile</strong></summary>
```
FROM node:12-slim AS build
ARG NPM_TOKEN
WORKDIR /usr/src/app
COPY . /dist
RUN echo "//registry.npmjs.org/:\_authToken=\$NPM_TOKEN" > .npmrc && \
npm ci --production && \
rm -f .npmrc
FROM build as prod
COPY --from=build /dist /dist
CMD ["node","index.js"]
# ARG和.npmrc在最终的镜像中不会出现但会在Docker daemon的未打标签un-tagged镜像列表中找到它们 - 确保删除他们
```
</details>
<br/><br/>
### 代码示例 反模式 - 使用构建参数
<details>
<summary><strong>Dockerfile</strong></summary>
```
FROM node:12-slim
ARG NPM_TOKEN
WORKDIR /usr/src/app
COPY . /dist
RUN echo "//registry.npmjs.org/:\_authToken=\$NPM_TOKEN" > .npmrc && \
npm ci --production && \
rm -f .npmrc
# 在拷贝命令的同时删除.npmrc文件不会在layer里面保存它, 但在镜像历史里面还是会找到它
CMD ["node","index.js"]
```
</details>
<br/><br/>
### 博客引用: "秘钥不会保存在最终的Docker中"
摘自博客, [Alexandra Ulsh](https://www.alexandraulsh.com/2019/02/24/docker-build-secrets-and-npmrc/?fbclid=IwAR0EAr1nr4_QiGzlNQcQKkd9rem19an9atJRO_8-n7oOZXwprToFQ53Y0KQ)
> 在2018年11月Docker18.09在docker构建过程中引入一个新的标志flag--secret。它允许用户通过一个文件传递秘钥到Docker包中build。这些秘钥不会保存在最终的Docker镜像中间镜像和镜像提交历史里面。借助构建参数secret您现在可以使用私有npm包安全地构建Docker映像而无需构建参数和多阶段multi-stage构建。
```
```

View File

@ -0,0 +1,85 @@
# 使用node命令而不是npm启动容器
## 一段解释
我们经常看到开发者使用`CMD 'npm start'`启动app的代码示例。这是一个不好的做法。因为`npm`不会向您的app转发信号signals这将阻止应用优雅关闭graceful shutdown见[/sections/docker/graceful-shutdown.md]。如果您使用了子进程child-processes在意外关闭时则无法正确清理它们将僵尸进程留在主机上。同时`npm start`也导致无意义的增加一个额外进程。使用`CMD ['node','server.js']`启动您的应用吧。假如您的应用使用了子进程child-processes也可以使用`TINI`作为入口entrypoint
### 代码示例 - 启动Node
```dockerfile
FROM node:12-slim AS build
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --production && npm clean cache --force
CMD ["node", "server.js"]
```
### 代码示例 - 使用Tiny作为入口ENTRYPOINT
```dockerfile
FROM node:12-slim AS build
# 使用子进程child-processes的情况下添加Tini
ENV TINI_VERSION v0.19.0
ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
RUN chmod +x /tini
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --production && npm clean cache --force
ENTRYPOINT ["/tini", "--"]
CMD ["node", "server.js"]
```
### 反模式
使用npm start
```dockerfile
FROM node:12-slim AS build
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --production && npm clean cache --force
# 不要这么做!
CMD "npm start"
```
在同一字符串命令里面使用node将启动一个bash/ash脚本进程去执行您的命令。它和使用`npm`的效果类似。
```dockerfile
FROM node:12-slim AS build
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --production && npm clean cache --force
# 不要这么做它将启动bash
CMD "node server.js"
```
使用npm启动这里是进程树
```
$ ps falx
UID PID PPID COMMAND
0 1 0 npm
0 16 1 sh -c node server.js
0 17 16 \_ node server.js
```
额外的两个进程没有任何好处。
来源:
https://maximorlov.com/process-signals-inside-docker-containers/
https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md#handling-kernel-signals

View File

@ -47,7 +47,7 @@ Using npm start
FROM node:12-slim AS build
WORKDIR /usr/src/app
COPY package.json package-lock.json ./
RUN npm ci --production && npm clean cache --force
RUN npm ci --production && npm cache clean --force
# dont do that!
CMD "npm start"

View File

@ -19,8 +19,10 @@ Let's imagine the following directory structure
- README.md
```
Your [.dockerignore](/sections/docker/dockerignore.md) will already filter out files that won't be needed for building and running your application.
Your [.dockerignore](../docker/docker-ignore.md) will already filter out files that won't be needed for building and running your application.
sections/docker/docker-ignore.md
```
# Don't copy in existing node_modules, we'll fetch our own
node_modules