diff --git a/docs/examples/rabbitmq/quickstart/quickstart.yaml b/docs/examples/rabbitmq/quickstart/quickstart.yaml new file mode 100644 index 0000000000..9d8e18a3aa --- /dev/null +++ b/docs/examples/rabbitmq/quickstart/quickstart.yaml @@ -0,0 +1,32 @@ +apiVersion: kubedb.com/v1alpha2 +kind: RabbitMQ +metadata: + name: rm-quickstart + namespace: demo +spec: + version: "3.12.12" + replicas: 3 + storage: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 1Gi + storageClassName: standard + storageType: Durable + terminationPolicy: WipeOut # DoNotTerminate(blocks deletion), Halt( retains pvc,secret), Delete (retains secret) + podTemplate: + spec: + containers: + - name: rabbitmq + resources: + requests: + cpu: "0.5" + memory: "1Gi" + limits: + cpu: "2" + memory: "2Gi" + serviceTemplates: + - alias: primary + spec: + type: LoadBalancer \ No newline at end of file diff --git a/docs/guides/README.md b/docs/guides/README.md index 98fae3284b..f9b9116441 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -18,7 +18,6 @@ aliases: Guides to show you how to perform tasks with KubeDB: - [Druid](/docs/guides/kafka/README.md). Shows how to manage Druid using KubeDB. - [Elasticsearch](/docs/guides/elasticsearch/README.md). Shows how to manage Elasticsearch & OpenSearch using KubeDB. -- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB. - [MariaDB](/docs/guides/mariadb). Shows how to manage MariaDB using KubeDB. - [Memcached](/docs/guides/memcached/README.md). Shows how to manage Memcached using KubeDB. - [Microsoft SQL Server](/docs/guides/mssqlserver/README.md). Shows how to manage Microsoft SQL Server using KubeDB. @@ -30,6 +29,9 @@ Guides to show you how to perform tasks with KubeDB: - [PostgreSQL](/docs/guides/postgres/README.md). Shows how to manage PostgreSQL using KubeDB. - [ProxySQL](/docs/guides/proxysql/README.md). Shows how to manage ProxySQL using KubeDB. - [Redis](/docs/guides/redis/README.md). Shows how to manage Redis using KubeDB. +- [RabbitMQ](/docs/guides/rabbitmq/README.md). Shows how to manage RabbitMQ using KubeDB. +- [Kafka](/docs/guides/kafka/README.md). Shows how to manage Kafka using KubeDB. +- [ZooKeeper](/docs/guides/zookeeper/README.md). Shows how to manage ZooKeeper using KubeDB. - [SingleStore](/docs/guides/singlestore/README.md). Shows how to manage SingleStore using KubeDB. - [Solr](/docs/guides/solr/README.md). Shows how to manage Solr using KubeDB. - [ZooKeeper](/docs/guides/zookeeper/README.md). Shows how to manage ZooKeeper using KubeDB. diff --git a/docs/guides/rabbitmq/README.md b/docs/guides/rabbitmq/README.md new file mode 100644 index 0000000000..3455bc0412 --- /dev/null +++ b/docs/guides/rabbitmq/README.md @@ -0,0 +1,61 @@ +--- +title: RabbitMQ +menu: + docs_{{ .version }}: + identifier: guides-rabbitmq-readme + name: RabbitMQ + parent: guides-rabbitmq + weight: 10 +menu_name: docs_{{ .version }} +section_menu_id: guides +url: /docs/{{ .version }}/guides/rabbitmq/ +aliases: + - /docs/{{ .version }}/guides/rabbitmq/README/ +--- +> New to KubeDB? Please start [here](/docs/README.md). + +# Overview + +RabbitMQ is a robust and flexible open-source message broker software that facilitates communication between distributed applications. It implements the Advanced Message Queuing Protocol (AMQP) standard, ensuring reliable messaging across various platforms and languages. With its support for multiple messaging protocols and delivery patterns, RabbitMQ enables seamless integration and scalability for modern microservices architectures. It provides features such as message persistence, clustering, and high availability, making it a preferred choice for handling asynchronous communication and decoupling components in enterprise systems. + +## Supported RabbitMQ Features + +| Features | Availability | +|----------------------------------------------------|:------------:| +| Clustering | ✓ | +| Authentication & Authorization | ✓ | +| Custom Configuration | ✓ | +| Monitoring using Prometheus and Grafana | ✓ | +| Builtin Prometheus Discovery | ✓ | +| Using Prometheus operator | ✓ | +| Externally manageable Auth Secret | ✓ | +| Reconfigurable Health Checker | ✓ | +| Persistent volume | ✓ | +| Dashboard ( Management UI ) | ✓ | +| Grafana Dashboards (Alerts and Monitoring) | ✓ | +| Custom Plugin configurations | ✓ | +| Pre-Enabled utility plugins ( Shovel, Federation ) | ✓ | +| Automatic Vertical Scaling | ✓ | +| Automatic Volume Expansion | ✓ | +| Autoscaling ( Compute resources & Storage ) | ✓ | + + +## Supported RabbitMQ Versions + +KubeDB supports the following RabbitMQ Versions. +- `3.12.12` + +## Life Cycle of a RabbitMQ Object + + + +

+ lifecycle +

+ +## User Guide + +- [Quickstart RabbitMQ](/docs/guides/rabbitmq/quickstart/quickstart.md) with KubeDB Operator. +- Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). \ No newline at end of file diff --git a/docs/guides/rabbitmq/_index.md b/docs/guides/rabbitmq/_index.md new file mode 100644 index 0000000000..97b783d171 --- /dev/null +++ b/docs/guides/rabbitmq/_index.md @@ -0,0 +1,10 @@ +--- +title: RabbitMQ +menu: + docs_{{ .version }}: + identifier: guides-rabbitmq + name: RabbitMQ + parent: guides + weight: 20 +menu_name: docs_{{ .version }} +--- diff --git a/docs/guides/rabbitmq/images/rabbitmq-lifecycle.png b/docs/guides/rabbitmq/images/rabbitmq-lifecycle.png new file mode 100644 index 0000000000..8e9d99f79d Binary files /dev/null and b/docs/guides/rabbitmq/images/rabbitmq-lifecycle.png differ diff --git a/docs/guides/rabbitmq/quickstart/_index.md b/docs/guides/rabbitmq/quickstart/_index.md new file mode 100644 index 0000000000..bb3cb786c0 --- /dev/null +++ b/docs/guides/rabbitmq/quickstart/_index.md @@ -0,0 +1,10 @@ +--- +title: RabbitMQ Quickstart +menu: + docs_{{ .version }}: + identifier: rm-quickstart-rabbitmq + name: Quickstart + parent: guides-rabbitmq + weight: 10 +menu_name: docs_{{ .version }} +--- diff --git a/docs/guides/rabbitmq/quickstart/images/management-ui.png b/docs/guides/rabbitmq/quickstart/images/management-ui.png new file mode 100644 index 0000000000..fd4d2cf53c Binary files /dev/null and b/docs/guides/rabbitmq/quickstart/images/management-ui.png differ diff --git a/docs/guides/rabbitmq/quickstart/images/rabbitmq-lifecycle.png b/docs/guides/rabbitmq/quickstart/images/rabbitmq-lifecycle.png new file mode 100644 index 0000000000..8e9d99f79d Binary files /dev/null and b/docs/guides/rabbitmq/quickstart/images/rabbitmq-lifecycle.png differ diff --git a/docs/guides/rabbitmq/quickstart/quickstart.md b/docs/guides/rabbitmq/quickstart/quickstart.md new file mode 100644 index 0000000000..bc2a6c6ddd --- /dev/null +++ b/docs/guides/rabbitmq/quickstart/quickstart.md @@ -0,0 +1,430 @@ +--- +title: RabbitMQ Quickstart +menu: + docs_{{ .version }}: + identifier: rm-quickstart-quickstart + name: Overview + parent: rm-quickstart-rabbitmq + weight: 15 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + +> New to KubeDB? Please start [here](/docs/README.md). + +# RabbitMQ QuickStart + +This tutorial will show you how to use KubeDB to run a RabbitMQ database. + +

+ lifecycle +

+ +> Note: The yaml files used in this tutorial are stored in [docs/examples/rabbitmq/quickstart](https://github.com/kubedb/docs/tree/{{< param "info.version" >}}/docs/examples/rabbitmq/quickstart) folder in GitHub repository [kubedb/docs](https://github.com/kubedb/docs). + +## Before You Begin + +- At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/). + +- Now, install KubeDB in your cluster following the steps [here](/docs/setup/README.md) and make sure install with helm command including `--set global.featureGates.RabbitMQ=true` to ensure RabbitMQ CRDs. + +- [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) is required to run KubeDB. Check the available StorageClass in cluster. + + ```bash + $ kubectl get storageclasses + NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE + standard (default) rancher.io/local-path Delete WaitForFirstConsumer false 6h22m + ``` + +- To keep things isolated, this tutorial uses a separate namespace called `demo` throughout this tutorial. + + ```bash + $ kubectl create ns demo + namespace/demo created + ``` + +## Find Available RabbitMQVersion + +When you have installed KubeDB, it has created `RabbitMQVersion` crd for all supported RabbitMQ versions. Check it by using the `kubectl get rabbitmqversions` command. You can also use `rmv` shorthand instead of `rabbitmqversions`. + +```bash +$ kubectl get rabbitmqversion +NAME VERSION DB_IMAGE DEPRECATED AGE +3.12.12 3.12.12 ghcr.io/appscode-images/rabbitmq:3.12.12-management-alpine 7d1h +``` + +## Create a RabbitMQ database + +KubeDB implements a `RabbitMQ` CRD to define the specification of a RabbitMQ database. Below is the `RabbitMQ` object created in this tutorial. + +```yaml +apiVersion: kubedb.com/v1alpha2 +kind: RabbitMQ +metadata: + name: rm-quickstart + namespace: demo +spec: + version: "3.12.12" + replicas: 3 + storage: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 1Gi + storageClassName: standard + storageType: Durable + terminationPolicy: WipeOut # DoNotTerminate(blocks deletion), Halt( retains pvc,secret), Delete (retains secret) + podTemplate: + spec: + containers: + - name: rabbitmq + resources: + requests: + cpu: "0.5" + memory: "1Gi" + limits: + cpu: "2" + memory: "2Gi" + serviceTemplates: + - alias: primary + spec: + type: LoadBalancer +``` + +```bash +$ kubectl create -f https://github.com/kubedb/docs/raw/{{< param "info.version" >}}/docs/examples/rabbitmq/quickstart/quickstart.yaml +rabbitmq.kubedb.com/rm-quickstart created +``` +Here, + +- `.spec.replica` is used to provide the number of required replicas or, peers for intended rabbitmq cluster. +- `spec.version` is the name of the RabbitMQVersion CRD where the docker images are specified. In this tutorial, a RabbitMQ `3.12.12` database is going to be created. +- `spec.storageType` specifies the type of storage that will be used for RabbitMQ database. It can be `Durable` or `Ephemeral`. Default value of this field is `Durable`. If `Ephemeral` is used then KubeDB will create RabbitMQ database using `EmptyDir` volume. In this case, you don't have to specify `spec.storage` field. This is useful for testing purposes. +- `spec.terminationPolicy` gives flexibility whether to `nullify`(reject) the delete operation of `RabbitMQ` CRD or which resources KubeDB should keep or delete when you delete `RabbitMQ` CRD. If admission webhook is enabled, It prevents users from deleting the database as long as the `spec.terminationPolicy` is set to `DoNotTerminate`. Learn details of all `TerminationPolicy` [here](/docs/guides/mysql/concepts/database/index.md#specterminationpolicy) +- `.spec.podTemplate` is used to provide specific pod specifications or container specification. You can override default resources, securityContext etc. set for rabbitmq container. Find details [here](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) +- `spec.serviceTemplates` is used to provide template for the services created by KubeDB operator for RabbitMQ database. This will allow you to set the type and other properties of the services. + +> Note: `spec.storage` section is used to create PVC for database pod. It will create PVC with storage size specified in `storage.resources.requests` field. Don't specify limits here. PVC does not get resized automatically. + +KubeDB operator watches for `RabbitMQ` objects using Kubernetes api. When a `RabbitMQ` object is created, KubeDB provisioner operator will create new PetSet (aka StatefulSet 2.0), Service (Primary) with the matching RabbitMQ object name and Required secrets for cluster communication and authentication if not present. KubeDB operator will also create an AppBinding resource and governing service for PetSets, if one is not already present. `AppBinding` is a Kubernetes `CustomResourceDefinition`(CRD) which points to an application using either its URL (usually for a non-Kubernetes resident service instance) or a Kubernetes service object (if self-hosted in a Kubernetes cluster), some optional parameters and a credential secret. + +```bash +$ kubectl get petset -n demo +NAME AGE +rm-quickstart 6m14s + +$ kubectl get pvc -n demo +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +rm-quickstart-data-rm-quickstart-0 Bound pvc-596bd8de-4123-40fd-a8d1-a864b9acddc2 1Gi RWO standard 6m38s +rm-quickstart-data-rm-quickstart-1 Bound pvc-c94bd3d0-8fa7-4794-9221-8295bc3e7b38 1Gi RWO standard 6m32s +rm-quickstart-data-rm-quickstart-2 Bound pvc-ddfd1987-c8b2-4c72-90ad-a8361ed4de56 1Gi RWO standard 6m26s + +$ kubectl get pv -n demo +NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS VOLUMEATTRIBUTESCLASS REASON AGE +pvc-596bd8de-4123-40fd-a8d1-a864b9acddc2 1Gi RWO Delete Bound demo/rm-quickstart-data-rm-quickstart-0 standard 7m4s +pvc-c94bd3d0-8fa7-4794-9221-8295bc3e7b38 1Gi RWO Delete Bound demo/rm-quickstart-data-rm-quickstart-1 standard 6m58s +pvc-ddfd1987-c8b2-4c72-90ad-a8361ed4de56 1Gi RWO Delete Bound demo/rm-quickstart-data-rm-quickstart-2 standard 6m52s + +$ kubectl get service -n demo +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +rm-quickstart LoadBalancer 10.96.120.188 15672:30802/TCP,5672:32684/TCP 8m49s +rm-quickstart-pods ClusterIP None 4369/TCP,25672/TCP 8m49s + +$ kubectl get appbinding -n demo +NAME TYPE VERSION AGE +rm-quickstart kubedb.com/rabbitmq 3.12.12 23h +``` + +KubeDB operator sets the `status.phase` to `Running` once the database is successfully created. Run the following command to see the modified `RabbitMQ` object: + +```bash +$ kubectl get rm -n demo rm-quickstart -oyaml +``` +```yaml +apiVersion: kubedb.com/v1alpha2 +kind: RabbitMQ +metadata: + annotations: + kubectl.kubernetes.io/last-applied-configuration: | + {"apiVersion":"kubedb.com/v1alpha2","kind":"RabbitMQ","metadata":{"annotations":{},"name":"rm-quickstart","namespace":"demo"},"spec":{"podTemplate":{"spec":{"containers":[{"name":"rabbitmq","resources":{"limits":{"cpu":"2","memory":"2Gi"},"requests":{"cpu":"0.5","memory":"1Gi"}}}]}},"replicas":3,"serviceTemplates":[{"alias":"primary","spec":{"type":"LoadBalancer"}}],"storage":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"1Gi"}},"storageClassName":"standard"},"storageType":"Durable","terminationPolicy":"WipeOut","version":"3.12.12"}} + creationTimestamp: "2024-05-07T10:25:35Z" + finalizers: + - kubedb.com/rabbitmq + generation: 3 + name: rm-quickstart + namespace: demo + resourceVersion: "390056" + uid: 37dd5c9f-2df3-492e-a828-309abf580cc6 +spec: + authSecret: + name: rm-quickstart-admin-cred + healthChecker: + failureThreshold: 3 + periodSeconds: 20 + timeoutSeconds: 10 + podPlacementPolicy: + name: default + podTemplate: + controller: {} + metadata: {} + spec: + containers: + - name: rabbitmq + resources: + limits: + cpu: "2" + memory: 2Gi + requests: + cpu: 500m + memory: 1Gi + securityContext: + allowPrivilegeEscalation: false + capabilities: + drop: + - ALL + runAsNonRoot: true + runAsUser: 999 + seccompProfile: + type: RuntimeDefault + initContainers: + - name: rabbitmq-init + resources: {} + securityContext: + allowPrivilegeEscalation: false + capabilities: + drop: + - ALL + runAsNonRoot: true + runAsUser: 999 + seccompProfile: + type: RuntimeDefault + securityContext: + fsGroup: 999 + replicas: 3 + serviceTemplates: + - alias: primary + metadata: {} + spec: + type: LoadBalancer + storage: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 1Gi + storageClassName: standard + storageType: Durable + terminationPolicy: WipeOut + version: 3.12.12 +status: + conditions: + - lastTransitionTime: "2024-05-07T10:25:36Z" + message: 'The KubeDB operator has started the provisioning of Rabbitmq: demo/rm-quickstart' + observedGeneration: 2 + reason: DatabaseProvisioningStartedSuccessfully + status: "True" + type: ProvisioningStarted + - lastTransitionTime: "2024-05-07T10:35:34Z" + message: All desired replicas are ready. + reason: AllReplicasReady + status: "True" + type: ReplicaReady + - lastTransitionTime: "2024-05-07T10:33:20Z" + message: 'The Rabbitmq: demo/rm-quickstart is accepting client requests' + observedGeneration: 3 + reason: DatabaseAcceptingConnectionRequest + status: "True" + type: AcceptingConnection + - lastTransitionTime: "2024-05-07T10:26:20Z" + message: Ready for publishing messages + observedGeneration: 3 + reason: Successfully publishing messages + status: "True" + type: DatabaseWriteAccess + - lastTransitionTime: "2024-05-07T10:33:20Z" + message: 'The Rabbitmq: demo/rm-quickstart is ready.' + observedGeneration: 3 + reason: ReadinessCheckSucceeded + status: "True" + type: Ready + - lastTransitionTime: "2024-05-07T10:26:24Z" + message: 'The Rabbitmq: demo/rm-quickstart is successfully provisioned.' + observedGeneration: 3 + reason: DatabaseSuccessfullyProvisioned + status: "True" + type: Provisioned + - lastTransitionTime: "2024-05-07T10:26:40Z" + message: Ready for Consuming messages + observedGeneration: 3 + reason: Successfully Consuming messages + status: "True" + type: DatabaseReadAccess + phase: Ready +``` + +## Connect with RabbitMQ database + +Unless provided by the user in `.spec.authSecret.name` field, KubeDB operator creates a new Secret called `rm-quickstart-admin-cred` *(format: {rabbitmq-object-name}-admin-cred)* for storing the password for `admin` user who has administrative authorizations over `/` vhost of RabbitMQ cluster. This secret contains a `username` key which contains the *username* for RabbitMQ `admin` user and a `password` key which contains the *password* for this user. + +If you want to use an existing secret please specify that when creating the RabbitMQ object using `spec.authSecret.name`. While creating this secret manually, make sure the secret contains these two keys containing data `username` and `password` and also make sure of using `admin` as value of `username`. + +Now, we need `username` and `password` to connect to this database. + +```bash +$ kubectl get secrets -n demo rm-quickstart-admin-cred -o jsonpath='{.data.username}' | base64 -d +admin +$ kubectl get secrets -n demo rm-quickstart-admin-cred -o jsonpath='{.data.password}' | base64 -d +password +``` +We can check client connectivity using an opensource load-testing tool called `perf-test`. It runs producers and consumers to continuously publish and consume messages in RabbitMQ cluster. Here's how to run it on kubernetes using the credentials and the address for operator generated primary service. + +```bash +kubectl run perf-test --image=pivotalrabbitmq/perf-test -- --uri "amqp://admin:password@rm-quickstart.demo.svc:5672" +``` + +You can check the log for this pod which shows publish and consume rates of messages in RabbitMQ. + +```bash +$ kubectl logs pod/perf-test -f +id: test-104606-706, starting consumer #0 +id: test-104606-706, starting consumer #0, channel #0 +id: test-104606-706, starting producer #0 +id: test-104606-706, starting producer #0, channel #0 +id: test-104606-706, time 1.000 s, sent: 81286 msg/s, received: 23516 msg/s, min/median/75th/95th/99th consumer latency: 6930/174056/361178/503928/519681 µs +id: test-104606-706, time 2.000 s, sent: 30997 msg/s, received: 30686 msg/s, min/median/75th/95th/99th consumer latency: 529789/902251/1057447/1247103/1258790 µs +id: test-104606-706, time 3.000 s, sent: 29032 msg/s, received: 30418 msg/s, min/median/75th/95th/99th consumer latency: 1262421/1661565/1805425/1953992/1989182 µs +id: test-104606-706, time 4.000 s, sent: 30997 msg/s, received: 31228 msg/s, min/median/75th/95th/99th consumer latency: 1572496/1822873/1938918/2035918/2065812 µs +id: test-104606-706, time 5.000 s, sent: 29032 msg/s, received: 33588 msg/s, min/median/75th/95th/99th consumer latency: 1503867/1729779/1831281/1930593/1968284 µs +id: test-104606-706, time 6.000 s, sent: 32704 msg/s, received: 32493 msg/s, min/median/75th/95th/99th consumer latency: 1503915/1749654/1865878/1953439/1971834 µs +id: test-104606-706, time 7.000 s, sent: 38117 msg/s, received: 30759 msg/s, min/median/75th/95th/99th consumer latency: 1511466/1772387/1854642/1918369/1940327 µs +id: test-104606-706, time 8.000 s, sent: 35088 msg/s, received: 31676 msg/s, min/median/75th/95th/99th consumer latency: 1578860/1799719/1915632/1985467/2024141 µs +id: test-104606-706, time 9.000 s, sent: 29706 msg/s, received: 31375 msg/s, min/median/75th/95th/99th consumer latency: 1516415/1743385/1877037/1972570/1988962 µs +id: test-104606-706, time 10.000 s, sent: 15903 msg/s, received: 26711 msg/s, min/median/75th/95th/99th consumer latency: 1569546/1884700/1992762/2096417/2136613 µs +``` + +You can also connect with the RabbitMQ Management UI. It can be accessed through Primary service's 15672 Port or from a localhost port if the port is forwarded. + +```bash +$ kubectl port-forward -n demo svc/rm-quickstart 15672 +Forwarding from 127.0.0.1:15672 -> 15672 +Forwarding from [::1]:15672 -> 15672 +``` + +Lets, open your browser and go to the **http://localhost:15672** then access using the credentials. + +

+ management-ui +

+ +## Database TerminationPolicy + +This field is used to regulate the deletion process of the related resources when `RabbitMQ` object is deleted. User can set the value of this field according to their needs. The available options and their use case scenario is described below: + +**DoNotTerminate:** + +When `terminationPolicy` is set to `DoNotTerminate`, KubeDB takes advantage of `ValidationWebhook` feature in Kubernetes 1.9.0 or later clusters to implement `DoNotTerminate` feature. If admission webhook is enabled, It prevents users from deleting the database as long as the `spec.terminationPolicy` is set to `DoNotTerminate`. You can see this below: + +```bash +$ kubectl delete rm rm-quickstart -n demo +The RabbitMQ "rm-quickstart" is invalid: spec.terminationPolicy: Invalid value: "rm-quickstart": Can not delete as terminationPolicy is set to "DoNotTerminate" +``` + +Now, run `kubectl patch -n demo rm rm-quickstart -p '{"spec":{"terminationPolicy":"Halt"}}' --type="merge"` to set `spec.terminationPolicy` to `Halt` (which deletes the RabbitMQ object and keeps PVC, snapshots, Secrets intact) or remove this field (which default to `Delete`). Then you will be able to delete/halt the database. + +Learn details of all `TerminationPolicy` [here](/docs/guides/mysql/concepts/database/index.md#specterminationpolicy). + +**Halt:** + +Suppose you want to reuse your database volume and credential to deploy your database in future using the same configurations. But, right now you just want to delete the database except the database volumes and credentials. In this scenario, you must set the `RabbitMQ` object `terminationPolicy` to `Halt`. + +When the [TerminationPolicy](/docs/guides/mysql/concepts/database/index.md#specterminationpolicy) is set to `halt` and the RabbitMQ object is deleted, the KubeDB operator will delete the PetSet and its pods but leaves the `PVCs`, `secrets` and database backup data(`snapshots`) intact. You can set the `terminationPolicy` to `halt` in existing database using `patch` command for testing. + +At first, run `kubectl patch -n demo rm rm-quickstart -p '{"spec":{"terminationPolicy":"Halt"}}' --type="merge"`. Then delete the RabbitMQ object, + +```bash +$ kubectl delete rm rm-quickstart -n demo +rabbitmq.kubedb.com "rm-quickstart" deleted +``` + +Now, run the following command to get all rabbitmq resources in `demo` namespaces, + +```bash +$ kubectl get petset,svc,secret,pvc -n demo +NAME TYPE DATA AGE +secret/rm-quickstart-admin-cred kubernetes.io/basic-auth 2 3m35s + +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS VOLUMEATTRIBUTESCLASS AGE +rm-quickstart-data-rm-quickstart-0 Bound pvc-596bd8de-4123-40fd-a8d1-a864b9acddc2 1Gi RWO standard 6m38s +rm-quickstart-data-rm-quickstart-1 Bound pvc-c94bd3d0-8fa7-4794-9221-8295bc3e7b38 1Gi RWO standard 6m32s +rm-quickstart-data-rm-quickstart-2 Bound pvc-ddfd1987-c8b2-4c72-90ad-a8361ed4de56 1Gi RWO standard 6m26s + +``` + +From the above output, you can see that all RabbitMQ resources(`PetSet`, `Service`, etc.) are deleted except `PVC` and `Secret`. You can recreate your RabbitMQ again using these resources. + +>You can also set the `terminationPolicy` to `Halt`(deprecated). It's behavior same as `halt` and right now `Halt` is replaced by `Halt`. + +**Delete:** + +If you want to delete the existing database along with the volumes used, but want to restore the database from previously taken `snapshots` and `secrets` then you might want to set the `RabbitMQ` object `terminationPolicy` to `Delete`. In this setting, `PetSet` and the volumes will be deleted. If you decide to restore the database, you can do so using the snapshots and the credentials. + +When the [TerminationPolicy](/docs/guides/mysql/concepts/database/index.md#specterminationpolicy) is set to `Delete` and the RabbitMQ object is deleted, the KubeDB operator will delete the PetSet and its pods along with PVCs but leaves the `secret` and database backup data(`snapshots`) intact. + +Suppose, we have a database with `terminationPolicy` set to `Delete`. Now, are going to delete the database using the following command: + +```bash +$ kubectl delete rm rm-quickstart -n demo +rabbitmq.kubedb.com "rm-quickstart" deleted +``` + +Now, run the following command to get all RabbitMQ resources in `demo` namespaces, + +```bash +$ kubectl get petset,svc,secret,pvc -n demo +NAME TYPE DATA AGE +secret/rm-quickstart-root-cred kubernetes.io/basic-auth 2 17m +``` + +From the above output, you can see that all RabbitMQ resources(`PetSet`, `Service`, `PVCs` etc.) are deleted except `Secret`. + +>If you don't set the terminationPolicy then the kubeDB set the TerminationPolicy to Delete by-default. + +**WipeOut:** + +You can totally delete the `RabbitMQ` database and relevant resources without any tracking by setting `terminationPolicy` to `WipeOut`. KubeDB operator will delete all relevant resources of this `RabbitMQ` database (i.e, `PVCs`, `Secrets`, `Snapshots`) when the `terminationPolicy` is set to `WipeOut`. + +Suppose, we have a database with `terminationPolicy` set to `WipeOut`. Now, are going to delete the database using the following command: + +```yaml +$ kubectl delete rm rm-quickstart -n demo +rabbitmq.kubedb.com "rm-quickstart" deleted +``` + +Now, run the following command to get all RabbitMQ resources in `demo` namespaces, + +```bash +$ kubectl get petset,svc,secret,pvc -n demo +No resources found in demo namespace. +``` + +From the above output, you can see that all RabbitMQ resources are deleted. There is no option to recreate/reinitialize your database if `terminationPolicy` is set to `Delete`. + +>Be careful when you set the `terminationPolicy` to `Delete`. Because there is no option to trace the database resources if once deleted the database. + +## Cleaning up + +To cleanup the Kubernetes resources created by this tutorial, run: + +```bash +kubectl patch -n demo rabbitmq/rm-quickstart -p '{"spec":{"terminationPolicy":"WipeOut"}}' --type="merge" +kubectl delete -n demo rabbitmq/rm-quickstart +kubectl delete ns demo +``` + +## Tips for Testing + +If you are just testing some basic functionalities, you might want to avoid additional hassles due to some safety features that are great for production environment. You can follow these tips to avoid them. + +1. **Use `storageType: Ephemeral`**. Databases are precious. You might not want to lose your data in your production environment if database pod fail. So, we recommend to use `spec.storageType: Durable` and provide storage spec in `spec.storage` section. For testing purpose, you can just use `spec.storageType: Ephemeral`. KubeDB will use [emptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) for storage. You will not require to provide `spec.storage` section. +2. **Use `terminationPolicy: WipeOut`**. It is nice to be able to delete everything created by KubeDB for a particular RabbitMQ crd when you delete the crd. For more details about termination policy, please visit [here](/docs/guides/mysql/concepts/database/index.md#specterminationpolicy). \ No newline at end of file