Skip to content

Installing Knative Eventing using YAML files

This topic describes how to install Knative Eventing by applying YAML files using the kubectl CLI.

Prerequisites

Before installation, you must meet the prerequisites. See Knative Prerequisites.

Install the Eventing component

To install the Eventing component:

  1. Install the required custom resource definitions (CRDs):

    kubectl apply -f https://storage.googleapis.com/knative-nightly/eventing/latest/eventing-crds.yaml

  2. Install the core components of Eventing:

    kubectl apply -f https://storage.googleapis.com/knative-nightly/eventing/latest/eventing-core.yaml

    Info

    For information about the YAML files in the Knative Serving and Eventing releases, see Installation files.

Verify the installation

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

kubectl get pods --namespace knative-eventing

Optional: Install a default channel (messaging) layer

The tabs below expand to show instructions for installing a default channel layer. Follow the procedure for the channel of your choice:

  1. First, Install Apache Kafka for Kubernetes

  2. Then install the Apache Kafka channel:

    curl -L "https://storage.googleapis.com/knative-sandbox-nightly/eventing-kafka/latest/channel-consolidated.yaml" \
  | sed 's/REPLACE_WITH_CLUSTER_URL/my-cluster-kafka-bootstrap.kafka:9092/' \
  | kubectl apply -f -

    Tip

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

  1. Install the Google Cloud Pub/Sub channel:

    # This installs both the Channel and the GCP Sources.
kubectl apply -f https://storage.googleapis.com/google-nightly/knative-gcp/latest/cloud-run-events.yaml

    Tip

    To learn more about the Google Cloud Pub/Sub channel, try our sample

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

kubectl apply -f https://storage.googleapis.com/knative-nightly/eventing/latest/in-memory-channel.yaml

  1. First, Install NATS Streaming for Kubernetes

  2. Then install the NATS Streaming channel:

    kubectl apply -f https://storage.googleapis.com/knative-sandbox-nightly/eventing-natss/latest/300-natss-channel.yaml

Optional: Install a broker layer:

The tabs below expand to show instructions for installing the broker layer. Follow the procedure for the broker of your choice:

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:

    kubectl apply -f https://storage.googleapis.com/knative-sandbox-nightly/eventing-kafka-broker/latest/eventing-kafka-controller.yaml

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

    kubectl apply -f https://storage.googleapis.com/knative-sandbox-nightly/eventing-kafka-broker/latest/eventing-kafka-broker.yaml

For more information, see the Kafka broker documentation.

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.

kubectl apply -f https://storage.googleapis.com/knative-nightly/eventing/latest/mt-channel-broker.yaml

To customize which broker channel implementation is used, update the following ConfigMap to specify which configurations are used for which namespaces:

apiVersion: v1
kind: ConfigMap
metadata:
  name: config-br-defaults
  namespace: knative-eventing
data:
  default-br-config: |
    # This is the cluster-wide default broker channel.
    clusterDefault:
      brokerClass: MTChannelBasedBroker
      apiVersion: v1
      kind: ConfigMap
      name: imc-channel
      namespace: knative-eventing
    # This allows you to specify different defaults per-namespace,
    # in this case the "some-namespace" namespace will use the Kafka
    # channel ConfigMap by default (only for example, you will need
    # to install kafka also to make use of this).
    namespaceDefaults:
      some-namespace:
        brokerClass: MTChannelBasedBroker
        apiVersion: v1
        kind: ConfigMap
        name: kafka-channel
        namespace: knative-eventing

The referenced imc-channel and kafka-channel example ConfigMaps would look like:

apiVersion: v1
kind: ConfigMap
metadata:
  name: imc-channel
  namespace: knative-eventing
data:
  channelTemplateSpec: |
    apiVersion: messaging.knative.dev/v1
    kind: InMemoryChannel
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: kafka-channel
  namespace: knative-eventing
data:
  channelTemplateSpec: |
    apiVersion: messaging.knative.dev/v1alpha1
    kind: KafkaChannel
    spec:
      numPartitions: 3
      replicationFactor: 1

Warning

In order to use the KafkaChannel make sure it is installed on the cluster as discussed above.

Next steps

After installing Knative Eventing: