Skip to content

Commit 841774b

Browse files
Merge branch 'main' into loic-remove-cqv1-option
2 parents 8909396 + 15688c3 commit 841774b

File tree

3 files changed

+72
-54
lines changed

3 files changed

+72
-54
lines changed

deps/rabbit/docs/rabbitmq.conf.example

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
## copying the entire (large!) file, create or generate a new rabbitmq.conf for the target system
77
## and populate it with the necessary settings.
88
##
9-
## See https://rabbitmq.com/configure.html to learn about how to configure RabbitMQ,
9+
## See https://www.rabbitmq.com/docs/configure to learn about how to configure RabbitMQ,
1010
## the ini-style format used by rabbitmq.conf, how it is different from `advanced.config`,
1111
## how to verify effective configuration, and so on.
1212
##
13-
## See https://rabbitmq.com/documentation.html for the rest of RabbitMQ documentation.
13+
## See https://www.rabbitmq.com/docs/documentation for the rest of RabbitMQ documentation.
1414
##
1515
## In case you have questions, please use RabbitMQ community Slack and the rabbitmq-users Google group
1616
## instead of GitHub issues.
@@ -23,7 +23,7 @@
2323
## Networking
2424
## ====================
2525
##
26-
## Related doc guide: https://rabbitmq.com/networking.html.
26+
## Related doc guide: https://www.rabbitmq.com/docs/networking.
2727
##
2828
## By default, RabbitMQ will listen on all interfaces, using
2929
## the standard (reserved) AMQP 0-9-1 and 1.0 port.
@@ -84,7 +84,7 @@
8484
## ==============
8585
##
8686

87-
## Related doc guide: https://rabbitmq.com/access-control.html.
87+
## Related doc guide: https://www.rabbitmq.com/docs/access-control.
8888

8989
## The default "guest" user is only permitted to access the server
9090
## via a loopback interface (e.g. localhost).
@@ -98,7 +98,7 @@
9898

9999
## TLS configuration.
100100
##
101-
## Related doc guide: https://rabbitmq.com/ssl.html.
101+
## Related doc guide: https://www.rabbitmq.com/docs/ssl.
102102
##
103103
# listeners.ssl.1 = 5671
104104
#
@@ -192,8 +192,8 @@
192192
##
193193
## Related doc guides:
194194
##
195-
## * https://rabbitmq.com/plugins.html
196-
## * https://rabbitmq.com/access-control.html
195+
## * https://www.rabbitmq.com/docs/plugins
196+
## * https://www.rabbitmq.com/docs/access-control
197197
##
198198

199199
# auth_backends.1 = rabbit_auth_backend_internal
@@ -209,8 +209,8 @@
209209
##
210210
## Relevant doc guides:
211211
##
212-
## * https://rabbitmq.com/ldap.html
213-
## * https://rabbitmq.com/access-control.html
212+
## * https://www.rabbitmq.com/docs/ldap
213+
## * https://www.rabbitmq.com/docs/access-control
214214
##
215215
## uses LDAP for both authentication and authorisation
216216
# auth_backends.1 = rabbit_auth_backend_ldap
@@ -228,14 +228,14 @@
228228
## 'AMQPLAIN', and 'EXTERNAL' Additional mechanisms can be added via
229229
## plugins.
230230
##
231-
## Related doc guide: https://rabbitmq.com/authentication.html.
231+
## Related doc guide: https://www.rabbitmq.com/docs/authentication.
232232
##
233233
# auth_mechanisms.1 = PLAIN
234234
# auth_mechanisms.2 = AMQPLAIN
235235

236236
## The rabbitmq-auth-mechanism-ssl plugin makes it possible to
237237
## authenticate a user based on the client's x509 (TLS) certificate.
238-
## Related doc guide: https://rabbitmq.com/authentication.html.
238+
## Related doc guide: https://www.rabbitmq.com/docs/authentication.
239239
##
240240
## To use auth-mechanism-ssl, the EXTERNAL mechanism should
241241
## be enabled:
@@ -278,13 +278,6 @@
278278
##
279279
# load_definitions = /path/to/definitions/file.json
280280

281-
282-
##
283-
## Cluster name
284-
## ====================
285-
##
286-
# cluster_name = dev3.eng.megacorp.local
287-
288281
## Password hashing implementation. Will only affect newly
289282
## created users. To recalculate hash for an existing user
290283
## it's necessary to update her password.
@@ -306,7 +299,7 @@
306299

307300
## On first start RabbitMQ will create a vhost and a user. These
308301
## config items control what gets created.
309-
## Relevant doc guide: https://rabbitmq.com/access-control.html
302+
## Relevant doc guide: https://www.rabbitmq.com/docs/access-control
310303
##
311304
# default_vhost = /
312305
# default_user = guest
@@ -319,7 +312,7 @@
319312
## Tags for default user
320313
##
321314
## For more details about tags, see the documentation for the
322-
## Management Plugin at https://rabbitmq.com/management.html.
315+
## Management Plugin at https://www.rabbitmq.com/docs/management.
323316
##
324317
# default_user_tags.administrator = true
325318

@@ -342,8 +335,8 @@
342335
##
343336
## Related doc guides:
344337
##
345-
## * https://rabbitmq.com/heartbeats.html
346-
## * https://rabbitmq.com/networking.html
338+
## * https://www.rabbitmq.com/docs/heartbeats
339+
## * https://www.rabbitmq.com/docs/networking
347340
##
348341
# heartbeat = 60
349342

@@ -365,7 +358,7 @@
365358
##
366359
## Related doc guides:
367360
##
368-
## * https://rabbitmq.com/networking.html
361+
## * https://www.rabbitmq.com/docs/networking
369362
## * https://www.erlang.org/doc/man/inet.html#setopts-2
370363
##
371364

@@ -384,7 +377,7 @@
384377
## Resource Limits & Flow Control
385378
## ==============================
386379
##
387-
## Related doc guide: https://rabbitmq.com/memory.html.
380+
## Related doc guide: https://www.rabbitmq.com/docs/memory.
388381

389382
## Memory-based Flow Control threshold.
390383
##
@@ -423,7 +416,7 @@
423416
##
424417
## Another alternative is to configure queues to page all messages (both
425418
## persistent and transient) to disk as quickly
426-
## as possible, see https://rabbitmq.com/lazy-queues.html.
419+
## as possible, see https://www.rabbitmq.com/docs/lazy-queues.
427420
##
428421
# vm_memory_high_watermark_paging_ratio = 0.5
429422

@@ -463,6 +456,32 @@
463456
## Clustering
464457
## =====================
465458
##
459+
460+
## By default cluster name is set to the name of the first
461+
## node to have formed the cluster. It can be overridden
462+
## to make it easier for (human) operators to tell one cluster from another.
463+
# cluster_name = dev3.eng.megacorp.local
464+
465+
## Selects the default strategy used to pick a node to place a new queue leader replica
466+
## on. Can be overridden by the `x-queue-leader-locator` optional queue argument
467+
## at declaration time.
468+
##
469+
## "balanced" (the default) is recommended for most environments. It works
470+
## like so:
471+
##
472+
## 1. When there are many queues in the cluster, the candidate node is picked randomly
473+
## 2. When there are few queues, uses their current replica count to pick the node
474+
## with the smallest number of replicas.
475+
##
476+
## Supported non-deprecated values are: "balanced", "client-local"
477+
# queue_leader_locator = balanced
478+
479+
480+
## Partition handling strategy.
481+
## Primarily affects deployments that use Mnesia and classic queues.
482+
## Khepri and quorum queues, streams will always use Raft's failure recovery
483+
## strategy.
484+
##
466485
# cluster_partition_handling = ignore
467486

468487
## Pauses all nodes on the minority side of a partition. The cluster
@@ -479,12 +498,6 @@
479498
# cluster_partition_handling.pause_if_all_down.nodes.1 = rabbit@localhost
480499
# cluster_partition_handling.pause_if_all_down.nodes.2 = hare@localhost
481500

482-
## Mirror sync batch size, in messages. Increasing this will speed
483-
## up syncing but total batch size in bytes must not exceed 2 GiB.
484-
## Available in RabbitMQ 3.6.0 or later.
485-
##
486-
# mirroring_sync_batch_size = 4096
487-
488501
## Make clustering happen *automatically* at startup. Only applied
489502
## to nodes that have just been reset or started for the first time.
490503
##
@@ -530,19 +543,21 @@
530543
#
531544
# This value is no longer meant to be configured directly.
532545
#
533-
# See https://www.rabbitmq.com/management.html#fine-stats.
546+
# See https://www.rabbitmq.com/docs/management#fine-stats.
534547

535548
##
536-
## Ra Settings
549+
## Raft settings
537550
## =====================
538551
##
552+
## These set the defaults that quorum queues, streams, Khepri, and other Raft-based features use.
553+
##
539554
# raft.segment_max_entries = 65536
540555
# raft.wal_max_size_bytes = 1048576
541556
# raft.wal_max_batch_size = 4096
542557
# raft.snapshot_chunk_size = 1000000
543558

544559
##
545-
## Misc/Advanced Options
560+
## Misc and Advanced Options
546561
## =====================
547562
##
548563
## NB: Change these only if you understand what you are doing!
@@ -570,15 +585,17 @@
570585
## Timeout used when waiting for Mnesia tables in a cluster to
571586
## become available.
572587
##
588+
## Related doc guide: https://www.rabbitmq.com/docs/clustering#restarting
573589
# mnesia_table_loading_retry_timeout = 30000
574590

575591
## Retries when waiting for Mnesia tables in the cluster startup. Note that
576592
## this setting is not applied to Mnesia upgrades or node deletions.
577593
##
594+
## Related doc guide: https://www.rabbitmq.com/docs/clustering#restarting
578595
# mnesia_table_loading_retry_limit = 10
579596

580597
## Size in bytes below which to embed messages in the queue index.
581-
## Related doc guide: https://rabbitmq.com/persistence-conf.html
598+
## Related doc guide: https://www.rabbitmq.com/docs/persistence-conf
582599
##
583600
# queue_index_embed_msgs_below = 4096
584601

@@ -594,7 +611,7 @@
594611
## (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html).
595612
##
596613
## Before trying this option, please take a look at the memory
597-
## breakdown (https://www.rabbitmq.com/memory-use.html).
614+
## breakdown (https://www.rabbitmq.com/docs/memory-use).
598615
##
599616
# background_gc_enabled = false
600617

@@ -636,15 +653,15 @@
636653
## ----------------------------------------------------------------------------
637654
## Advanced Erlang Networking/Clustering Options.
638655
##
639-
## Related doc guide: https://rabbitmq.com/clustering.html
656+
## Related doc guide: https://www.rabbitmq.com/docs/clustering
640657
## ----------------------------------------------------------------------------
641658

642659
# ======================================
643660
# Kernel section
644661
# ======================================
645662

646663
## Timeout used to detect peer unavailability, including CLI tools.
647-
## Related doc guide: https://www.rabbitmq.com/nettick.html.
664+
## Related doc guide: https://www.rabbitmq.com/docs/nettick.
648665
##
649666
# net_ticktime = 60
650667

@@ -657,15 +674,15 @@
657674
## ----------------------------------------------------------------------------
658675
## RabbitMQ Management Plugin
659676
##
660-
## Related doc guide: https://rabbitmq.com/management.html.
677+
## Related doc guide: https://www.rabbitmq.com/docs/management.
661678
## ----------------------------------------------------------------------------
662679

663680
# =======================================
664681
# Management section
665682
# =======================================
666683

667684
## Preload schema definitions from the following JSON file.
668-
## Related doc guide: https://rabbitmq.com/management.html#load-definitions.
685+
## Related doc guide: https://www.rabbitmq.com/docs/management#load-definitions.
669686
##
670687
# management.load_definitions = /path/to/exported/definitions.json
671688

@@ -674,7 +691,7 @@
674691
# management.http_log_dir = /path/to/access.log
675692

676693
## HTTP listener and embedded Web server settings.
677-
# ## See https://rabbitmq.com/management.html for details.
694+
# ## See https://www.rabbitmq.com/docs/management for details.
678695
#
679696
# management.tcp.port = 15672
680697
# management.tcp.ip = 0.0.0.0
@@ -687,7 +704,7 @@
687704
# management.tcp.compress = true
688705

689706
## HTTPS listener settings.
690-
## See https://rabbitmq.com/management.html and https://rabbitmq.com/ssl.html for details.
707+
## See https://www.rabbitmq.com/docs/management and https://www.rabbitmq.com/docs/ssl for details.
691708
##
692709
# management.ssl.port = 15671
693710
# management.ssl.cacertfile = /path/to/ca_certificate.pem
@@ -721,12 +738,12 @@
721738
# management.path_prefix = /a-prefix
722739

723740
## One of 'basic', 'detailed' or 'none'. See
724-
## https://rabbitmq.com/management.html#fine-stats for more details.
741+
## https://www.rabbitmq.com/docs/management#fine-stats for more details.
725742
# management.rates_mode = basic
726743

727744
## Configure how long aggregated data (such as message rates and queue
728745
## lengths) is retained. Please read the plugin's documentation in
729-
## https://rabbitmq.com/management.html#configuration for more
746+
## https://www.rabbitmq.com/docs/management#configuration for more
730747
## details.
731748
## Your can use 'minute', 'hour' and 'day' keys or integer key (in seconds)
732749
# management.sample_retention_policies.global.minute = 5
@@ -741,7 +758,7 @@
741758
## ----------------------------------------------------------------------------
742759
## RabbitMQ Shovel Plugin
743760
##
744-
## Related doc guide: https://rabbitmq.com/shovel.html
761+
## Related doc guide: https://www.rabbitmq.com/docs/shovel
745762
## ----------------------------------------------------------------------------
746763

747764
## See advanced.config.example for a Shovel plugin example
@@ -750,14 +767,14 @@
750767
## ----------------------------------------------------------------------------
751768
## RabbitMQ STOMP Plugin
752769
##
753-
## Related doc guide: https://rabbitmq.com/stomp.html
770+
## Related doc guide: https://www.rabbitmq.com/docs/stomp
754771
## ----------------------------------------------------------------------------
755772

756773
# =======================================
757774
# STOMP section
758775
# =======================================
759776

760-
## See https://rabbitmq.com/stomp.html for details.
777+
## See https://www.rabbitmq.com/docs/stomp for details.
761778

762779
## TCP listeners.
763780
##
@@ -781,7 +798,8 @@
781798
# stomp.proxy_protocol = false
782799

783800
## TLS listeners
784-
## See https://rabbitmq.com/stomp.html and https://rabbitmq.com/ssl.html for details.
801+
№№
802+
## See https://www.rabbitmq.com/docs/stomp and https://www.rabbitmq.com/docs/ssl for details.
785803
# stomp.listeners.ssl.default = 61614
786804
#
787805
# ssl_options.cacertfile = path/to/cacert.pem
@@ -860,7 +878,7 @@
860878
# mqtt.tcp_listen_options.send_timeout = 120000
861879

862880
## TLS listener settings
863-
## ## See https://rabbitmq.com/mqtt.html and https://rabbitmq.com/ssl.html for details.
881+
## ## See https://www.rabbitmq.com/docs/mqtt and https://www.rabbitmq.com/docs/ssl for details.
864882
#
865883
# mqtt.listeners.ssl.default = 8883
866884
#
@@ -956,7 +974,7 @@
956974

957975
## Logging settings.
958976
##
959-
## See https://rabbitmq.com/logging.html for details.
977+
## See https://www.rabbitmq.com/docs/logging for details.
960978
##
961979

962980
## Log directory, taken from the RABBITMQ_LOG_BASE env variable by default.
@@ -1000,7 +1018,7 @@
10001018
## ----------------------------------------------------------------------------
10011019
## RabbitMQ LDAP Plugin
10021020
##
1003-
## Related doc guide: https://rabbitmq.com/ldap.html.
1021+
## Related doc guide: https://www.rabbitmq.com/docs/ldap.
10041022
##
10051023
## ----------------------------------------------------------------------------
10061024

@@ -1134,7 +1152,7 @@
11341152
## The LDAP plugin can perform a variety of queries against your
11351153
## LDAP server to determine questions of authorisation.
11361154
##
1137-
## Related doc guide: https://rabbitmq.com/ldap.html#authorisation.
1155+
## Related doc guide: https://www.rabbitmq.com/docs/ldap#authorisation.
11381156

11391157
## Following configuration should be defined in advanced.config file
11401158
## DO NOT UNCOMMENT THESE LINES!

deps/rabbitmq_cli/test/fixtures/plugins/plugins_with_version_requirements/mock_rabbitmq_plugin_for_3_8-0.1.0/ebin/mock_rabbitmq_plugin_for_3_8.app

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
{applications, [kernel,stdlib,rabbit]},
77
{mod, {mock_rabbitmq_plugins_01_app, []}},
88
{env, []},
9-
{broker_version_requirements, ["3.9.0", "3.10.0", "3.11.0", "3.12.0", "3.13.0"]}
9+
{broker_version_requirements, ["3.9.0", "3.10.0", "3.11.0", "3.12.0", "3.13.0", "4.0.0"]}
1010
]}.

0 commit comments

Comments
 (0)