Installing Knative Eventing using YAML files

    Before installing Knative, you must meet the following prerequisites:

    • For prototyping purposes, Knative works on most local deployments of Kubernetes. For example, you can use a local, one-node cluster that has 2 CPUs and 4 GB of memory.

      Tip

      You can install a local distribution of Knative for development purposes using the Knative Quickstart plugin

    • For production purposes, it is recommended that:

      • If you have only one node in your cluster, you need at least 6 CPUs, 6 GB of memory, and 30 GB of disk storage.
      • If you have multiple nodes in your cluster, for each node you need at least 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
      • You have a cluster that uses Kubernetes v1.21 or newer.
      • You have installed the .
      • Your Kubernetes cluster must have access to the internet, because Kubernetes needs to be able to fetch images. To pull from a private registry, see Deploying images from a private container registry.

    Caution

    The system requirements provided are recommendations only. The requirements for your installation might vary, depending on whether you use optional components, such as a networking layer.

    Install Knative Eventing

    To install Knative Eventing:

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

    2. Install the core components of Eventing by running the command:

      1. kubectl apply -f https://github.com/knative/eventing/releases/download/knative-v1.2.0/eventing-core.yaml

      Info

      For information about the YAML files in Knative Eventing, see Description Tables for YAML Files.

    Success

    Monitor the Knative components until all of the components show a STATUS of Running or Completed. You can do this by running the following command and inspecting the output:

    1. kubectl get pods -n knative-eventing

    Example output:

    1. NAME                                   READY   STATUS    RESTARTS   AGE
    2. eventing-controller-7995d654c7-qg895   1/1     Running   0          2m18s
    3. eventing-webhook-fff97b47c-8hmt8       1/1     Running   0          2m17s

    Optional: Install a default Channel (messaging) layer

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

    Apache Kafka ChannelGoogle Cloud Pub/Sub ChannelIn-Memory (standalone)NATS Channel

    1. Install Strimzi.
    2. Install the Apache Kafka Channel for Knative from the .

    • Install the Google Cloud Pub/Sub Channel by running the command:

      1. kubectl apply -f https://github.com/google/knative-gcp/releases/download/knative-v1.2.0/cloud-run-events.yaml

      This command installs both the Channel and the GCP Sources.

      Tip

    Warning

    This simple standalone implementation runs in-memory and is not suitable for production use cases.

    • Install an in-memory implementation of Channel by running the command:

      1. kubectl apply -f https://github.com/knative/eventing/releases/download/knative-v1.2.0/in-memory-channel.yaml

    1. Install NATS Streaming for Kubernetes.

    2. Install the NATS Streaming Channel by running the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-natss/releases/download/knative-v1.2.0/eventing-natss.yaml

    You can change the default channel implementation by following the instructions described in the section.

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

    Apache Kafka BrokerMT-Channel-basedRabbitMQ Broker

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

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

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

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-kafka-broker/releases/download/knative-v1.2.0/eventing-kafka-broker.yaml

    For more information, see the Kafka Broker documentation.

    This implementation of Broker uses Channels and runs event routing components in a system namespace, providing a smaller and simpler installation.

    • Install this implementation of Broker by running the command:

      1. kubectl apply -f https://github.com/knative/eventing/releases/download/knative-v1.2.0/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:

      1. kind: ConfigMap
      2. metadata:
      3.   name: config-br-defaults
      4.   namespace: knative-eventing
      5. data:
      6.   default-br-config: |
      7.     # This is the cluster-wide default broker channel.
      8.     clusterDefault:
      9.       brokerClass: MTChannelBasedBroker
      11.       kind: ConfigMap
      12.       name: imc-channel
      13.       namespace: knative-eventing
      14.     # This allows you to specify different defaults per-namespace,
      15.     # in this case the "some-namespace" namespace will use the Kafka
      16.     # channel ConfigMap by default (only for example, you will need
      17.     # to install kafka also to make use of this).
      18.     namespaceDefaults:
      19.       some-namespace:
      20.         brokerClass: MTChannelBasedBroker
      21.         apiVersion: v1
      22.         kind: ConfigMap
      23.         name: kafka-channel
      24.         namespace: knative-eventing

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

      1. apiVersion: v1
      2. kind: ConfigMap
      3. metadata:
      4.   name: imc-channel
      5.   namespace: knative-eventing
      6. data:
      7.   channel-template-spec: |
      8.     apiVersion: messaging.knative.dev/v1
      10. ---
      11. kind: ConfigMap
      12. metadata:
      13.   name: kafka-channel
      14.   namespace: knative-eventing
      15. data:
      16.   channel-template-spec: |
      17.     apiVersion: messaging.knative.dev/v1alpha1
      18.     kind: KafkaChannel
      19.     spec:
      20.       numPartitions: 3
      21.       replicationFactor: 1

    Warning

    In order to use the KafkaChannel, ensure that it is installed on your cluster, as mentioned previously in this topic.

    • Install the RabbitMQ Broker by following the instructions in the .

    For more information, see the RabbitMQ Broker in GitHub.

    Install optional Eventing extensions

    The following tabs expand to show instructions for installing each Eventing extension.

    1. Install the Kafka controller by running the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-kafka-broker/releases/download/knative-v1.2.0/eventing-kafka-controller.yaml

    2. Install the Kafka Sink data plane by running the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-kafka-broker/releases/download/knative-v1.2.0/eventing-kafka-sink.yaml

    For more information, see the Kafka Sink documentation.

    1. Install the Eventing Sugar Controller by running the command:

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

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

    2. Enable the default Broker on a namespace (here default) by running the command:

      1. kubectl label namespace <namespace-name> eventing.knative.dev/injection=enabled

      Where <namespace-name> is the name of the namespace.

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

    A multi-tenant GitHub source only creates one Knative Service, which handles all GitHub sources in the cluster. This source does not support logging or tracing configuration.

    • To install a single-tenant GitHub source run the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-github/releases/download/knative-v1.2.0/github.yaml

    • To install a multi-tenant GitHub source run the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-github/releases/download/knative-v1.2.0/mt-github.yaml

    To learn more, try the

    • Install the Apache Kafka Source by running the command:

      1. kubectl apply -f https://github.com/knative-sandbox/eventing-kafka/releases/download/knative-v1.2.0/source.yaml

    To learn more, try the Apache Kafka source sample.

    • Install the GCP Sources by running the command:

      1. kubectl apply -f https://github.com/google/knative-gcp/releases/download/knative-v1.2.0/cloud-run-events.yaml

      This command installs both the Sources and the Channel.

    To learn more, try the following samples:

    To learn more, read the documentation.

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