Clarify pre-req versions for eventing-rabbitmq (#4518)

We had a query about which versions should be installed:
https://jira.eng.vmware.com/browse/PDY-649

Our aim is to support the latest released versions of the RabbitMQ
Cluster Operator & Messaging Topology Operator. I am highlighting the
Cert Manager option as that is the easiest way to get started, and is
also what we do in our acceptance testing.

Since this is a Getting Started, I have removed the deadLetterSink
option since it's optional. I don't think that optional properties have
a place in a Getting Started.

Signed-off-by: Gerhard Lazu <glazu@vmware.com>
This commit is contained in:
Gerhard Lazu 2021-12-01 13:29:56 +00:00 committed by GitHub
parent 89916798fe
commit 39298e4551
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 26 deletions

View File

@ -7,8 +7,9 @@ This topic describes how to create a RabbitMQ Broker.
To use the RabbitMQ Broker, you must have the following installed:
1. [Knative Eventing](../../../install/eventing/install-eventing-with-yaml.md)
1. [RabbitMQ Cluster Operator](https://github.com/rabbitmq/cluster-operator)
1. [RabbitMQ Messaging Topology Operator](https://github.com/rabbitmq/messaging-topology-operator)
1. [RabbitMQ Cluster Operator](https://github.com/rabbitmq/cluster-operator) - our recommendation is [latest release](https://github.com/rabbitmq/cluster-operator/releases/latest)
1. [CertManager v1.5.4](https://github.com/jetstack/cert-manager/releases/tag/v1.5.4) - easiest integration with RabbitMQ Messaging Topology Operator
1. [RabbitMQ Messaging Topology Operator](https://github.com/rabbitmq/messaging-topology-operator) - our recommendation is [latest release](https://github.com/rabbitmq/messaging-topology-operator/releases/latest) with CertManager
## Install the RabbitMQ controller
@ -40,14 +41,14 @@ To use the RabbitMQ Broker, you must have the following installed:
1. Create a YAML file using the following template:
```bash
```yaml
apiVersion: rabbitmq.com/v1beta1
kind: RabbitmqCluster
metadata:
name: <cluster-name>
```
Where `<cluster-name>` is the name you want for your RabbitMQ cluster,
for example, `hello-world`.
for example, `rabbitmq`.
1. Apply the YAML file by running the command:
@ -68,10 +69,10 @@ will be `true` in the output of the following command:
```{ .bash .no-copy }
NAME ALLREPLICASREADY RECONCILESUCCESS AGE
hello-world True True 38s
rabbitmq True True 38s
```
For more information about configuring the RabbitmqCluster CRD, see the
For more information about configuring the `RabbitmqCluster` CRD, see the
[RabbitMQ website](https://www.rabbitmq.com/kubernetes/operator/using-operator.html).
## Create a RabbitMQ Broker object
@ -90,33 +91,14 @@ For more information about configuring the RabbitmqCluster CRD, see the
apiVersion: rabbitmq.com/v1beta1
kind: RabbitmqCluster
name: <cluster-name>
# Optional
delivery:
deadLetterSink:
ref:
apiVersion: serving.knative.dev/v1
kind: Service
name: <deadlettersink-name>
uri: <deadlettersink-uri>
```
Where:
- `<cluster-name>` is the name you gave your RabbitMQ cluster.
- `<deadlettersink-name>` is the name of the Service you want to use for
dead-lettered messages, for example, `dlq-service`.
- `<deadlettersink-uri>` is the URI you want to use for dead-lettered messages,
for example, `https://my.dlq.example.com`.
!!! note
Specifying a `delivery.deadLetterSink` is optional. You can specify it either
as an object reference using the `ref` field, or URI using the `uri` field.
Where `<cluster-name>` is the name you gave your RabbitMQ cluster in the step above.
1. Apply the YAML file by running the command:
```bash
kubectl apply -f <filename>
```
Where `<filename>` is the name of the file you created in the previous step.
## Additional information