From ae8af0c7a05a944077493b41d13c7509031e7e0d Mon Sep 17 00:00:00 2001 From: Chunyi Lyu Date: Mon, 8 Mar 2021 11:11:46 +0000 Subject: [PATCH] Add quick start to README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9060d31..beabf0ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,27 @@ # RabbitMQ Messaging Topology Kubernetes Operator -Kubernetes operator to manage [RabbitMQ](https://www.rabbitmq.com/) messaging topologies within a RabbitMQ cluster deployed via the [RabbitMQ Cluster Kubernetes Operator](https://github.com/rabbitmq/cluster-operator/). This repository contains a [custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-controllers) and [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) enabling a declarative API for RabbitMQ messaging topologies. +Kubernetes operator to manage [RabbitMQ](https://www.rabbitmq.com/) messaging topologies within a RabbitMQ cluster deployed via the [RabbitMQ Cluster Kubernetes Operator](https://github.com/rabbitmq/cluster-operator/). This repository contains [custom controllers](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-controllers) and [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) enabling a declarative API for RabbitMQ messaging topologies. + +## Quickstart + +Before deploying Messaging Topology Operator, you need to have: + +1. A Running k8s cluster +2. RabbitMQ [Cluster Operator](https://github.com/rabbitmq/cluster-operator) installed in the k8s cluster +3. A [RabbitMQ cluster](https://github.com/rabbitmq/cluster-operator/tree/main/docs/examples) deployed using the Cluster Operator + +If you have `kubectl` configured to access your running k8s cluster, you can then run the following command to install the Messaging Topology Operator: + +```bash +kubectl apply -f https://github.com/rabbitmq/messaging-topology-operator/releases/download/latest/messaging-topology-operator.yml +``` + +You can create RabbitMQ resources: + +1. [Queue](./docs/examples/queues) +2. [Exchange](.docs/examples/exchanges) +3. [Binding](.docs/examples/bindings) +4. [User](.docs/examples/users) ## Contributing