Skip to content

Commit 2f5d134

Browse files
reebhubreebhub
committed
RDoc-3818 - clarifications about pinned backup task behavior in the FAQ and highly available tasks pages
1 parent 75f3061 commit 2f5d134

8 files changed

Lines changed: 148 additions & 32 deletions

File tree

‎docs/backup/faq.mdx‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -162,19 +162,31 @@ to another database-group member.
162162
The grace period gives the original node a chance to recover,
163163
and prevents the same backup from running on two nodes at once.
164164

165-
When you create a backup task, you can pick the responsible node yourself,
166-
or leave it for the cluster to decide.
167-
The choice (yours or the cluster's) is persisted cluster-wide,
168-
so all nodes agree on a single responsible node for the task.
165+
* **Who picks the responsible node:**
166+
When you create a backup task, you can pick the responsible node yourself,
167+
or leave it for the cluster to decide.
168+
The choice (yours or the cluster's) is persisted cluster-wide,
169+
so all nodes agree on a single responsible node for the task.
169170

170-
If the current responsible node is in Rehab due to resource constraints on the host machine,
171-
the cluster observer will leave the backup task on the same node rather than reassign it.
172-
The backup will run on that node once it recovers,
173-
or be reassigned to another node if this one is eventually removed from the database group.
171+
* **If the node is in Rehab due to resource constraints on the host machine:**
172+
The cluster observer will leave the backup task on the same node rather than reassign it.
173+
The backup will run on that node once it recovers,
174+
or be reassigned to another node if this one is eventually removed from the database group.
174175

175176
The grace period is configurable via
176177
[Backup.MoveToNewResponsibleNodeGracePeriodInMin](../backup/configuration#backupmovetonewresponsiblenodegraceperiodinmin).
177178

179+
<Admonition type="note" title="">
180+
181+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
182+
is an exception to the behavior described above.
183+
A pinned task is not subject to the grace period.
184+
It stays on its node even while the node is in Rehab,
185+
and only moves to another node when its pinned node is removed from the database group.
186+
See [Pinning a Task](../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) for the full behavior.
187+
188+
</Admonition>
189+
178190
</ContentFrame>
179191

180192
<ContentFrame>

‎docs/server/clustering/distribution/highly-available-tasks.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,17 @@ The grace period is set by
104104

105105
</Admonition>
106106

107+
<Admonition type="note" title="">
108+
109+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
110+
is an exception to all of the above.
111+
A pinned task is not subject to the grace period.
112+
It stays on its node even while the node is in Rehab,
113+
and only moves when its pinned node is removed from the database group.
114+
See [Pinning a Task](#pinning-a-task) below for the full behavior.
115+
116+
</Admonition>
117+
107118

108119

109120
## Tasks Relocation
@@ -152,6 +163,12 @@ The failover of a task to another responsible node can be prevented by **pinning
152163
[cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec),
153164
the cluster observer will attempt to select an available node to replace it in the database group
154165
and redistribute the fallen node's tasks, including pinned ones, among database group members.
166+
* A pinned **backup task** is also not subject to the
167+
[grace period](../../../backup/configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin)
168+
that the cluster observer otherwise applies before reassigning a backup task.
169+
The pinned backup stays on its node even while the node is in Rehab,
170+
and only moves when the cluster eventually replaces the node as described above.
171+
155172
A task can be pinned to a selected node via Studio or using code.
156173

157174
#### Pinning via Studio

‎versioned_docs/version-6.2/client-api/operations/maintenance/backup/faq.mdx‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,30 @@ to another database-group member.
120120
The grace period gives the original node a chance to recover,
121121
and prevents the same backup from running on two nodes at once.
122122

123-
When you create a backup task, you can pick the responsible node yourself,
124-
or leave it for the cluster to decide.
125-
The choice (yours or the cluster's) is persisted cluster-wide,
126-
so all nodes agree on a single responsible node for the task.
123+
* **Who picks the responsible node:**
124+
When you create a backup task, you can pick the responsible node yourself,
125+
or leave it for the cluster to decide.
126+
The choice (yours or the cluster's) is persisted cluster-wide,
127+
so all nodes agree on a single responsible node for the task.
127128

128-
If the current responsible node is in Rehab due to resource constraints on the host machine,
129-
the cluster observer will leave the backup task on the same node rather than reassign it.
130-
The backup will run on that node once it recovers,
131-
or be reassigned to another node if this one is eventually removed from the database group.
129+
* **If the node is in Rehab due to resource constraints on the host machine:**
130+
The cluster observer will leave the backup task on the same node rather than reassign it.
131+
The backup will run on that node once it recovers,
132+
or be reassigned to another node if this one is eventually removed from the database group.
132133

133134
The grace period is configurable via
134135
[Backup.MoveToNewResponsibleNodeGracePeriodInMin](../../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin).
135136

137+
<Admonition type="note" title="">
138+
139+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
140+
is an exception to the behavior described above.
141+
A pinned task is not subject to the grace period.
142+
It stays on its node even while the node is in Rehab,
143+
and only moves to another node when its pinned node is removed from the database group.
144+
See [Pinning a Task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) for the full behavior.
145+
146+
</Admonition>
147+
136148

137149

‎versioned_docs/version-6.2/server/clustering/distribution/highly-available-tasks.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ The grace period is set by
103103

104104
</Admonition>
105105

106+
<Admonition type="note" title="">
107+
108+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
109+
is an exception to all of the above.
110+
A pinned task is not subject to the grace period.
111+
It stays on its node even while the node is in Rehab,
112+
and only moves when its pinned node is removed from the database group.
113+
See [Pinning a Task](#pinning-a-task) below for the full behavior.
114+
115+
</Admonition>
116+
106117

107118

108119
## Tasks Relocation
@@ -151,6 +162,12 @@ The failover of a task to another responsible node can be prevented by **pinning
151162
[cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec),
152163
the cluster observer will attempt to select an available node to replace it in the database group
153164
and redistribute the fallen node's tasks, including pinned ones, among database group members.
165+
* A pinned **backup task** is also not subject to the
166+
[grace period](../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin)
167+
that the cluster observer otherwise applies before reassigning a backup task.
168+
The pinned backup stays on its node even while the node is in Rehab,
169+
and only moves when the cluster eventually replaces the node as described above.
170+
154171
A task can be pinned to a selected node via Studio or using code.
155172

156173
#### Pinning via Studio

‎versioned_docs/version-7.0/client-api/operations/maintenance/backup/faq.mdx‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,30 @@ to another database-group member.
120120
The grace period gives the original node a chance to recover,
121121
and prevents the same backup from running on two nodes at once.
122122

123-
When you create a backup task, you can pick the responsible node yourself,
124-
or leave it for the cluster to decide.
125-
The choice (yours or the cluster's) is persisted cluster-wide,
126-
so all nodes agree on a single responsible node for the task.
123+
* **Who picks the responsible node:**
124+
When you create a backup task, you can pick the responsible node yourself,
125+
or leave it for the cluster to decide.
126+
The choice (yours or the cluster's) is persisted cluster-wide,
127+
so all nodes agree on a single responsible node for the task.
127128

128-
If the current responsible node is in Rehab due to resource constraints on the host machine,
129-
the cluster observer will leave the backup task on the same node rather than reassign it.
130-
The backup will run on that node once it recovers,
131-
or be reassigned to another node if this one is eventually removed from the database group.
129+
* **If the node is in Rehab due to resource constraints on the host machine:**
130+
The cluster observer will leave the backup task on the same node rather than reassign it.
131+
The backup will run on that node once it recovers,
132+
or be reassigned to another node if this one is eventually removed from the database group.
132133

133134
The grace period is configurable via
134135
[Backup.MoveToNewResponsibleNodeGracePeriodInMin](../../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin).
135136

137+
<Admonition type="note" title="">
138+
139+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
140+
is an exception to the behavior described above.
141+
A pinned task is not subject to the grace period.
142+
It stays on its node even while the node is in Rehab,
143+
and only moves to another node when its pinned node is removed from the database group.
144+
See [Pinning a Task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) for the full behavior.
145+
146+
</Admonition>
147+
136148

137149

‎versioned_docs/version-7.0/server/clustering/distribution/highly-available-tasks.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ The grace period is set by
103103

104104
</Admonition>
105105

106+
<Admonition type="note" title="">
107+
108+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
109+
is an exception to all of the above.
110+
A pinned task is not subject to the grace period.
111+
It stays on its node even while the node is in Rehab,
112+
and only moves when its pinned node is removed from the database group.
113+
See [Pinning a Task](#pinning-a-task) below for the full behavior.
114+
115+
</Admonition>
116+
106117

107118

108119
## Tasks Relocation
@@ -151,6 +162,12 @@ The failover of a task to another responsible node can be prevented by **pinning
151162
[cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec),
152163
the cluster observer will attempt to select an available node to replace it in the database group
153164
and redistribute the fallen node's tasks, including pinned ones, among database group members.
165+
* A pinned **backup task** is also not subject to the
166+
[grace period](../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin)
167+
that the cluster observer otherwise applies before reassigning a backup task.
168+
The pinned backup stays on its node even while the node is in Rehab,
169+
and only moves when the cluster eventually replaces the node as described above.
170+
154171
A task can be pinned to a selected node via Studio or using code.
155172

156173
#### Pinning via Studio

‎versioned_docs/version-7.1/client-api/operations/maintenance/backup/faq.mdx‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,30 @@ to another database-group member.
120120
The grace period gives the original node a chance to recover,
121121
and prevents the same backup from running on two nodes at once.
122122

123-
When you create a backup task, you can pick the responsible node yourself,
124-
or leave it for the cluster to decide.
125-
The choice (yours or the cluster's) is persisted cluster-wide,
126-
so all nodes agree on a single responsible node for the task.
123+
* **Who picks the responsible node:**
124+
When you create a backup task, you can pick the responsible node yourself,
125+
or leave it for the cluster to decide.
126+
The choice (yours or the cluster's) is persisted cluster-wide,
127+
so all nodes agree on a single responsible node for the task.
127128

128-
If the current responsible node is in Rehab due to resource constraints on the host machine,
129-
the cluster observer will leave the backup task on the same node rather than reassign it.
130-
The backup will run on that node once it recovers,
131-
or be reassigned to another node if this one is eventually removed from the database group.
129+
* **If the node is in Rehab due to resource constraints on the host machine:**
130+
The cluster observer will leave the backup task on the same node rather than reassign it.
131+
The backup will run on that node once it recovers,
132+
or be reassigned to another node if this one is eventually removed from the database group.
132133

133134
The grace period is configurable via
134135
[Backup.MoveToNewResponsibleNodeGracePeriodInMin](../../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin).
135136

137+
<Admonition type="note" title="">
138+
139+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
140+
is an exception to the behavior described above.
141+
A pinned task is not subject to the grace period.
142+
It stays on its node even while the node is in Rehab,
143+
and only moves to another node when its pinned node is removed from the database group.
144+
See [Pinning a Task](../../../../server/clustering/distribution/highly-available-tasks.mdx#pinning-a-task) for the full behavior.
145+
146+
</Admonition>
147+
136148

137149

‎versioned_docs/version-7.1/server/clustering/distribution/highly-available-tasks.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ The grace period is set by
103103

104104
</Admonition>
105105

106+
<Admonition type="note" title="">
107+
108+
A backup task that is **pinned** to its mentor node (via `PinToMentorNode`)
109+
is an exception to all of the above.
110+
A pinned task is not subject to the grace period.
111+
It stays on its node even while the node is in Rehab,
112+
and only moves when its pinned node is removed from the database group.
113+
See [Pinning a Task](#pinning-a-task) below for the full behavior.
114+
115+
</Admonition>
116+
106117

107118

108119
## Tasks Relocation
@@ -151,6 +162,12 @@ The failover of a task to another responsible node can be prevented by **pinning
151162
[cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec),
152163
the cluster observer will attempt to select an available node to replace it in the database group
153164
and redistribute the fallen node's tasks, including pinned ones, among database group members.
165+
* A pinned **backup task** is also not subject to the
166+
[grace period](../../../server/configuration/backup-configuration.mdx#backupmovetonewresponsiblenodegraceperiodinmin)
167+
that the cluster observer otherwise applies before reassigning a backup task.
168+
The pinned backup stays on its node even while the node is in Rehab,
169+
and only moves when the cluster eventually replaces the node as described above.
170+
154171
A task can be pinned to a selected node via Studio or using code.
155172

156173
#### Pinning via Studio

0 commit comments

Comments
 (0)