Clarify difference between global/vhost parameters

rabbitmq · Dec 14, 2016 · 376eca0 · michaelklishin · Dec 14, 2016 · 376eca0
1 parent 92bfb96
commit 376eca0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/site/mqtt.md b/site/mqtt.md
@@ -215,7 +215,7 @@ Note that:
 * If the virtual host for a certificate cannot be found (because the certificate
 subject's DN cannot be found in the `mqtt_default_vhosts` global parameter JSON
 document or if the global parameter isn't set at all), the virtual host specified
-by the `vhost` option will be used.
+by the `vhost` plugin config option will be used.
 * The broker queries the `mqtt_default_vhosts` global parameter value at connection time.
 If the value changes, connected clients are not notified or disconnected. They need
 to reconnect to switch to a new virtual host.

diff --git a/site/parameters.xml b/site/parameters.xml
@@ -44,11 +44,16 @@ limitations under the License.
       invoking <a href="man/rabbitmqctl.1.man.html"><code>rabbitmqctl</code></a>
       or through <a href="management.html">the management plugin</a>'s HTTP API.
       There are 2 kinds of parameters: vhost-scoped parameters and global parameters.
+      Vhost-scoped parameters are tied to a virtual host and consist
+      of a component name, a name and a value. The complete key of a vhost-scoped
+      parameter is then the triplet <code>{vhost, component, name}</code>.
+      Global parameters are not tied to a particular virtual and they consist
+      of a name and value. The key of a global parameter is just its name.
     </p>
     <p>
       One special case of parameters usage is policies, which are used for specifying
       optional arguments for groups of queues and exchanges, as well as plugins such
-      as Federation and Shovel.
+      as Federation and Shovel. Policies are vhost-scoped.
     </p>
   </doc:section>