Installing Knative

This guide walks you through the installation of the latest version of Knative. Note if you are upgrading an existing installation, follow the instructions here.

Knative has two components, which can be installed and used independently or together. To help you pick and choose the pieces that are right for you, here is a brief description of each:

  • Serving stable @ v0.9 provides an abstraction for stateless request-based scale-to-zero services.
  • Eventing stable @ v0.16 provides abstractions to enable binding event sources (e.g. Github Webhooks, Kafka) and consumers (e.g. Kubernetes or Knative Services).

Knative also has an Observability plugin deprecated @ v0.14 which provides standard tooling that can be used to get visibility into the health of the software running on Knative.

Before you begin

This guide assumes that you want to install an upstream Knative release on a Kubernetes cluster. A growing number of vendors have managed Knative offerings; see the Knative Offerings page for a full list.

Knative v0.18.0 requires a Kubernetes cluster v1.16 or newer, as well as a compatible kubectl. This guide assumes that you’ve already created a Kubernetes cluster, and that you are using bash in a Mac or Linux environment; some commands will need to be adjusted for use in a Windows environment.

Installing the Serving component

FEATURE STATE: stable @ Knative v0.9

The following commands install the Knative Serving component.

  1. Install the Custom Resource Definitions (aka CRDs):

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

  2. Install the core components of Serving (see below for optional extensions):

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

  3. Pick a networking layer (alphabetical):

    FEATURE STATE: alpha @ Knative v0.8

    The following commands install Ambassador and enable its Knative integration.

    1. Create a namespace to install Ambassador in:

      1. kubectl create namespace ambassador

    2. Install Ambassador:

      1. kubectl apply --namespace ambassador \
      2.   --filename https://getambassador.io/yaml/ambassador/ambassador-crds.yaml \
      3.   --filename https://getambassador.io/yaml/ambassador/ambassador-rbac.yaml \
      4.   --filename https://getambassador.io/yaml/ambassador/ambassador-service.yaml

    3. Give Ambassador the required permissions:

      1. kubectl patch clusterrolebinding ambassador -p '{"subjects":[{"kind": "ServiceAccount", "name": "ambassador", "namespace": "ambassador"}]}'

    4. Enable Knative support in Ambassador:

      1. kubectl set env --namespace ambassador  deployments/ambassador AMBASSADOR_KNATIVE_SUPPORT=true

    5. To configure Knative Serving to use Ambassador by default:

      1. kubectl patch configmap/config-network \
      2.   --namespace knative-serving \
      3.   --type merge \
      4.   --patch '{"data":{"ingress.class":"ambassador.ingress.networking.knative.dev"}}'

    6. Fetch the External IP or CNAME:

      1. kubectl --namespace ambassador get service ambassador

      Save this for configuring DNS below.

  1. **FEATURE STATE:** `stable @ Knative v0.18`
  3. The following commands install Contour and enable its Knative integration.
  5. 1.  Install a properly configured Contour:
  7.     ```
  8.     kubectl apply --filename https://github.com/knative/net-contour/releases/download/v0.18.0/contour.yaml
  9.     ```
  11. 2.  Install the Knative Contour controller:
  13.     ```
  14.     kubectl apply --filename https://github.com/knative/net-contour/releases/download/v0.18.0/net-contour.yaml
  15.     ```
  17. 3.  To configure Knative Serving to use Contour by default:
  19.     ```
  20.     kubectl patch configmap/config-network \
  21.       --namespace knative-serving \
  22.       --type merge \
  23.       --patch '{"data":{"ingress.class":"contour.ingress.networking.knative.dev"}}'
  24.     ```
  26. 4.  Fetch the External IP or CNAME:
  28.     ```
  29.     kubectl --namespace contour-external get service envoy
  30.     ```
  32.     Save this for configuring DNS below.
  35. **FEATURE STATE:** `alpha @ Knative v0.8`
  37. *For a detailed guide on Gloo integration, see [Installing Gloo for Knative](https://docs.solo.io/gloo/latest/installation/knative/) in the Gloo documentation.*
  39. The following commands install Gloo and enable its Knative integration.
  41. 1.  Make sure `glooctl` is installed (version 1.3.x and higher recommended):
  43.     ```
  44.     glooctl version
  45.     ```
  47.     If it is not installed, you can install the latest version using:
  49.     ```
  50.     curl -sL https://run.solo.io/gloo/install | sh
  51.     export PATH=$HOME/.gloo/bin:$PATH
  52.     ```
  54.     Or following the [Gloo CLI install instructions](https://docs.solo.io/gloo/latest/installation/knative/#install-command-line-tool-cli).
  56. 2.  Install Gloo and the Knative integration:
  58.     ```
  59.     glooctl install knative --install-knative=false
  60.     ```
  62. 3.  Fetch the External IP or CNAME:
  64.     ```
  65.     glooctl proxy url --name knative-external-proxy
  66.     ```
  68.     Save this for configuring DNS below.
  71. **FEATURE STATE:** `stable @ Knative v0.9`
  73. The following commands install Istio and enable its Knative integration.
  75. 1.  [Installing Istio for Knative]($18c6b6bdac6f6d3c.md)
  77. 2.  Install the Knative Istio controller:
  79.     ```
  80.     kubectl apply --filename https://github.com/knative/net-istio/releases/download/v0.18.0/release.yaml
  81.     ```
  83. 3.  Fetch the External IP or CNAME:
  85.     ```
  86.     kubectl --namespace istio-system get service istio-ingressgateway
  87.     ```
  89.     Save this for configuring DNS below.
  92. **FEATURE STATE:** `@ Knative v0.13`
  94. The following commands install Kong and enable its Knative integration.
  96. 1.  Install Kong Ingress Controller:
  98.     ```
  99.     kubectl apply --filename https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/0.9.x/deploy/single/all-in-one-dbless.yaml
  100.     ```
  102. 2.  To configure Knative Serving to use Kong by default:
  104.     ```
  105.     kubectl patch configmap/config-network \
  106.       --namespace knative-serving \
  107.       --type merge \
  108.       --patch '{"data":{"ingress.class":"kong"}}'
  109.     ```
  111. 3.  Fetch the External IP or CNAME:
  113.     ```
  114.     kubectl --namespace kong get service kong-proxy
  115.     ```
  117.     Save this for configuring DNS below.
  120. **FEATURE STATE:** `beta @ Knative v0.17`
  122. The following commands install Kourier and enable its Knative integration.
  124. 1.  Install the Knative Kourier controller:
  126.     ```
  127.     kubectl apply --filename https://github.com/knative/net-kourier/releases/download/v0.18.0/kourier.yaml
  128.     ```
  130. 2.  To configure Knative Serving to use Kourier by default:
  132.     ```
  133.     kubectl patch configmap/config-network \
  134.       --namespace knative-serving \
  135.       --type merge \
  136.       --patch '{"data":{"ingress.class":"kourier.ingress.networking.knative.dev"}}'
  137.     ```
  139. 3.  Fetch the External IP or CNAME:
  141.     ```
  142.     kubectl --namespace kourier-system get service kourier
  143.     ```
  145.     Save this for configuring DNS below.

  1. Configure DNS

    We ship a simple Kubernetes Job called “default domain” that will (see caveats) configure Knative Serving to use xip.io as the default DNS suffix.

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/serving-default-domain.yaml

    Caveat: This will only work if the cluster LoadBalancer service exposes an IPv4 address or hostname, so it will not work with IPv6 clusters or local setups like Minikube. For these, see “Real DNS” or “Temporary DNS”.

    To configure DNS for Knative, take the External IP or CNAME from setting up networking, and configure it with your DNS provider as follows:

    • If the networking layer produced an External IP address, then configure a wildcard A record for the domain:

      1. # Here knative.example.com is the domain suffix for your cluster
      2. *.knative.example.com == A 35.233.41.212

    • If the networking layer produced a CNAME, then configure a CNAME record for the domain:

      1. # Here knative.example.com is the domain suffix for your cluster
      2. *.knative.example.com == CNAME a317a278525d111e89f272a164fd35fb-1510370581.eu-central-1.elb.amazonaws.com
  1. Once your DNS provider has been configured, direct Knative to use that domain:
  3. ```
  4. # Replace knative.example.com with your domain suffix
  5. kubectl patch configmap/config-domain \
  6.   --namespace knative-serving \
  7.   --type merge \
  8.   --patch '{"data":{"knative.example.com":""}}'
  9. ```
  11. If you are using `curl` to access the sample applications, or your own Knative app, and are unable to use the “Magic DNS (xip.io)” or “Real DNS” methods, there is a temporary approach. This is useful for those who wish to evaluate Knative without altering their DNS configuration, as per the “Real DNS” method, or cannot use the “Magic DNS” method due to using, for example, minikube locally or IPv6 clusters.
  13. To access your application using `curl` using this method:
  15. 1.  After starting your application, get the URL of your application:
  17.     ```
  18.     kubectl get ksvc
  19.     ```
  21.     The output should be similar to:
  23.     ```
  24.     NAME            URL                                        LATESTCREATED         LATESTREADY           READY   REASON
  25.     helloworld-go   http://helloworld-go.default.example.com   helloworld-go-vqjlf   helloworld-go-vqjlf   True
  26.     ```
  28. 2.  Instruct `curl` to connect to the External IP or CNAME defined by the networking layer in section 3 above, and use the `-H "Host:"` command-line option to specify the Knative application’s host name. For example, if the networking layer defines your External IP and port to be `http://192.168.39.228:32198` and you wish to access the above `helloworld-go` application, use:
  30.     ```
  31.     curl -H "Host: helloworld-go.default.example.com" http://192.168.39.228:32198
  32.     ```
  34.     In the case of the provided `helloworld-go` sample application, the output should, using the default configuration, be:
  36.     ```
  37.     Hello Go Sample v1!
  38.     ```
  41. Refer to the “Real DNS” method for a permanent solution.

  1. Monitor the Knative components until all of the components show a STATUS of Running or Completed:

    1. kubectl get pods --namespace knative-serving

At this point, you have a basic installation of Knative Serving!

Optional Serving extensions

FEATURE STATE: beta @ Knative v0.8

Knative also supports the use of the Kubernetes Horizontal Pod Autoscaler (HPA) for driving autoscaling decisions. The following command will install the components needed to support HPA-class autoscaling:

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

FEATURE STATE: alpha @ Knative v0.6

Knative supports automatically provisioning TLS certificates via cert-manager. The following commands will install the components needed to support the provisioning of TLS certificates via cert-manager.

  1. First, install cert-manager version 0.12.0 or higher

  2. Next, install the component that integrates Knative with cert-manager:

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

  3. Now configure Knative to automatically configure TLS certificates.

FEATURE STATE: alpha @ Knative v0.14

Knative supports automatically provisioning TLS certificates using Let’s Encrypt HTTP01 challenges. The following commands will install the components needed to support that.

  1. First, install the net-http01 controller:

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

  2. Next, configure the certificate.class to use this certificate type.

    1. kubectl patch configmap/config-network \
    2.   --namespace knative-serving \
    3.   --type merge \
    4.   --patch '{"data":{"certificate.class":"net-http01.certificate.networking.knative.dev"}}'

  3. Lastly, enable auto-TLS.

    1. kubectl patch configmap/config-network \
    2.   --namespace knative-serving \
    3.   --type merge \
    4.   --patch '{"data":{"autoTLS":"Enabled"}}'

FEATURE STATE: alpha @ Knative v0.12

If you are using a Certificate implementation that supports provisioning wildcard certificates (e.g. cert-manager with a DNS01 issuer), then the most efficient way to provision certificates is with the namespace wildcard certificate controller. The following command will install the components needed to provision wildcard certificates in each namespace:

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

Note this will not work with HTTP01 either via cert-manager or the net-http01 options.

Getting started with Serving

Deploy your first app with the getting started with Knative app deployment guide. You can also find a number of samples for Knative Serving here.

Installing the Eventing component

FEATURE STATE: stable @ Knative v0.16

The following commands install the Knative Eventing component.

  1. Install the Custom Resource Definitions (aka CRDs):

    1. kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.18.0/eventing-crds.yaml

  2. Install the core components of Eventing (see below for optional extensions):

    1. kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.18.0/eventing-core.yaml

    Note: If your Kubernetes cluster comes with pre-installed Istio, make sure it has cluster-local-gateway deployed. Depending on which Istio version you have, you’d need to apply the istio-knative-extras.yaml in the corresponding version folder at here.

  3. Install a default Channel (messaging) layer (alphabetical).

    1. First, Install Apache Kafka for Kubernetes

    2. Then install the Apache Kafka Channel:

      1. curl -L "https://github.com/knative/eventing-contrib/releases/download/v0.18.0/kafka-channel.yaml" \
      2.  | sed 's/REPLACE_WITH_CLUSTER_URL/my-cluster-kafka-bootstrap.kafka:9092/' \
      3.  | kubectl apply --filename -
  1. To learn more about the Apache Kafka channel, try [our sample](https://knative.dev/docs/eventing/samples/kafka/channel/index.html)
  3. 1.  Install the Google Cloud Pub/Sub Channel:
  5.     ```
  6.     # This installs both the Channel and the GCP Sources.
  7.     kubectl apply --filename https://github.com/google/knative-gcp/releases/download/v0.18.0/cloud-run-events.yaml
  8.     ```
  11. To learn more about the Google Cloud Pub/Sub Channel, try [our sample](https://github.com/google/knative-gcp/blob/master/docs/examples/channel/README.md)
  13. **FEATURE STATE:** `stable @ Knative v0.16`
  15. The following command installs an implementation of Channel that runs in-memory. This implementation is nice because it is simple and standalone, but it is unsuitable for production use cases.
  17. ```
  18. kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.18.0/in-memory-channel.yaml
  19. ```
  21. 1.  First, [Install NATS Streaming for Kubernetes](https://github.com/knative/eventing-contrib/blob/v0.18.0/natss/config/broker/README.md)
  23. 2.  Then install the NATS Streaming Channel:
  25.     ```
  26.     kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/natss-channel.yaml
  27.     ```

  1. Install a Broker (eventing) layer:

    FEATURE STATE: alpha @ Knative v0.17

    The following commands install the Apache Kafka broker, and run event routing in a system namespace, knative-eventing, by default.

    1. Install the Kafka controller by entering the following command:

      1. kubectl apply --filename https://github.com/knative-sandbox/eventing-kafka-broker/releases/download/v0.18.0/eventing-kafka-controller.yaml

    2. Install the Kafka Broker data plane by entering the following command:

      1. kubectl apply --filename https://github.com/knative-sandbox/eventing-kafka-broker/releases/download/v0.18.0/eventing-kafka-broker.yaml
  1. For more information, see the [Kafka Broker]($50e878a06890715a.md) documentation.
  3. **FEATURE STATE:** `stable @ Knative v0.16`
  5. The following command installs an implementation of Broker that utilizes Channels and runs event routing components in a System Namespace, providing a smaller and simpler installation.
  7. ```
  8. kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.18.0/mt-channel-broker.yaml
  9. ```
  11. To customize which broker channel implementation is used, update the following ConfigMap to specify which configurations are used for which namespaces:
  13. ```
  14. apiVersion: v1
  15. kind: ConfigMap
  16. metadata:
  17.   name: config-br-defaults
  18.   namespace: knative-eventing
  19. data:
  20.   default-br-config: |
  21.     # This is the cluster-wide default broker channel.
  22.     clusterDefault:
  23.       brokerClass: MTChannelBasedBroker
  24.       apiVersion: v1
  25.       kind: ConfigMap
  26.       name: imc-channel
  27.       namespace: knative-eventing
  28.     # This allows you to specify different defaults per-namespace,
  29.     # in this case the "some-namespace" namespace will use the Kafka
  30.     # channel ConfigMap by default (only for example, you will need
  31.     # to install kafka also to make use of this).
  32.     namespaceDefaults:
  33.       some-namespace:
  34.         brokerClass: MTChannelBasedBroker
  35.         apiVersion: v1
  36.         kind: ConfigMap
  37.         name: kafka-channel
  38.         namespace: knative-eventing
  39. ```
  41. The referenced `imc-channel` and `kafka-channel` example ConfigMaps would look like:
  43. ```
  44. apiVersion: v1
  45. kind: ConfigMap
  46. metadata:
  47.   name: imc-channel
  48.   namespace: knative-eventing
  49. data:
  50.   channelTemplateSpec: |
  51.     apiVersion: messaging.knative.dev/v1
  52.     kind: InMemoryChannel
  53. ---
  54. apiVersion: v1
  55. kind: ConfigMap
  56. metadata:
  57.   name: kafka-channel
  58.   namespace: knative-eventing
  59. data:
  60.   channelTemplateSpec: |
  61.     apiVersion: messaging.knative.dev/v1alpha1
  62.     kind: KafkaChannel
  63.     spec:
  64.       numPartitions: 3
  65.       replicationFactor: 1
  66. ```
  68. *In order to use the KafkaChannel make sure it is installed on the cluster as discussed above.*

  1. Monitor the Knative components until all of the components show a STATUS of Running:

    1. kubectl get pods --namespace knative-eventing

At this point, you have a basic installation of Knative Eventing!

Optional Eventing extensions

FEATURE STATE: alpha @ Knative v0.16

The following command installs the Eventing Sugar Controller:

  1. kubectl apply --filename https://github.com/knative/eventing/releases/download/v0.18.0/eventing-sugar-controller.yaml

The Knative Eventing Sugar Controller will react to special labels and annotations and produce Eventing resources. For example:

  • When a Namespace is labeled with eventing.knative.dev/injection=enabled, the controller will create a default broker in that namespace.
  • When a Trigger is annotated with eventing.knative.dev/injection=enabled, the controller will create a Broker named by that Trigger in the Trigger’s Namespace.

The following command enables the default Broker on a namespace (here default):

  1. kubectl label namespace default eventing.knative.dev/injection=enabled

FEATURE STATE: alpha @ Knative v0.2

The following command installs the single-tenant Github source:

  1. kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/github.yaml

The single-tenant GitHub source creates one Knative service per GitHub source.

The following command installs the multi-tenant GitHub source:

  1. kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/mt-github.yaml

The multi-tenant GitHub source creates only one Knative service handling all GitHub sources in the cluster. This source does not support logging or tracing configuration yet.

To learn more about the Github source, try our sample

FEATURE STATE: alpha @ Knative v0.5

The following command installs the Apache Camel-K Source:

  1. kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/camel.yaml

To learn more about the Apache Camel-K source, try our sample

FEATURE STATE: alpha @ Knative v0.5

The following command installs the Apache Kafka Source:

  1. kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/kafka-source.yaml

To learn more about the Apache Kafka source, try our sample

FEATURE STATE: alpha @ Knative v0.2

The following command installs the GCP Sources:

  1. # This installs both the Sources and the Channel.
  2. kubectl apply --filename https://github.com/google/knative-gcp/releases/download/v0.18.0/cloud-run-events.yaml

To learn more about the Cloud Pub/Sub source, try our sample.

To learn more about the Cloud Storage source, try our sample.

To learn more about the Cloud Scheduler source, try our sample.

To learn more about the Cloud Audit Logs source, try our sample.

FEATURE STATE: alpha @ Knative v0.10

The following command installs the Apache CouchDB Source:

  1. kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.18.0/couchdb.yaml

To learn more about the Apache CouchDB source, read [our documentation]((https://github.com/knative/eventing-contrib/blob/v0.18.0/couchdb/README.md)

FEATURE STATE: alpha @ Knative v0.14

The following command installs the VMware Sources and Bindings:

  1. kubectl apply --filename https://github.com/vmware-tanzu/sources-for-knative/releases/download/v0.18.0/release.yaml

To learn more about the VMware sources and bindings, try our samples.

Getting started with Eventing

You can find a number of samples for Knative Eventing here. A quick-start guide is available here.

Installing the Observability plugin

FEATURE STATE: deprecated @ Knative v0.14

Install the following observability features to enable logging, metrics, and request tracing in your Serving and Eventing components.

All observibility plugins require that you first install the core:

  1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-core.yaml

After the core is installed, you can choose to install one or all of the following observability plugins:

  • Install Prometheus and Grafana for metrics:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-metrics-prometheus.yaml

  • Install the ELK stack (Elasticsearch, Logstash and Kibana) for logs:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-logs-elasticsearch.yaml

  • Install Jaeger for distributed tracing

    To install the in-memory (standalone) version of Jaeger, run the following command:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-tracing-jaeger-in-mem.yaml

    To install the ELK version of Jaeger (needs the ELK install above), run the following command:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-tracing-jaeger.yaml

  • Install Zipkin for distributed tracing

    To install the in-memory (standalone) version of Zipkin, run the following command:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-tracing-zipkin-in-mem.yaml

    To install the ELK version of Zipkin (needs the ELK install above), run the following command:

    1. kubectl apply --filename https://github.com/knative/serving/releases/download/v0.18.0/monitoring-tracing-zipkin.yaml