Skip to content

Commit 0f5e282

Browse files
cuisongliucuisongliu
authored
feat: add RabbitMQ template, logo, and README documentation (#17)
* feat: add RabbitMQ template, logo, and README documentation * feat: specify RabbitMQ image version in index.yaml
1 parent f67fc5f commit 0f5e282

3 files changed

Lines changed: 245 additions & 0 deletions

File tree

‎template/rabbitmq/README.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# RabbitMQ Server
2+
3+
[![CI](https://github.com/rabbitmq/rabbitmq-server/actions/workflows/test-make.yaml/badge.svg)](https://github.com/rabbitmq/rabbitmq-server/actions/workflows/test-make.yaml)
4+
5+
[RabbitMQ](https://rabbitmq.com) is a [feature rich](https://www.rabbitmq.com/docs),
6+
multi-protocol messaging and streaming broker. It supports:
7+
8+
* AMQP 1.0
9+
* AMQP 0-9-1
10+
* [RabbitMQ Stream Protocol](https://www.rabbitmq.com/docs/streams)
11+
* MQTT 3.1, 3.1.1, and 5.0
12+
* STOMP 1.0 through 1.2
13+
* [MQTT over WebSocket](https://www.rabbitmq.com/docs/web-mqtt)
14+
* [STOMP over WebSocket](https://www.rabbitmq.com/docs/web-stomp)
15+
* AMQP 1.0 over WebSocket (supported in [VMware Tanzu RabbitMQ](https://www.vmware.com/products/app-platform/tanzu-rabbitmq))
16+
17+
18+
## Installation
19+
20+
* [Currently supported](https://www.rabbitmq.com/release-information) released series
21+
* [Installation guides](https://www.rabbitmq.com/docs/download) for various platforms
22+
* [Kubernetes Cluster Operator](https://www.rabbitmq.com/kubernetes/operator/operator-overview)
23+
* [Changelog](https://www.rabbitmq.com/release-information)
24+
* [Releases](https://github.com/rabbitmq/rabbitmq-server/releases) on GitHub
25+
* [Community Support Eligibility Policy](https://github.com/rabbitmq/rabbitmq-server/blob/main/COMMUNITY_SUPPORT.md)
26+
* [Supported Erlang versions](https://www.rabbitmq.com/docs/which-erlang)
27+
28+
29+
## Tutorials and Documentation
30+
31+
* [RabbitMQ tutorials](https://www.rabbitmq.com/tutorials) and their [executable versions on GitHub](https://github.com/rabbitmq/rabbitmq-tutorials)
32+
* [Documentation guides](https://rabbitmq.com/docs/)
33+
* [RabbitMQ blog](https://blog.rabbitmq.com/)
34+
35+
Some key doc guides include
36+
37+
* [CLI tools guide](https://www.rabbitmq.com/docs/cli)
38+
* [Clustering](https://www.rabbitmq.com/docs/clustering) and [Cluster Formation](https://www.rabbitmq.com/docs/cluster-formation)
39+
* [Configuration guide](https://www.rabbitmq.com/docs/configure)
40+
* [Client libraries and tools](https://www.rabbitmq.com/client-libraries/devtools)
41+
* [Upgrading](https://www.rabbitmq.com/docs/upgrade)
42+
* [Kubernetes Cluster Operator](https://www.rabbitmq.com/kubernetes/operator/operator-overview)
43+
* [Quorum queues](https://www.rabbitmq.com/docs/quorum-queues): a replicated, data safety- and consistency-oriented queue type
44+
* [Streams](https://www.rabbitmq.com/docs/streams): a persistent and replicated append-only log with non-destructive consumer semantics
45+
* [Runtime Parameters](https://www.rabbitmq.com/docs/parameters)
46+
* [Policies](https://www.rabbitmq.com/docs/policies)
47+
* [Monitoring](https://www.rabbitmq.com/docs/monitoring) and [Prometheus/Grafana](https://www.rabbitmq.com/docs/prometheus)
48+
* [Production checklist](https://www.rabbitmq.com/docs/production-checklist)
49+
50+
RabbitMQ documentation is also [developed on GitHub](https://github.com/rabbitmq/rabbitmq-website/).
51+
52+
## Commercial Features and Support
53+
54+
* [Commercial editions of RabbitMQ](https://tanzu.vmware.com/rabbitmq)
55+
* [Commercial edition for Kubernetes](https://docs.vmware.com/en/VMware-RabbitMQ-for-Kubernetes/1/rmq/installation.html)
56+
* [Commercial support](https://tanzu.vmware.com/rabbitmq/oss) from [Broadcom](https://vmware.com) for open source RabbitMQ
57+
58+
## Getting Help from the Community
59+
60+
Please read the [Community Support Eligibility Policy](https://github.com/rabbitmq/rabbitmq-server/blob/main/COMMUNITY_SUPPORT.md) document
61+
first.
62+
63+
The recommended community forums are
64+
65+
* [GitHub Discussions](https://github.com/rabbitmq/rabbitmq-server/discussions/)
66+
* [Community Discord server](https://rabbitmq.com/discord/)
67+
* `#rabbitmq` on [Libera Chat](https://libera.chat/)
68+
69+
70+
## Contributing
71+
72+
See [CONTRIBUTING.md](./CONTRIBUTING.md) and our [development process overview](https://www.rabbitmq.com/github).
73+
74+
Questions about contributing, internals and so on are very welcome in [GitHub Discussions](https://github.com/rabbitmq/rabbitmq-server/discussions)
75+
or [community Discord server](https://www.rabbitmq.com/discord/) in the `contributors` channel.
76+
77+
78+
## Licensing
79+
80+
RabbitMQ server is [licensed under the MPL 2.0](LICENSE-MPL-RabbitMQ).
81+
82+
[Community Support Eligibility Policy](https://github.com/rabbitmq/rabbitmq-server/blob/main/COMMUNITY_SUPPORT.md)
83+
document explains the open source RabbitMQ support policy adopted by the RabbitMQ Core Team.
84+
85+
86+
## AI Agent Instructions
87+
88+
See `AGENTS.md`.
89+
90+
91+
## Building From Source and Packaging
92+
93+
* [Contributor resources](https://github.com/rabbitmq/contribute)
94+
* [Building RabbitMQ from Source](https://www.rabbitmq.com/docs/build-server)
95+
* [Building RabbitMQ Distribution Packages](https://www.rabbitmq.com/docs/build-server)
96+
97+
98+
## Copyright
99+
100+
(c) 2007-2026 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

‎template/rabbitmq/index.yaml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
apiVersion: app.sealos.io/v1
2+
kind: Template
3+
metadata:
4+
name: RabbitMQ
5+
spec:
6+
title: 'RabbitMQ'
7+
url: 'https://www.rabbitmq.com'
8+
gitRepo: 'https://github.com/rabbitmq/rabbitmq-server'
9+
author: 'Sealos'
10+
description: 'Open source RabbitMQ: core server and tier 1 (built-in) plugins'
11+
readme: 'https://raw.githubusercontent.com/rabbitmq/rabbitmq-server/refs/heads/main/README.md'
12+
icon: 'https://www.rabbitmq.com/img/rabbitmq-logo.svg'
13+
templateType: inline
14+
locale: en
15+
categories:
16+
- tools
17+
defaults:
18+
app_host:
19+
type: string
20+
value: rabbitmq-${{ random(8) }}
21+
app_name:
22+
type: string
23+
value: rabbitmq-${{ random(8) }}
24+
---
25+
apiVersion: rabbitmq.com/v1beta1
26+
kind: RabbitmqCluster
27+
metadata:
28+
name: ${{ defaults.app_name }}
29+
spec:
30+
image: rabbitmq:4.1.3-management
31+
replicas: 3
32+
service:
33+
labels:
34+
cloud.sealos.io/deploy-on-sealos: ${{ defaults.app_name }}
35+
type: NodePort
36+
resources:
37+
requests:
38+
cpu: 1
39+
memory: 2Gi
40+
limits:
41+
cpu: 4
42+
memory: 8Gi
43+
rabbitmq:
44+
additionalConfig: |
45+
cluster_partition_handling = pause_minority
46+
disk_free_limit.relative = 1.0
47+
collect_statistics_interval = 10000
48+
persistence:
49+
# storageClassName: ssd
50+
storage: "30Gi"
51+
---
52+
apiVersion: networking.k8s.io/v1
53+
kind: Ingress
54+
metadata:
55+
name: ${{ defaults.app_name }}
56+
labels:
57+
cloud.sealos.io/app-deploy-manager: ${{ defaults.app_name }}
58+
cloud.sealos.io/app-deploy-manager-domain: ${{ defaults.app_host }}
59+
annotations:
60+
kubernetes.io/ingress.class: nginx
61+
nginx.ingress.kubernetes.io/proxy-body-size: 32m
62+
nginx.ingress.kubernetes.io/server-snippet: |
63+
client_header_buffer_size 64k;
64+
large_client_header_buffers 4 128k;
65+
nginx.ingress.kubernetes.io/ssl-redirect: 'true'
66+
nginx.ingress.kubernetes.io/backend-protocol: HTTP
67+
nginx.ingress.kubernetes.io/client-body-buffer-size: 64k
68+
nginx.ingress.kubernetes.io/proxy-buffer-size: 64k
69+
nginx.ingress.kubernetes.io/proxy-send-timeout: '300'
70+
nginx.ingress.kubernetes.io/proxy-read-timeout: '300'
71+
nginx.ingress.kubernetes.io/configuration-snippet: |
72+
if ($request_uri ~* \.(js|css|gif|jpe?g|png)) {
73+
expires 30d;
74+
add_header Cache-Control "public";
75+
}
76+
spec:
77+
rules:
78+
- host: ${{ defaults.app_host }}.${{ SEALOS_CLOUD_DOMAIN }}
79+
http:
80+
paths:
81+
- pathType: Prefix
82+
path: /
83+
backend:
84+
service:
85+
name: ${{ defaults.app_name }}
86+
port:
87+
number: 15672
88+
tls:
89+
- hosts:
90+
- ${{ defaults.app_host }}.${{ SEALOS_CLOUD_DOMAIN }}
91+
secretName: ${{ SEALOS_CERT_SECRET_NAME }}

‎template/rabbitmq/rabbitmq-logo.svg‎

Lines changed: 54 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)