From a7f6c0532bd38d6c57d39d4355d2aca19d216ec0 Mon Sep 17 00:00:00 2001 From: Guangwen Feng Date: Thu, 7 Jul 2022 17:27:29 +0800 Subject: [PATCH] [zh-cn] Update certificates.md Signed-off-by: Guangwen Feng --- .../tasks/administer-cluster/certificates.md | 459 ++++++++++-------- 1 file changed, 252 insertions(+), 207 deletions(-) diff --git a/content/zh-cn/docs/tasks/administer-cluster/certificates.md b/content/zh-cn/docs/tasks/administer-cluster/certificates.md index 2dfafa463b..6a86ded9eb 100644 --- a/content/zh-cn/docs/tasks/administer-cluster/certificates.md +++ b/content/zh-cn/docs/tasks/administer-cluster/certificates.md @@ -29,63 +29,74 @@ manually through `easyrsa`, `openssl` or `cfssl`. **easyrsa** 支持以手工方式为你的集群生成证书。 -1. 下载、解压、初始化打过补丁的 easyrsa3。 +1. 下载、解压、初始化打过补丁的 `easyrsa3`。 - curl -LO https://storage.googleapis.com/kubernetes-release/easy-rsa/easy-rsa.tar.gz - tar xzf easy-rsa.tar.gz - cd easy-rsa-master/easyrsa3 - ./easyrsa init-pki + ```shell + curl -LO https://storage.googleapis.com/kubernetes-release/easy-rsa/easy-rsa.tar.gz + tar xzf easy-rsa.tar.gz + cd easy-rsa-master/easyrsa3 + ./easyrsa init-pki + ``` -2. 生成新的证书颁发机构(CA)。参数 `--batch` 用于设置自动模式; - 参数 `--req-cn` 用于设置新的根证书的通用名称(CN)。 +2. 生成新的证书颁发机构(CA)。参数 `--batch` 用于设置自动模式; + 参数 `--req-cn` 用于设置新的根证书的通用名称(CN)。 - ./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca nopass + ```shell + ./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca nopass + ``` -3. 生成服务器证书和秘钥。 - 参数 `--subject-alt-name` 设置 API 服务器的 IP 和 DNS 名称。 - `MASTER_CLUSTER_IP` 用于 API 服务器和控制管理器,通常取 CIDR 的第一个 IP,由 `--service-cluster-ip-range` 的参数提供。 - 参数 `--days` 用于设置证书的过期时间。 - 下面的示例假定你的默认 DNS 域名为 `cluster.local`。 +1. Generate server certificate and key. - ./easyrsa --subject-alt-name="IP:${MASTER_IP},"\ - "IP:${MASTER_CLUSTER_IP},"\ - "DNS:kubernetes,"\ - "DNS:kubernetes.default,"\ - "DNS:kubernetes.default.svc,"\ - "DNS:kubernetes.default.svc.cluster,"\ - "DNS:kubernetes.default.svc.cluster.local" \ - --days=10000 \ - build-server-full server nopass + The argument `--subject-alt-name` sets the possible IPs and DNS names the API server will + be accessed with. The `MASTER_CLUSTER_IP` is usually the first IP from the service CIDR + that is specified as the `--service-cluster-ip-range` argument for both the API server and + the controller manager component. The argument `--days` is used to set the number of days + after which the certificate expires. + The sample below also assumes that you are using `cluster.local` as the default + DNS domain name. +--> +3. 生成服务器证书和秘钥。 + + 参数 `--subject-alt-name` 设置 API 服务器的 IP 和 DNS 名称。 + `MASTER_CLUSTER_IP` 用于 API 服务器和控制器管理器,通常取 CIDR 的第一个 IP, + 由 `--service-cluster-ip-range` 的参数提供。 + 参数 `--days` 用于设置证书的过期时间。 + 下面的示例假定你的默认 DNS 域名为 `cluster.local`。 + + ```shell + ./easyrsa --subject-alt-name="IP:${MASTER_IP},"\ + "IP:${MASTER_CLUSTER_IP},"\ + "DNS:kubernetes,"\ + "DNS:kubernetes.default,"\ + "DNS:kubernetes.default.svc,"\ + "DNS:kubernetes.default.svc.cluster,"\ + "DNS:kubernetes.default.svc.cluster.local" \ + --days=10000 \ + build-server-full server nopass + ``` -4. 拷贝文件 `pki/ca.crt`、`pki/issued/server.crt` 和 `pki/private/server.key` 到你的目录中。 +4. 拷贝文件 `pki/ca.crt`、`pki/issued/server.crt` 和 `pki/private/server.key` 到你的目录中。 -5. 在 API 服务器的启动参数中添加以下参数: +5. 在 API 服务器的启动参数中添加以下参数: - --client-ca-file=/yourdirectory/ca.crt - --tls-cert-file=/yourdirectory/server.crt - --tls-private-key-file=/yourdirectory/server.key + ```shell + --client-ca-file=/yourdirectory/ca.crt + --tls-cert-file=/yourdirectory/server.crt + --tls-private-key-file=/yourdirectory/server.key + ``` ### openssl @@ -95,103 +106,120 @@ DNS domain name. **openssl** 支持以手工方式为你的集群生成证书。 -1. 生成一个 2048 位的 ca.key 文件 +1. 生成一个 2048 位的 ca.key 文件 - openssl genrsa -out ca.key 2048 + ```shell + openssl genrsa -out ca.key 2048 + ``` -2. 在 ca.key 文件的基础上,生成 ca.crt 文件(用参数 -days 设置证书有效期) +2. 在 ca.key 文件的基础上,生成 ca.crt 文件(用参数 `-days` 设置证书有效期) - openssl req -x509 -new -nodes -key ca.key -subj "/CN=${MASTER_IP}" -days 10000 -out ca.crt + ```shell + openssl req -x509 -new -nodes -key ca.key -subj "/CN=${MASTER_IP}" -days 10000 -out ca.crt + ``` -3. 生成一个 2048 位的 server.key 文件: +3. 生成一个 2048 位的 server.key 文件: - openssl genrsa -out server.key 2048 + ```shell + openssl genrsa -out server.key 2048 + ``` -4. 创建一个用于生成证书签名请求(CSR)的配置文件。 - 保存文件(例如:`csr.conf`)前,记得用真实值替换掉尖括号中的值(例如:``)。 - 注意:`MASTER_CLUSTER_IP` 就像前一小节所述,它的值是 API 服务器的服务集群 IP。 - 下面的例子假定你的默认 DNS 域名为 `cluster.local`。 +4. 创建一个用于生成证书签名请求(CSR)的配置文件。 + 保存文件(例如:`csr.conf`)前,记得用真实值替换掉尖括号中的值(例如:``)。 + 注意:`MASTER_CLUSTER_IP` 就像前一小节所述,它的值是 API 服务器的服务集群 IP。 + 下面的例子假定你的默认 DNS 域名为 `cluster.local`。 - [ req ] - default_bits = 2048 - prompt = no - default_md = sha256 - req_extensions = req_ext - distinguished_name = dn + ```ini + [ req ] + default_bits = 2048 + prompt = no + default_md = sha256 + req_extensions = req_ext + distinguished_name = dn - [ dn ] - C = - ST = - L = - O = - OU = - CN = + [ dn ] + C = + ST = + L = + O = + OU = + CN = - [ req_ext ] - subjectAltName = @alt_names + [ req_ext ] + subjectAltName = @alt_names - [ alt_names ] - DNS.1 = kubernetes - DNS.2 = kubernetes.default - DNS.3 = kubernetes.default.svc - DNS.4 = kubernetes.default.svc.cluster - DNS.5 = kubernetes.default.svc.cluster.local - IP.1 = - IP.2 = + [ alt_names ] + DNS.1 = kubernetes + DNS.2 = kubernetes.default + DNS.3 = kubernetes.default.svc + DNS.4 = kubernetes.default.svc.cluster + DNS.5 = kubernetes.default.svc.cluster.local + IP.1 = + IP.2 = - [ v3_ext ] - authorityKeyIdentifier=keyid,issuer:always - basicConstraints=CA:FALSE - keyUsage=keyEncipherment,dataEncipherment - extendedKeyUsage=serverAuth,clientAuth - subjectAltName=@alt_names + [ v3_ext ] + authorityKeyIdentifier=keyid,issuer:always + basicConstraints=CA:FALSE + keyUsage=keyEncipherment,dataEncipherment + extendedKeyUsage=serverAuth,clientAuth + subjectAltName=@alt_names + ``` -5. 基于上面的配置文件生成证书签名请求: +5. 基于上面的配置文件生成证书签名请求: - openssl req -new -key server.key -out server.csr -config csr.conf + ```shell + openssl req -new -key server.key -out server.csr -config csr.conf + ``` -6. 基于 ca.key、ca.crt 和 server.csr 等三个文件生成服务端证书: +6. 基于 ca.key、ca.crt 和 server.csr 等三个文件生成服务端证书: - openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key \ - -CAcreateserial -out server.crt -days 10000 \ - -extensions v3_ext -extfile csr.conf + ```shell + openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key \ + -CAcreateserial -out server.crt -days 10000 \ + -extensions v3_ext -extfile csr.conf + ``` -7. 查看证书签名请求: +7. 查看证书签名请求: - openssl req -noout -text -in ./server.csr + ```shell + openssl req -noout -text -in ./server.csr + ``` -8. 查看证书: +8. 查看证书: - openssl x509 -noout -text -in ./server.crt + ```shell + openssl x509 -noout -text -in ./server.crt + ``` -1. 下载、解压并准备如下所示的命令行工具。 - 注意:你可能需要根据所用的硬件体系架构和 cfssl 版本调整示例命令。 +1. Download, unpack and prepare the command line tools as shown below. - curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl_1.5.0_linux_amd64 -o cfssl - chmod +x cfssl - curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssljson_1.5.0_linux_amd64 -o cfssljson - chmod +x cfssljson - curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl-certinfo_1.5.0_linux_amd64 -o cfssl-certinfo - chmod +x cfssl-certinfo + Note that you may need to adapt the sample commands based on the hardware + architecture and cfssl version you are using. +--> +1. 下载、解压并准备如下所示的命令行工具。 + + 注意:你可能需要根据所用的硬件体系架构和 cfssl 版本调整示例命令。 + + ```shell + curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl_1.5.0_linux_amd64 -o cfssl + chmod +x cfssl + curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssljson_1.5.0_linux_amd64 -o cfssljson + chmod +x cfssljson + curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl-certinfo_1.5.0_linux_amd64 -o cfssl-certinfo + chmod +x cfssl-certinfo + ``` -2. 创建一个目录,用它保存所生成的构件和初始化 cfssl: +2. 创建一个目录,用它保存所生成的构件和初始化 cfssl: - mkdir cert - cd cert - ../cfssl print-defaults config > config.json - ../cfssl print-defaults csr > csr.json + ```shell + mkdir cert + cd cert + ../cfssl print-defaults config > config.json + ../cfssl print-defaults csr > csr.json + ``` -3. 创建一个 JSON 配置文件来生成 CA 文件,例如:`ca-config.json`: +3. 创建一个 JSON 配置文件来生成 CA 文件,例如:`ca-config.json`: - { - "signing": { - "default": { - "expiry": "8760h" - }, - "profiles": { - "kubernetes": { - "usages": [ - "signing", - "key encipherment", - "server auth", - "client auth" - ], - "expiry": "8760h" - } - } - } - } + ```json + { + "signing": { + "default": { + "expiry": "8760h" + }, + "profiles": { + "kubernetes": { + "usages": [ + "signing", + "key encipherment", + "server auth", + "client auth" + ], + "expiry": "8760h" + } + } + } + } + ``` -4. 创建一个 JSON 配置文件,用于 CA 证书签名请求(CSR),例如:`ca-csr.json`。 - 确认用你需要的值替换掉尖括号中的值。 +4. 创建一个 JSON 配置文件,用于 CA 证书签名请求(CSR),例如:`ca-csr.json`。 + 确认用你需要的值替换掉尖括号中的值。 - { - "CN": "kubernetes", - "key": { - "algo": "rsa", - "size": 2048 - }, - "names":[{ - "C": "", - "ST": "", - "L": "", - "O": "", - "OU": "" - }] - } + ```json + { + "CN": "kubernetes", + "key": { + "algo": "rsa", + "size": 2048 + }, + "names":[{ + "C": "", + "ST": "", + "L": "", + "O": "", + "OU": "" + }] + } + ``` -5. 生成 CA 秘钥文件(`ca-key.pem`)和证书文件(`ca.pem`): +5. 生成 CA 秘钥文件(`ca-key.pem`)和证书文件(`ca.pem`): - ../cfssl gencert -initca ca-csr.json | ../cfssljson -bare ca + ```shell + ../cfssl gencert -initca ca-csr.json | ../cfssljson -bare ca + ``` -6. 创建一个 JSON 配置文件,用来为 API 服务器生成秘钥和证书,例如:`server-csr.json`。 - 确认用你需要的值替换掉尖括号中的值。`MASTER_CLUSTER_IP` 是为 API 服务器 指定的服务集群 IP,就像前面小节描述的那样。 - 以下示例假定你的默认 DNS 域名为`cluster.local`。 +6. 创建一个 JSON 配置文件,用来为 API 服务器生成秘钥和证书,例如:`server-csr.json`。 + 确认用你需要的值替换掉尖括号中的值。`MASTER_CLUSTER_IP` 是为 API 服务器 指定的服务集群 IP,就像前面小节描述的那样。 + 以下示例假定你的默认 DNS 域名为`cluster.local`。 - { - "CN": "kubernetes", - "hosts": [ - "127.0.0.1", - "", - "", - "kubernetes", - "kubernetes.default", - "kubernetes.default.svc", - "kubernetes.default.svc.cluster", - "kubernetes.default.svc.cluster.local" - ], - "key": { - "algo": "rsa", - "size": 2048 - }, - "names": [{ - "C": "", - "ST": "", - "L": "", - "O": "", - "OU": "" - }] - } + ```json + { + "CN": "kubernetes", + "hosts": [ + "127.0.0.1", + "", + "", + "kubernetes", + "kubernetes.default", + "kubernetes.default.svc", + "kubernetes.default.svc.cluster", + "kubernetes.default.svc.cluster.local" + ], + "key": { + "algo": "rsa", + "size": 2048 + }, + "names": [{ + "C": "", + "ST": "", + "L": "", + "O": "", + "OU": "" + }] + } + ``` -7. 为 API 服务器生成秘钥和证书,默认会分别存储为`server-key.pem` 和 `server.pem` 两个文件。 +7. 为 API 服务器生成秘钥和证书,默认会分别存储为`server-key.pem` 和 `server.pem` 两个文件。 - ../cfssl gencert -ca=ca.pem -ca-key=ca-key.pem \ + ```shell + ../cfssl gencert -ca=ca.pem -ca-key=ca-key.pem \ --config=ca-config.json -profile=kubernetes \ server-csr.json | ../cfssljson -bare server + ``` -## 分发自签名的 CA 证书 +## 分发自签名的 CA 证书 {#distributing-self-signed-ca-certificate} -## 证书 API {#certificates-api} +## 证书 API {#certificates-api} 你可以通过 `certificates.k8s.io` API 提供 x509 证书,用来做身份验证, -如[本](/zh-cn/docs/tasks/tls/managing-tls-in-a-cluster)文档所述。 +如[管理集群中的 TLS 认证](/zh-cn/docs/tasks/tls/managing-tls-in-a-cluster)文档所述。