Skip to content

Commit

Permalink
Fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville committed Nov 12, 2024
1 parent 431c8f3 commit fdf7e2e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 16 deletions.
11 changes: 2 additions & 9 deletions src/current/v24.3/decommission-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: manage
---

This page shows how to decommission a node and permanently remove it from your cluster. To temporarily shut down a node for maintenance instead, refer to [Drain a node]({% link {{ page.version.version }}/drain-a-node.md %}). For details about how decommissioning and draining work, refer to [Node shutdown]({% link {{ page.version.version }}/node-shutdown.md %}).
This page shows how to decommission a node and permanently remove it from your cluster. To temporarily shut down a node for maintenance instead, refer to [Drain a node]({% link {{ page.version.version }}/drain-a-node.md %}). For details about how decommissioning and draining work, refer to [Node Shutdown Overview]({% link {{ page.version.version }}/node-shutdown.md %}).

## Prepare to decommission a node

Expand Down Expand Up @@ -59,7 +59,7 @@ Follow these steps to decommission a node and remove it from your cluster.
This guidance applies to manual deployments. In a Kubernetes deployment or a CockroachDB {{ site.data.products.advanced }} cluster, terminating the `cockroach` process is handled through Kubernetes. Refer to [Decommissioning on Kubernetes](#decommissioning-on-kubernetes) and [Decommissioning on CockroachDB {{ site.data.products.advanced }}](#decommissioning-on-cockroachdb-advanced).
{{site.data.alerts.end}}

1. Manually [drain the node]({% link {{ page.version.version }}/drain-the-node %}). When you decommission a node, it is drained automatically. However, we recommend first running [`cockroach node drain`]({% link {{ page.version.version }}/cockroach-node.md %}) to manually drain the node of active queries, SQL client connections, and leases to prevent possible disruptions in query performance.
1. Manually [drain the node]({% link {{ page.version.version }}/drain-a-node.md %}). When you decommission a node, it is drained automatically. However, we recommend first running [`cockroach node drain`]({% link {{ page.version.version }}/cockroach-node.md %}) to manually drain the node of active queries, SQL client connections, and leases to prevent possible disruptions in query performance.
1. Run [`cockroach node decommission`]({% link {{ page.version.version }}/cockroach-node.md %}) to decommission the node and rebalance its range replicas. For specific instructions and additional guidelines, see the [example](#remove-nodes).

If the rebalancing stalls during decommissioning, replicas that have yet to move are printed to the [SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and written to the [`OPS` logging channel]({% link {{ page.version.version }}/logging-overview.md %}#logging-channels) with the message `possible decommission stall detected`. [By default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration), the `OPS` channel logs output to a `cockroach.log` file.
Expand Down Expand Up @@ -118,13 +118,6 @@ These examples assume that you have already prepared for a [graceful node shutdo

### Remove nodes

- [Prerequisites](#prerequisites)
- [Step 1. Get the IDs of the nodes to decommission](#step-1-get-the-ids-of-the-nodes-to-decommission)
- [Step 2. Drain the nodes manually](#step-2-drain-the-nodes-manually)
- [Step 3. Decommission the nodes](#step-3-decommission-the-nodes)
- [Step 4. Confirm the nodes are decommissioned](#step-4-confirm-the-nodes-are-decommissioned)
- [Step 5. Terminate the process on decommissioned nodes](#step-5-terminate-the-process-on-decommissioned-nodes)

#### Prerequisites

In addition to the [graceful node shutdown](#prepare-for-graceful-shutdown) requirements, observe the following guidelines:
Expand Down
12 changes: 5 additions & 7 deletions src/current/v24.3/node-shutdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ For detailed instructions, refer to:
- [Drain a node]({% link {{ page.version.version }}/drain-a-node.md %})
- [Decommission a node]({% link {{ page.version.version }}/decommission-a-node.md %})

{% comment %}
- How to [perform node shutdown](#perform-node-shutdown) on CockroachDB {{ site.data.products.core }} deployments by manually draining or decommissioning a node.
- How to handle node shutdown when CockroachDB is deployed using [Kubernetes](#decommissioning-and-draining-on-kubernetes) or in a [CockroachDB {{ site.data.products.advanced }} cluster](#decommissioning-and-draining-on-cockroachdb-advanced).
{% endcomment %}

{{site.data.alerts.callout_success}}
This guidance applies to primarily to manual deployments. For more details about graceful termination when CockroachDB is deployed using Kubernetes, refer to [Decommissioning and draining on Kubernetes](#decommissioning-and-draining-on-kubernetes). For more details about graceful termination in a CockroachDB {{ site.data.products.advanced }} cluster, refer to [Decommissioning and draining on CockroachDB {{ site.data.products.advanced }}](#decommissioning-and-draining-on-cockroachdb-advanced).
This guidance applies to primarily to manual deployments.

- For more details about node shutdown on Kubernetes, refer to [Draining on Kubernetes]({% link {{ page.version.version }}/drain-a-node.md %}#draining-on-kubernetes) and [Decommissioning on Kubernetes]({% link {{ page.version.version }}/decommission-a-node.md %}#decommissioning-on-kubernetes).
- For more details about node shutdown in CockroachDB {{ site.data.products.advanced }} cluster, refer to [Draining on CockroachDB {{ site.data.products.advanced }}]({% link {{ page.version.version }}/drain-a-node.md %}#draining-on-cockroachdb-advanced) and [Decommissioning on CockroachDB {{ site.data.products.advanced }}]({% link {{ page.version.version }}/decommission-a-node.md %}#decommissioning-on-cockroachdb-advanced).
{{site.data.alerts.end}}

## Draining a node
Expand Down Expand Up @@ -84,7 +82,7 @@ After draining is complete:

When a node is permanently removed, the following stages occur in sequence:

1. An operator [initiates the decommissioning process]({% link decommission-a-node.md %}) on the node.
1. An operator [initiates the decommissioning process]({% link {{ page.version.version }}/decommission-a-node.md %}) on the node.

The node's [`is_decommissioning`]({% link {{ page.version.version }}/cockroach-node.md %}#node-status) field is set to `true` and its `membership` status is set to `decommissioning`, which causes its replicas to be rebalanced to other nodes. If the rebalancing stalls during decommissioning, replicas that have yet to move are printed to the [SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and written to the [`OPS` logging channel]({% link {{ page.version.version }}/logging-overview.md %}#logging-channels). [By default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration), the `OPS` channel logs output to a `cockroach.log` file.

Expand Down

0 comments on commit fdf7e2e

Please sign in to comment.