Add dynamic rooms docs (#19199)
* Add dynamic rooms docs * fix typos, structure and wrong snippet * simplify --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> Co-authored-by: ilyam8 <ilya@netdata.cloud>
John Kapantzakis committed
Dec 16, 2024 at 12:41 UTC
75b38d50a37d6235a543624123f78752e0e664ec
1 file changed
+69
docs/netdata-cloud/node-membership-rules.md
new
+69
@@ -0,0 +1,69 @@
1
+# Node Membership Rules
2
+
3
+Node Membership Rules automate Node organization within Rooms based on host labels. This simplifies infrastructure management by dynamically assigning Nodes to appropriate Rooms, eliminating manual intervention.
4
+
5
+**Important**:
6
+
7
+- Rules work with all Rooms except the "All Nodes" Room, as it includes all Nodes by default.
8
+- Creating and editing Rules requires Node management permissions.
9
+- Rules are evaluated in real-time as labels change.
10
+- Exclusion rules always override inclusion rules.
11
+
12
+## Rule Structure
13
+
14
+The rules consist of the following elements:
15
+
16
+| Element | Description |
17
+|:--------|:--------------------------------------------------------------------------------------------------|
18
+| Action | Determines whether matching Nodes will be included or excluded from the Room |
19
+| Clauses | Set of conditions that determine which Nodes match the Rule (all must be satisfied - logical AND) |
20
+
21
+Each clause consists of:
22
+
23
+| Element | Description |
24
+|:---------|:-----------------------------|
25
+| Label | The host label to check |
26
+| Value | The comparison method |
27
+| Operator | The value to compare against |
28
+
29
+Below is a conceptual representation of a rule that includes all production database Nodes. The structure is shown in YAML format for clarity:
30
+
31
+```yaml
32
+Action: Include
33
+Clauses:
34
+ - Label: environment
35
+ Operator: equals
36
+ Value: production
37
+ - Label: service-type
38
+ Operator: equals
39
+ Value: database
40
+```
41
+
42
+## Rule Evaluation Order
43
+
44
+- Inclusion rules are checked first
45
+- Exclusion rules are checked second
46
+ If both match, exclusion wins
47
+
48
+## Creating Rules
49
+
50
+1. Access Settings
51
+ - Click ⚙️ (Room settings)
52
+ - Select "Nodes" tab
53
+2. Create Rule
54
+ - Click "Add new Rule"
55
+ - Select Action (Include/Exclude)
56
+ - Add clause(s)
57
+ - Save changes
58
+
59
+## Membership Status
60
+
61
+Nodes can have multiple membership types in a Room:
62
+
63
+| Status | Description |
64
+|:----------------|:---------------------------|
65
+| STATIC | Manually added to the Room |
66
+| RULE | Added by matching Rule(s) |
67
+| STATIC and RULE | Both manual and Rule-based |
68
+
69
+You can view each Node's membership status in the Room's Nodes table under the "Membership" column.