Merge pull request #34730 from tengqm/tune-certificates
Normalize the markdown for certificates page
This commit is contained in:
Kubernetes Prow Robot
@@ -4,124 +4,156 @@ content_type: task
|
|||||||
weight: 20
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
<!-- overview -->
|
<!-- overview -->
|
||||||
|
|
||||||
When using client certificate authentication, you can generate certificates
|
When using client certificate authentication, you can generate certificates
|
||||||
manually through `easyrsa`, `openssl` or `cfssl`.
|
manually through `easyrsa`, `openssl` or `cfssl`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- body -->
|
<!-- body -->
|
||||||
|
|
||||||
### easyrsa
|
### easyrsa
|
||||||
|
|
||||||
**easyrsa** can manually generate certificates for your cluster.
|
**easyrsa** can manually generate certificates for your cluster.
|
||||||
|
|
||||||
1. Download, unpack, and initialize the patched version of easyrsa3.
|
1. Download, unpack, and initialize the patched version of `easyrsa3`.
|
||||||
|
|
||||||
curl -LO https://storage.googleapis.com/kubernetes-release/easy-rsa/easy-rsa.tar.gz
|
```shell
|
||||||
tar xzf easy-rsa.tar.gz
|
curl -LO https://storage.googleapis.com/kubernetes-release/easy-rsa/easy-rsa.tar.gz
|
||||||
cd easy-rsa-master/easyrsa3
|
tar xzf easy-rsa.tar.gz
|
||||||
./easyrsa init-pki
|
cd easy-rsa-master/easyrsa3
|
||||||
1. Generate a new certificate authority (CA). `--batch` sets automatic mode;
|
./easyrsa init-pki
|
||||||
`--req-cn` specifies the Common Name (CN) for the CA's new root certificate.
|
```
|
||||||
|
1. Generate a new certificate authority (CA). `--batch` sets automatic mode;
|
||||||
|
`--req-cn` specifies the Common Name (CN) for the CA's new root certificate.
|
||||||
|
|
||||||
./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca nopass
|
```shell
|
||||||
1. Generate server certificate and key.
|
./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca 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.
|
|
||||||
|
|
||||||
./easyrsa --subject-alt-name="IP:${MASTER_IP},"\
|
1. Generate server certificate and key.
|
||||||
"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
|
|
||||||
1. Copy `pki/ca.crt`, `pki/issued/server.crt`, and `pki/private/server.key` to your directory.
|
|
||||||
1. Fill in and add the following parameters into the API server start parameters:
|
|
||||||
|
|
||||||
--client-ca-file=/yourdirectory/ca.crt
|
The argument `--subject-alt-name` sets the possible IPs and DNS names the API server will
|
||||||
--tls-cert-file=/yourdirectory/server.crt
|
be accessed with. The `MASTER_CLUSTER_IP` is usually the first IP from the service CIDR
|
||||||
--tls-private-key-file=/yourdirectory/server.key
|
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.
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Copy `pki/ca.crt`, `pki/issued/server.crt`, and `pki/private/server.key` to your directory.
|
||||||
|
|
||||||
|
1. Fill in and add the following parameters into the API server start parameters:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
--client-ca-file=/yourdirectory/ca.crt
|
||||||
|
--tls-cert-file=/yourdirectory/server.crt
|
||||||
|
--tls-private-key-file=/yourdirectory/server.key
|
||||||
|
```
|
||||||
|
|
||||||
### openssl
|
### openssl
|
||||||
|
|
||||||
**openssl** can manually generate certificates for your cluster.
|
**openssl** can manually generate certificates for your cluster.
|
||||||
|
|
||||||
1. Generate a ca.key with 2048bit:
|
1. Generate a ca.key with 2048bit:
|
||||||
|
|
||||||
openssl genrsa -out ca.key 2048
|
```shell
|
||||||
1. According to the ca.key generate a ca.crt (use -days to set the certificate effective time):
|
openssl genrsa -out ca.key 2048
|
||||||
|
```
|
||||||
|
|
||||||
openssl req -x509 -new -nodes -key ca.key -subj "/CN=${MASTER_IP}" -days 10000 -out ca.crt
|
1. According to the ca.key generate a ca.crt (use `-days` to set the certificate effective time):
|
||||||
1. Generate a server.key with 2048bit:
|
|
||||||
|
|
||||||
openssl genrsa -out server.key 2048
|
```shell
|
||||||
1. Create a config file for generating a Certificate Signing Request (CSR).
|
openssl req -x509 -new -nodes -key ca.key -subj "/CN=${MASTER_IP}" -days 10000 -out ca.crt
|
||||||
Be sure to substitute the values marked with angle brackets (e.g. `<MASTER_IP>`)
|
```
|
||||||
with real values before saving this to a file (e.g. `csr.conf`).
|
|
||||||
Note that the value for `MASTER_CLUSTER_IP` is the service cluster IP for the
|
|
||||||
API server as described in previous subsection.
|
|
||||||
The sample below also assumes that you are using `cluster.local` as the default
|
|
||||||
DNS domain name.
|
|
||||||
|
|
||||||
[ req ]
|
1. Generate a server.key with 2048bit:
|
||||||
default_bits = 2048
|
|
||||||
prompt = no
|
|
||||||
default_md = sha256
|
|
||||||
req_extensions = req_ext
|
|
||||||
distinguished_name = dn
|
|
||||||
|
|
||||||
[ dn ]
|
```shell
|
||||||
C = <country>
|
openssl genrsa -out server.key 2048
|
||||||
ST = <state>
|
```
|
||||||
L = <city>
|
|
||||||
O = <organization>
|
|
||||||
OU = <organization unit>
|
|
||||||
CN = <MASTER_IP>
|
|
||||||
|
|
||||||
[ req_ext ]
|
1. Create a config file for generating a Certificate Signing Request (CSR).
|
||||||
subjectAltName = @alt_names
|
|
||||||
|
|
||||||
[ alt_names ]
|
Be sure to substitute the values marked with angle brackets (e.g. `<MASTER_IP>`)
|
||||||
DNS.1 = kubernetes
|
with real values before saving this to a file (e.g. `csr.conf`).
|
||||||
DNS.2 = kubernetes.default
|
Note that the value for `MASTER_CLUSTER_IP` is the service cluster IP for the
|
||||||
DNS.3 = kubernetes.default.svc
|
API server as described in previous subsection.
|
||||||
DNS.4 = kubernetes.default.svc.cluster
|
The sample below also assumes that you are using `cluster.local` as the default
|
||||||
DNS.5 = kubernetes.default.svc.cluster.local
|
DNS domain name.
|
||||||
IP.1 = <MASTER_IP>
|
|
||||||
IP.2 = <MASTER_CLUSTER_IP>
|
|
||||||
|
|
||||||
[ v3_ext ]
|
```ini
|
||||||
authorityKeyIdentifier=keyid,issuer:always
|
[ req ]
|
||||||
basicConstraints=CA:FALSE
|
default_bits = 2048
|
||||||
keyUsage=keyEncipherment,dataEncipherment
|
prompt = no
|
||||||
extendedKeyUsage=serverAuth,clientAuth
|
default_md = sha256
|
||||||
subjectAltName=@alt_names
|
req_extensions = req_ext
|
||||||
1. Generate the certificate signing request based on the config file:
|
distinguished_name = dn
|
||||||
|
|
||||||
openssl req -new -key server.key -out server.csr -config csr.conf
|
[ dn ]
|
||||||
1. Generate the server certificate using the ca.key, ca.crt and server.csr:
|
C = <country>
|
||||||
|
ST = <state>
|
||||||
|
L = <city>
|
||||||
|
O = <organization>
|
||||||
|
OU = <organization unit>
|
||||||
|
CN = <MASTER_IP>
|
||||||
|
|
||||||
openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key \
|
[ req_ext ]
|
||||||
-CAcreateserial -out server.crt -days 10000 \
|
subjectAltName = @alt_names
|
||||||
-extensions v3_ext -extfile csr.conf
|
|
||||||
1. View the certificate signing request:
|
|
||||||
|
|
||||||
openssl req -noout -text -in ./server.csr
|
[ alt_names ]
|
||||||
1. View the certificate:
|
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 = <MASTER_IP>
|
||||||
|
IP.2 = <MASTER_CLUSTER_IP>
|
||||||
|
|
||||||
openssl x509 -noout -text -in ./server.crt
|
[ v3_ext ]
|
||||||
|
authorityKeyIdentifier=keyid,issuer:always
|
||||||
|
basicConstraints=CA:FALSE
|
||||||
|
keyUsage=keyEncipherment,dataEncipherment
|
||||||
|
extendedKeyUsage=serverAuth,clientAuth
|
||||||
|
subjectAltName=@alt_names
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Generate the certificate signing request based on the config file:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
openssl req -new -key server.key -out server.csr -config csr.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Generate the server certificate using the ca.key, ca.crt and server.csr:
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
1. View the certificate signing request:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
openssl req -noout -text -in ./server.csr
|
||||||
|
```
|
||||||
|
|
||||||
|
1. View the certificate:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
openssl x509 -noout -text -in ./server.crt
|
||||||
|
```
|
||||||
|
|
||||||
Finally, add the same parameters into the API server start parameters.
|
Finally, add the same parameters into the API server start parameters.
|
||||||
|
|
||||||
@@ -129,101 +161,121 @@ Finally, add the same parameters into the API server start parameters.
|
|||||||
|
|
||||||
**cfssl** is another tool for certificate generation.
|
**cfssl** is another tool for certificate generation.
|
||||||
|
|
||||||
1. Download, unpack and prepare the command line tools as shown below.
|
1. Download, unpack and prepare the command line tools as shown below.
|
||||||
Note that you may need to adapt the sample commands based on the hardware
|
|
||||||
architecture and cfssl version you are using.
|
|
||||||
|
|
||||||
curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl_1.5.0_linux_amd64 -o cfssl
|
Note that you may need to adapt the sample commands based on the hardware
|
||||||
chmod +x cfssl
|
architecture and cfssl version you are using.
|
||||||
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
|
|
||||||
1. Create a directory to hold the artifacts and initialize cfssl:
|
|
||||||
|
|
||||||
mkdir cert
|
```shell
|
||||||
cd cert
|
curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssl_1.5.0_linux_amd64 -o cfssl
|
||||||
../cfssl print-defaults config > config.json
|
chmod +x cfssl
|
||||||
../cfssl print-defaults csr > csr.json
|
curl -L https://github.com/cloudflare/cfssl/releases/download/v1.5.0/cfssljson_1.5.0_linux_amd64 -o cfssljson
|
||||||
1. Create a JSON config file for generating the CA file, for example, `ca-config.json`:
|
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
|
||||||
|
```
|
||||||
|
|
||||||
{
|
1. Create a directory to hold the artifacts and initialize cfssl:
|
||||||
"signing": {
|
|
||||||
"default": {
|
|
||||||
"expiry": "8760h"
|
|
||||||
},
|
|
||||||
"profiles": {
|
|
||||||
"kubernetes": {
|
|
||||||
"usages": [
|
|
||||||
"signing",
|
|
||||||
"key encipherment",
|
|
||||||
"server auth",
|
|
||||||
"client auth"
|
|
||||||
],
|
|
||||||
"expiry": "8760h"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
1. Create a JSON config file for CA certificate signing request (CSR), for example,
|
|
||||||
`ca-csr.json`. Be sure to replace the values marked with angle brackets with
|
|
||||||
real values you want to use.
|
|
||||||
|
|
||||||
{
|
```shell
|
||||||
"CN": "kubernetes",
|
mkdir cert
|
||||||
"key": {
|
cd cert
|
||||||
"algo": "rsa",
|
../cfssl print-defaults config > config.json
|
||||||
"size": 2048
|
../cfssl print-defaults csr > csr.json
|
||||||
},
|
```
|
||||||
"names":[{
|
|
||||||
"C": "<country>",
|
|
||||||
"ST": "<state>",
|
|
||||||
"L": "<city>",
|
|
||||||
"O": "<organization>",
|
|
||||||
"OU": "<organization unit>"
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
1. Generate CA key (`ca-key.pem`) and certificate (`ca.pem`):
|
|
||||||
|
|
||||||
../cfssl gencert -initca ca-csr.json | ../cfssljson -bare ca
|
1. Create a JSON config file for generating the CA file, for example, `ca-config.json`:
|
||||||
1. Create a JSON config file for generating keys and certificates for the API
|
|
||||||
server, for example, `server-csr.json`. Be sure to replace the values in angle brackets with
|
|
||||||
real values you want to use. The `MASTER_CLUSTER_IP` is the service cluster
|
|
||||||
IP for the API server as described in previous subsection.
|
|
||||||
The sample below also assumes that you are using `cluster.local` as the default
|
|
||||||
DNS domain name.
|
|
||||||
|
|
||||||
{
|
```json
|
||||||
"CN": "kubernetes",
|
{
|
||||||
"hosts": [
|
"signing": {
|
||||||
"127.0.0.1",
|
"default": {
|
||||||
"<MASTER_IP>",
|
"expiry": "8760h"
|
||||||
"<MASTER_CLUSTER_IP>",
|
},
|
||||||
"kubernetes",
|
"profiles": {
|
||||||
"kubernetes.default",
|
"kubernetes": {
|
||||||
"kubernetes.default.svc",
|
"usages": [
|
||||||
"kubernetes.default.svc.cluster",
|
"signing",
|
||||||
"kubernetes.default.svc.cluster.local"
|
"key encipherment",
|
||||||
],
|
"server auth",
|
||||||
"key": {
|
"client auth"
|
||||||
"algo": "rsa",
|
],
|
||||||
"size": 2048
|
"expiry": "8760h"
|
||||||
},
|
}
|
||||||
"names": [{
|
}
|
||||||
"C": "<country>",
|
}
|
||||||
"ST": "<state>",
|
}
|
||||||
"L": "<city>",
|
```
|
||||||
"O": "<organization>",
|
|
||||||
"OU": "<organization unit>"
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
1. Generate the key and certificate for the API server, which are by default
|
|
||||||
saved into file `server-key.pem` and `server.pem` respectively:
|
|
||||||
|
|
||||||
../cfssl gencert -ca=ca.pem -ca-key=ca-key.pem \
|
1. Create a JSON config file for CA certificate signing request (CSR), for example,
|
||||||
|
`ca-csr.json`. Be sure to replace the values marked with angle brackets with
|
||||||
|
real values you want to use.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"CN": "kubernetes",
|
||||||
|
"key": {
|
||||||
|
"algo": "rsa",
|
||||||
|
"size": 2048
|
||||||
|
},
|
||||||
|
"names":[{
|
||||||
|
"C": "<country>",
|
||||||
|
"ST": "<state>",
|
||||||
|
"L": "<city>",
|
||||||
|
"O": "<organization>",
|
||||||
|
"OU": "<organization unit>"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Generate CA key (`ca-key.pem`) and certificate (`ca.pem`):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
../cfssl gencert -initca ca-csr.json | ../cfssljson -bare ca
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Create a JSON config file for generating keys and certificates for the API
|
||||||
|
server, for example, `server-csr.json`. Be sure to replace the values in angle brackets with
|
||||||
|
real values you want to use. The `<MASTER_CLUSTER_IP>` is the service cluster
|
||||||
|
IP for the API server as described in previous subsection.
|
||||||
|
The sample below also assumes that you are using `cluster.local` as the default
|
||||||
|
DNS domain name.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"CN": "kubernetes",
|
||||||
|
"hosts": [
|
||||||
|
"127.0.0.1",
|
||||||
|
"<MASTER_IP>",
|
||||||
|
"<MASTER_CLUSTER_IP>",
|
||||||
|
"kubernetes",
|
||||||
|
"kubernetes.default",
|
||||||
|
"kubernetes.default.svc",
|
||||||
|
"kubernetes.default.svc.cluster",
|
||||||
|
"kubernetes.default.svc.cluster.local"
|
||||||
|
],
|
||||||
|
"key": {
|
||||||
|
"algo": "rsa",
|
||||||
|
"size": 2048
|
||||||
|
},
|
||||||
|
"names": [{
|
||||||
|
"C": "<country>",
|
||||||
|
"ST": "<state>",
|
||||||
|
"L": "<city>",
|
||||||
|
"O": "<organization>",
|
||||||
|
"OU": "<organization unit>"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Generate the key and certificate for the API server, which are by default
|
||||||
|
saved into file `server-key.pem` and `server.pem` respectively:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
../cfssl gencert -ca=ca.pem -ca-key=ca-key.pem \
|
||||||
--config=ca-config.json -profile=kubernetes \
|
--config=ca-config.json -profile=kubernetes \
|
||||||
server-csr.json | ../cfssljson -bare server
|
server-csr.json | ../cfssljson -bare server
|
||||||
|
```
|
||||||
|
|
||||||
## Distributing Self-Signed CA Certificate
|
## Distributing Self-Signed CA Certificate
|
||||||
|
|
||||||
@@ -234,12 +286,12 @@ refresh the local list for valid certificates.
|
|||||||
|
|
||||||
On each client, perform the following operations:
|
On each client, perform the following operations:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
sudo cp ca.crt /usr/local/share/ca-certificates/kubernetes.crt
|
sudo cp ca.crt /usr/local/share/ca-certificates/kubernetes.crt
|
||||||
sudo update-ca-certificates
|
sudo update-ca-certificates
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```none
|
||||||
Updating certificates in /etc/ssl/certs...
|
Updating certificates in /etc/ssl/certs...
|
||||||
1 added, 0 removed; done.
|
1 added, 0 removed; done.
|
||||||
Running hooks in /etc/ca-certificates/update.d....
|
Running hooks in /etc/ca-certificates/update.d....
|
||||||
@@ -250,6 +302,6 @@ done.
|
|||||||
|
|
||||||
You can use the `certificates.k8s.io` API to provision
|
You can use the `certificates.k8s.io` API to provision
|
||||||
x509 certificates to use for authentication as documented
|
x509 certificates to use for authentication as documented
|
||||||
[here](/docs/tasks/tls/managing-tls-in-a-cluster).
|
in the [Managing TLS in a cluster](/docs/tasks/tls/managing-tls-in-a-cluster)
|
||||||
|
task page.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user