update install instructions remove channel based broker (#2635)

This commit is contained in:
Ville Aikas 2020-07-02 02:34:41 -07:00 committed by GitHub
parent 0c9a7a36de
commit d7f0aeb232
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 80 deletions

View File

@ -27,7 +27,7 @@ Knative has two components, which can be installed and used independently or tog
To help you pick and choose the pieces that are right for you, here is a brief
description of each:
- [**Serving**](#installing-the-serving-component) {{< feature-state version="v0.9" state="stable" short=true >}} provides an abstraction for stateless request-based scale-to-zero services.
- [**Eventing**](#installing-the-eventing-component) {{< feature-state version="v0.2" state="alpha" short=true >}} provides abstractions to enable binding event sources (e.g. Github Webhooks, Kafka) and consumers (e.g. Kubernetes or Knative Services).
- [**Eventing**](#installing-the-eventing-component) {{< feature-state version="v0.16" state="stable" short=true >}} 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**](#installing-the-observability-plugin) {{< feature-state version="v0.14" state="deprecated" short=true >}} which provides standard tooling that can be used to get visibility into the health of the software running on Knative.
@ -464,7 +464,7 @@ Deploy your first app with the [getting started with Knative app deployment](../
## Installing the Eventing component
{{< feature-state version="v0.13" state="beta" >}}
{{< feature-state version="v0.16" state="stable" >}}
The following commands install the Knative Eventing component.
@ -472,14 +472,13 @@ The following commands install the Knative Eventing component.
1. Install the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (aka CRDs):
```bash
kubectl apply --selector knative.dev/crd-install=true \
--filename {{< artifact repo="eventing" file="eventing.yaml" >}}
kubectl apply --filename {{< artifact repo="serving" file="eventing-crds.yaml" >}}
```
1. Install the core components of Eventing (see below for optional extensions):
```bash
kubectl apply --filename {{< artifact repo="eventing" file="eventing.yaml" >}}
kubectl apply --filename {{< artifact repo="eventing" file="eventing-core.yaml" >}}
```
1. Install a default Channel (messaging) layer (alphabetical).
@ -517,7 +516,7 @@ To learn more about the Google Cloud Pub/Sub Channel, try [our sample](https://g
{{% tab name="In-Memory (standalone)" %}}
{{< feature-state version="v0.13" state="beta" >}}
{{< feature-state version="v0.16" state="stable" >}}
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.
@ -546,83 +545,13 @@ The following command installs an implementation of Channel that runs in-memory.
1. Install a Broker (eventing) layer:
<!-- This indentation is important for things to render properly. -->
{{< tabs name="eventing_brokers" default="Channel-based" >}}
{{% tab name="Channel-based" %}}
{{< feature-state version="v0.13" state="beta" >}}
The following command installs an implementation of Broker that utilizes Channels:
```bash
kubectl apply --filename {{< artifact repo="eventing" file="channel-broker.yaml" >}}
```
To customize which broker channel implementation is used, update the following
ConfigMap to specify which configurations are used for which namespaces:
```yaml
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: ChannelBasedBroker
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: ChannelBasedBroker
apiVersion: v1
kind: ConfigMap
name: kafka-channel
namespace: knative-eventing
```
The referenced `imc-channel` and `kafka-channel` example ConfigMaps would look like:
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: imc-channel
namespace: knative-eventing
data:
channelTemplateSpec: |
apiVersion: messaging.knative.dev/v1beta1
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
```
_In order to use the KafkaChannel make sure it is installed on the cluster as discussed above._
{{< /tab >}}
{{< tabs name="eventing_brokers" default="MT-Channel-based" >}}
{{% tab name="MT-Channel-based" %}}
{{< feature-state version="v0.14" state="alpha" >}}
{{< feature-state version="v0.16" state="stable" >}}
The following command installs an implementation of Broker that utilizes Channels
just like the Channel Based one, but this broker runs event routing components
in a System Namespace, providing a smaller and simpler installation.
and runs event routing components in a System Namespace, providing a smaller and
simpler installation.
```bash
kubectl apply --filename {{< artifact repo="eventing" file="mt-channel-broker.yaml" >}}