Skip to content

Commit 0230455

Browse files
michaelklishinmichaelklishin
committed
Document cluster and node tags
1 parent e056008 commit 0230455

File tree

6 files changed

+561
-3
lines changed

6 files changed

+561
-3
lines changed

‎docs/configure.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ See the License for the specific language governing permissions and
1818
limitations under the License.
1919
-->
2020

21+
import Tabs from '@theme/Tabs';
22+
import TabItem from '@theme/TabItem';
23+
2124
import {
2225
RabbitMQServerVersion,
2326
} from '@site/src/components/RabbitMQServer';
@@ -1489,6 +1492,115 @@ dedicated documentation guides that cover plugin configuration:
14891492
* [rabbitmq_auth_backend_oauth](./oauth2#variables-configurable)
14901493

14911494

1495+
## Cluster and Node Metadata
1496+
1497+
### Cluster Name
1498+
1499+
By default, cluster name is set to the name of the first node in the cluster.
1500+
1501+
It can be overridden via `rabbitmq.conf`:
1502+
1503+
```ini
1504+
cluster_name = americas.ca.1
1505+
```
1506+
1507+
RabbitMQ displays this value in the [management UI](./management).
1508+
1509+
It can also be inspected by [listing global runtime parameters](./parameters)
1510+
and the `GET /api/global-parameters/cluster_name` [HTTP API endpoint](./http-api-reference).
1511+
1512+
### Cluster Tags
1513+
1514+
Cluster tags are arbitrary key-value pairs that describe a cluster. They can be used by
1515+
operators to attach deployment-specific information.
1516+
1517+
Cluster tags can be configured using `rabbitmq.conf`:
1518+
1519+
```ini
1520+
node_tags.series = 4.1.x
1521+
1522+
cluster_tags.purpose = iot_ingress
1523+
cluster_tags.region = ca-central-1
1524+
cluster_tags.environment = production
1525+
```
1526+
1527+
To retrieve a list of tags, list [global runtime parameters](./parameters) or fetch a global runtime parameter
1528+
named `cluster_tags`, or use [`rabbitmqadmin` v2](./management-cli)'s `snow overview`command.
1529+
1530+
<Tabs groupId="examples">
1531+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2" default>
1532+
```bash
1533+
rabbitmqadmin show overview
1534+
```
1535+
</TabItem>
1536+
1537+
<TabItem value="bash" label="bash">
1538+
```bash
1539+
# lists global (virtual-host-independent) runtime parameters
1540+
rabbitmqctl list_global_parameters
1541+
```
1542+
</TabItem>
1543+
1544+
<TabItem value="PowerShell" label="PowerShell">
1545+
```PowerShell
1546+
# lists global (virtual-host-independent) runtime parameters
1547+
rabbitmqctl.bat list_global_parameters
1548+
```
1549+
</TabItem>
1550+
1551+
<TabItem value="HTTP API" label="HTTP API">
1552+
```ini
1553+
GET /api/global-parameters
1554+
1555+
GET /api/global-parameters/cluster_tags
1556+
```
1557+
</TabItem>
1558+
</Tabs>
1559+
1560+
1561+
### Node Tags
1562+
1563+
Node tags
1564+
1565+
Similarly to cluster tags, node tags can be preconfigured via `rabbitmq.conf`:
1566+
1567+
```ini
1568+
node_tags.series = 4.1.x
1569+
1570+
node_tags.purpose = iot_ingress
1571+
node_tags.region = ca-central-1
1572+
node_tags.environment = production
1573+
```
1574+
1575+
Node tags can be inspected using CLI tools and the [HTTP API](./http-api-reference).
1576+
1577+
<Tabs groupId="examples">
1578+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2" default>
1579+
```bash
1580+
rabbitmqadmin show overview
1581+
```
1582+
</TabItem>
1583+
1584+
<TabItem value="bash" label="bash">
1585+
```bash
1586+
rabbitmq-diagnostics status
1587+
```
1588+
</TabItem>
1589+
1590+
<TabItem value="PowerShell" label="PowerShell">
1591+
```PowerShell
1592+
rabbitmq-diagnostics.bat status
1593+
```
1594+
</TabItem>
1595+
1596+
<TabItem value="HTTP API" label="HTTP API">
1597+
```ini
1598+
GET /api/overview
1599+
```
1600+
</TabItem>
1601+
</Tabs>
1602+
1603+
14921604
## Configuration Value Encryption {#configuration-encryption}
14931605

14941606
Sensitive `advanced.config` entries (e.g. password, URL containing

‎docs/parameters.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,79 @@ definitions by the management plugin's export feature.
160160
Virtual-scoped parameters are used by the federation and shovel plugins.
161161

162162
Global parameters are used to store various cluster-level metadata,
163-
for example
163+
for example, cluster name, cluster tags, as well as internal
164+
node metada such as imported [definitions](./definitions) hash.
165+
166+
167+
### Cluster Name
168+
169+
Cluster name stored using global runtime parameters. It can be
170+
updated using a dedicated CLI command.
171+
172+
<Tabs groupId="examples">
173+
<TabItem value="bash" label="bash" default>
174+
```bash
175+
rabbitmqctl set_cluster_name rabbit@id-3942837
176+
```
177+
</TabItem>
178+
179+
<TabItem value="PowerShell" label="PowerShell">
180+
```PowerShell
181+
rabbitmqctl.bat set_cluster_name rabbit@id-3942837
182+
```
183+
</TabItem>
184+
</Tabs>
185+
186+
187+
### Cluster Tags
188+
189+
Cluster tags are arbitrary key-value pairs that describe a cluster. They can be used by
190+
operators to attach deployment-specific information.
191+
192+
Cluster tags are stored in a global parameter named `cluster_tags`.
193+
They can also be preconfigured using `rabbitmq.conf`:
194+
195+
```ini
196+
node_tags.series = 4.1.x
197+
198+
cluster_tags.purpose = iot_ingress
199+
cluster_tags.region = ca-central-1
200+
cluster_tags.environment = production
201+
```
202+
203+
To retrieve a list of tags, list global runtime parametersor fetch a global runtime parameter
204+
named `cluster_tags`, or use [`rabbitmqadmin` v2](./management-cli)'s `snow overview`command.
205+
206+
<Tabs groupId="examples">
207+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2" default>
208+
```bash
209+
rabbitmqadmin show overview
210+
```
211+
</TabItem>
212+
213+
<TabItem value="bash" label="bash">
214+
```bash
215+
# lists global (virtual-host-independent) runtime parameters
216+
rabbitmqctl list_global_parameters
217+
```
218+
</TabItem>
219+
220+
<TabItem value="PowerShell" label="PowerShell">
221+
```PowerShell
222+
# lists global (virtual-host-independent) runtime parameters
223+
rabbitmqctl.bat list_global_parameters
224+
```
225+
</TabItem>
226+
227+
<TabItem value="HTTP API" label="HTTP API">
228+
```ini
229+
GET /api/global-parameters
230+
231+
GET /api/global-parameters/cluster_tags
232+
```
233+
</TabItem>
234+
</Tabs>
235+
164236

165237
## Policies
166238

‎versioned_docs/version-4.0/configure.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ See the License for the specific language governing permissions and
1818
limitations under the License.
1919
-->
2020

21+
import Tabs from '@theme/Tabs';
22+
import TabItem from '@theme/TabItem';
23+
2124
import {
2225
RabbitMQServerVersion,
2326
} from '@site/src/components/RabbitMQServer';
@@ -1489,6 +1492,115 @@ dedicated documentation guides that cover plugin configuration:
14891492
* [rabbitmq_auth_backend_oauth](./oauth2#variables-configurable)
14901493

14911494

1495+
## Cluster and Node Metadata
1496+
1497+
### Cluster Name
1498+
1499+
By default, cluster name is set to the name of the first node in the cluster.
1500+
1501+
It can be overridden via `rabbitmq.conf`:
1502+
1503+
```ini
1504+
cluster_name = americas.ca.1
1505+
```
1506+
1507+
RabbitMQ displays this value in the [management UI](./management).
1508+
1509+
It can also be inspected by [listing global runtime parameters](./parameters)
1510+
and the `GET /api/global-parameters/cluster_name` [HTTP API endpoint](./http-api-reference).
1511+
1512+
### Cluster Tags
1513+
1514+
Cluster tags are arbitrary key-value pairs that describe a cluster. They can be used by
1515+
operators to attach deployment-specific information.
1516+
1517+
Cluster tags can be configured using `rabbitmq.conf`:
1518+
1519+
```ini
1520+
node_tags.series = 4.1.x
1521+
1522+
cluster_tags.purpose = iot_ingress
1523+
cluster_tags.region = ca-central-1
1524+
cluster_tags.environment = production
1525+
```
1526+
1527+
To retrieve a list of tags, list [global runtime parameters](./parameters) or fetch a global runtime parameter
1528+
named `cluster_tags`, or use [`rabbitmqadmin` v2](./management-cli)'s `snow overview`command.
1529+
1530+
<Tabs groupId="examples">
1531+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2" default>
1532+
```bash
1533+
rabbitmqadmin show overview
1534+
```
1535+
</TabItem>
1536+
1537+
<TabItem value="bash" label="bash">
1538+
```bash
1539+
# lists global (virtual-host-independent) runtime parameters
1540+
rabbitmqctl list_global_parameters
1541+
```
1542+
</TabItem>
1543+
1544+
<TabItem value="PowerShell" label="PowerShell">
1545+
```PowerShell
1546+
# lists global (virtual-host-independent) runtime parameters
1547+
rabbitmqctl.bat list_global_parameters
1548+
```
1549+
</TabItem>
1550+
1551+
<TabItem value="HTTP API" label="HTTP API">
1552+
```ini
1553+
GET /api/global-parameters
1554+
1555+
GET /api/global-parameters/cluster_tags
1556+
```
1557+
</TabItem>
1558+
</Tabs>
1559+
1560+
1561+
### Node Tags
1562+
1563+
Node tags
1564+
1565+
Similarly to cluster tags, node tags can be preconfigured via `rabbitmq.conf`:
1566+
1567+
```ini
1568+
node_tags.series = 4.1.x
1569+
1570+
node_tags.purpose = iot_ingress
1571+
node_tags.region = ca-central-1
1572+
node_tags.environment = production
1573+
```
1574+
1575+
Node tags can be inspected using CLI tools and the [HTTP API](./http-api-reference).
1576+
1577+
<Tabs groupId="examples">
1578+
<TabItem value="rabbitmqadmin" label="rabbitmqadmin v2" default>
1579+
```bash
1580+
rabbitmqadmin show overview
1581+
```
1582+
</TabItem>
1583+
1584+
<TabItem value="bash" label="bash">
1585+
```bash
1586+
rabbitmq-diagnostics status
1587+
```
1588+
</TabItem>
1589+
1590+
<TabItem value="PowerShell" label="PowerShell">
1591+
```PowerShell
1592+
rabbitmq-diagnostics.bat status
1593+
```
1594+
</TabItem>
1595+
1596+
<TabItem value="HTTP API" label="HTTP API">
1597+
```ini
1598+
GET /api/overview
1599+
```
1600+
</TabItem>
1601+
</Tabs>
1602+
1603+
14921604
## Configuration Value Encryption {#configuration-encryption}
14931605

14941606
Sensitive `advanced.config` entries (e.g. password, URL containing

0 commit comments

Comments
 (0)