Enabling automatic TLS certificate provisioning

If you install and configure cert-manager, you can configure Knative to automatically obtain new TLS certificates and renew existing ones for Knative Services. To learn more about using secure connections in Knative, see Configuring HTTPS with TLS certificates.

Automatic TLS provision mode

Knative supports the following Auto TLS modes:

  1. Using DNS-01 challenge

    In this mode, your cluster needs to be able to talk to your DNS server to verify the ownership of your domain.

    • Provision Certificate per namespace is supported when using DNS-01 challenge mode.

      • This is the recommended mode for faster certificate provision.
      • In this mode, a single Certificate will be provisioned per namespace and is reused across the Knative Services within the same namespace.

    • Provision Certificate per Knative Service is supported when using DNS-01 challenge mode.

      • This is the recommended mode for better certificate islation between Knative Services.
      • In this mode, a Certificate will be provisioned for each Knative Service.
      • The TLS effective time is longer as it needs Certificate provision for each Knative Service creation.

  2. Using HTTP-01 challenge

    • In this type, your cluster does not need to be able to talk to your DNS server. You must map your domain to the IP of the cluser ingress.
    • When using HTTP-01 challenge, a certificate will be provisioned per Knative Service.
    • HTTP-01 does not support provisioning a certificate per namespace.

Before you begin

You must meet the following prerequisites to enable Auto TLS:

  • The following must be installed on your Knative cluster:
  • cert-manager version 1.0.0 and higher.
  • Your Knative cluster must be configured to use a custom domain.
  • Your DNS provider must be setup and configured to your domain.
  • If you want to use HTTP-01 challenge, you need to configure your custom domain to map to the IP of ingress. You can achieve this by adding a DNS A record to map the domain to the IP according to the instructions of your DNS provider.

Enabling Auto TLS

To enable support for Auto TLS in Knative:

Create cert-manager ClusterIssuer

  1. Create and add the ClusterIssuer configuration file to your Knative cluster to define who issues the TLS certificates, how requests are validated, and which DNS provider validates those requests.

    ClusterIssuer for DNS-01 challenge

    Use the cert-manager reference to determine how to configure your ClusterIssuer file:

    • See the generic ClusterIssuer example

    • Also see the DNS01 example

      Example: Cloud DNS ClusterIssuer configuration file:

      The following letsencrypt-issuer named ClusterIssuer file is configured for the Let’s Encrypt CA and Google Cloud DNS. Under spec, the Let’s Encrypt account info, required DNS-01 challenge type, and Cloud DNS provider info defined. For the complete Google Cloud DNS example, see Configuring HTTPS with cert-manager and Google Cloud DNS.

      1. apiVersion: cert-manager.io/v1alpha2
      2. kind: ClusterIssuer
      3. metadata:
      4.   name: letsencrypt-dns-issuer
      5. spec:
      6.   acme:
      7.     server: https://acme-v02.api.letsencrypt.org/directory
      8.     # This will register an issuer with LetsEncrypt.  Replace
      9.     # with your admin email address.
      10.     email: myemail@gmail.com
      11.     privateKeySecretRef:
      12.       # Set privateKeySecretRef to any unused secret name.
      13.       name: letsencrypt-dns-issuer
      14.     solvers:
      15.     - dns01:
      16.         clouddns:
      17.           # Set this to your GCP project-id
      18.           project: $PROJECT_ID
      19.           # Set this to the secret that we publish our service account key
      20.           # in the previous step.
      21.           serviceAccountSecretRef:
      22.             name: cloud-dns-key
      23.             key: key.json

    ClusterIssuer for HTTP-01 challenge

    Run the following command to apply the ClusterIssuer for HTT01 challenge:

    1. kubectl apply -f - <<EOF
    2. apiVersion: cert-manager.io/v1alpha2
    3. kind: ClusterIssuer
    4. metadata:
    5.   name: letsencrypt-http01-issuer
    6. spec:
    7.   acme:
    8.     privateKeySecretRef:
    9.       name: letsencrypt
    10.     server: https://acme-v02.api.letsencrypt.org/directory
    11.     solvers:
    12.     - http01:
    13.        ingress:
    14.          class: istio
    15. EOF

  2. Ensure that the ClusterIssuer is created successfully:

    1. kubectl get clusterissuer <cluster-issuer-name> --output yaml

    Result: The Status.Conditions should include Ready=True.

DNS-01 challenge only: Configure your DNS provider

If you choose to use DNS-01 challenge, configure which DNS provider is used to validate the DNS-01 challenge requests.

Instructions about configuring cert-manager, for all the supported DNS providers, are provided in DNS01 challenge providers and configuration instructions.

Example:

See how the Google Cloud DNS is defined as the provider: Configuring HTTPS with cert-manager and Google Cloud DNS

Install networking-certmanager deployment

  1. Determine if networking-certmanager is already installed by running the following command:

    1. kubectl get deployment networking-certmanager -n knative-serving

  2. If networking-certmanager is not found, run the following command:

    1. kubectl apply --filename https://github.com/knative/net-certmanager/releases/download/v0.22.0/release.yaml

Install networking-ns-cert component

If you choose to use the mode of provisioning certificate per namespace, you need to install networking-ns-cert components.

IMPORTANT: Provisioning a certificate per namespace only works with DNS-01 challenge. This component cannot be used with HTTP-01 challenge.

  1. Determine if networking-ns-cert deployment is already installed by running the following command:

    1. kubectl get deployment networking-ns-cert -n knative-serving

  2. If networking-ns-cert deployment is not found, run the following command:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.22.0/serving-nscert.yaml

Configure config-certmanager ConfigMap

Update your config-certmanager ConfigMap in the knative-serving namespace to reference your new ClusterIssuer.

  1. Run the following command to edit your config-certmanager ConfigMap:

    1. kubectl edit configmap config-certmanager --namespace knative-serving

  2. Add the issuerRef within the data section:

    1. ...
    2. data:
    3. ...
    4.   issuerRef: |
    5.     kind: ClusterIssuer
    6.     name: letsencrypt-issuer

    Example:

    1. apiVersion: v1
    2. kind: ConfigMap
    3. metadata:
    4.   name: config-certmanager
    5.   namespace: knative-serving
    6.   labels:
    7.     networking.knative.dev/certificate-provider: cert-manager
    8. data:
    9.   issuerRef: |
    10.     kind: ClusterIssuer
    11.     name: letsencrypt-http01-issuer

    issueRef defines which ClusterIssuer will be used by Knative to issue certificates.

  3. Ensure that the file was updated successfully:

    1. kubectl get configmap config-certmanager --namespace knative-serving --output yaml

Turn on Auto TLS

Update the config-network ConfigMap in the knative-serving namespace to enable autoTLSand specify how HTTP requests are handled:

  1. Run the following command to edit your config-network ConfigMap:

    1. kubectl edit configmap config-network --namespace knative-serving

  2. Add the autoTLS: Enabled attribute under the data section:

    1. ...
    2. data:
    3. ...
    4.   autoTLS: Enabled
    5. ...

    Example:

    1. apiVersion: v1
    2. kind: ConfigMap
    3. metadata:
    4.   name: config-network
    5.   namespace: knative-serving
    6. data:
    7.    ...
    8.    autoTLS: Enabled
    9.    ...

  3. Configure how HTTP and HTTPS requests are handled in the httpProtocol attribute.

    By default, Knative ingress is configured to serve HTTP traffic (httpProtocol: Enabled). Now that your cluster is configured to use TLS certificates and handle HTTPS traffic, you can specify whether or not any HTTP traffic is allowed.

    Supported httpProtocol values:

    • Enabled: Serve HTTP traffic.
    • Disabled: Rejects all HTTP traffic.
    • Redirected: Responds to HTTP request with a 302 redirect to ask the clients to use HTTPS.
    1. ...
    2. data:
    3. ...
    4.   autoTLS: Enabled
    5. ...

    Example:

    1. apiVersion: v1
    2. kind: ConfigMap
    3. metadata:
    4.   name: config-network
    5.   namespace: knative-serving
    6. data:
    7.   ...
    8.   autoTLS: Enabled
    9.   ...
    10.   httpProtocol: Redirected
    11.   ...

    Note: When using HTTP-01 challenge, httpProtocol field has to be set to Enabled to make sure HTTP-01 challenge requests can be accepted by the cluster.

  4. Ensure that the file was updated successfully:

    1. kubectl get configmap config-network --namespace knative-serving --output yaml

Congratulations! Knative is now configured to obtain and renew TLS certificates. When your TLS certificate is active on your cluster, your Knative services will be able to handle HTTPS traffic.

Verify Auto TLS

  1. Run the following comand to create a Knative Service:

    1. kubectl apply -f https://raw.githubusercontent.com/knative/docs/main/docs/serving/autoscaling/autoscale-go/service.yaml

  2. When the certificate is provisioned (which could take up to several minutes depending on the challenge type), you should see something like:

    1. NAME               URL                                           LATESTCREATED            LATESTREADY              READY   REASON
    2. autoscale-go       https://autoscale-go.default.{custom-domain}   autoscale-go-6jf85 autoscale-go-6jf85       True

    Note that the URL will be https in this case.

Disable Auto TLS per service or route

If you have Auto TLS enabled in your cluster, you can choose to disable Auto TLS for individual services or routes by adding the annotation networking.knative.dev/disableAutoTLS: true.

Using the previous autoscale-go example:

  1. Edit the service using kubectl edit service.serving.knative.dev/autoscale-go -n default and add the annotation:
  1.  apiVersion: serving.knative.dev/v1
  2.  kind: Service
  3.  metadata:
  4.    annotations:
  5.     ...
  6.      networking.knative.dev/disableAutoTLS: "true"
  7.     ...
  1. The service URL should now be http, indicating that AutoTLS is disabled:
  1. NAME           URL                                          LATEST               AGE     CONDITIONS   READY   REASON
  2. autoscale-go   http://autoscale-go.default.1.arenault.dev   autoscale-go-dd42t   8m17s   3 OK / 3     True