HCP Consul Dedicated restore migration steps #1298
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
boruszak
requested review from
danielehc and
judithpatudith
and removed request for
judithpatudith
aimeeu
left a comment
aimeeu
left a comment
There was a problem hiding this comment.
Some nit-picky suggestions and...
Issues with links to HCP Consul docs that no longer exist in production... and you'll have circular redirects based on the new entries in redirects.jsonc.
The other thing is you may want to revise the workflows since users no longer have access to HCP Consul at all. They literally cannot create a snapshot of the HCP Consul Dedicated cluster. Suggest refactor to use existing snapshot or contact Support to get an archived snapshot. Plus remove the message about "As of November 12..."
|
|
||
| ## Migration workflows | ||
|
|
||
| The process to migrate a Dedicated cluster to a self-managed environment consists of the following steps, which change depending on whether your cluster runs on virtual machines (VMs) or Kubernetes. |
There was a problem hiding this comment.
| The process to migrate a Dedicated cluster to a self-managed environment consists of the following steps, which change depending on whether your cluster runs on virtual machines (VMs) or Kubernetes. | |
| The process to migrate a Dedicated cluster to a self-managed environment consists of steps that depend on whether your cluster runs on virtual machines (VMs) or Kubernetes. |
Suggested wording change based solely on my personal annoyance: using "following steps" and then no immediate list, instead going directly into headings.
| The process to migrate a Dedicated cluster to a self-managed environment consists of the following steps, which change depending on whether your cluster runs on virtual machines (VMs) or Kubernetes. | ||
|
|
||
| ### VMs | ||
|
|
There was a problem hiding this comment.
Love the steps with direct links!
|
|
||
| ## Migrate to self-managed on VMs | ||
|
|
||
| To migrate to a self-managed Consul Enterprise cluster on VMs, [connect to the Dedicated cluster's current leader node](/hcp/docs/consul/dedicated/access) and then complete the following steps. |
There was a problem hiding this comment.
/hcp/docs/consul/dedicated/access
In the PR, the link just reloads this /consul/docs/hcp page.
-> in production, this redirects to https://developer.hashicorp.com/hcp/docs/changelog#2025-11-12
| - Both clusters have 3 nodes. | ||
| - ACLs, TLS, and gossip encryption are enabled. | ||
| - You have command line access to both the Dedicated cluster and your self-managed cluster. | ||
| - You [generated an admin token for the Dedicated cluster](/hcp/docs/consul/dedicated/access#generate-admin-token) and exported it to the `CONSUL_HTTP_TOKEN` environment variable. Alternatively, add the `-token=` flag to CLI commands. |
There was a problem hiding this comment.
HCP Consul docs are gone in production. The link redirects to https://developer.hashicorp.com/hcp/docs/changelog#2025-11-12. "For questions about your account and data, or for help migrating to a self-managed Consul deployment, contact our support team."
In the PR deploy preview, the link just reloads the current page.
|
|
||
| ## Migrate to self-managed on Kubernetes | ||
|
|
||
| To migrate to a self-managed Consul Enterprise cluster on Kubernetes, [connect to the Dedicated cluster's current leader node](/hcp/docs/consul/dedicated/access) and then complete the following steps. |
There was a problem hiding this comment.
Same problem with the HCP Consul docs no longer in production. This link redirects to https://developer.hashicorp.com/hcp/docs/changelog#2025-11-12
| - [https://letsencrypt.org/certs/2024/r11.pem](https://letsencrypt.org/certs/2024/r11.pem) | ||
| - Update the `tlsServerName` field to the appropriate value. It is usually the hostname of the | ||
| managed cluster. If the value is not known, TLS verification fails when you apply this configuration and the error log lists possible values. | ||
| - Set `useSystemRoots` to `false` to use the new CA certs. |
There was a problem hiding this comment.
I would prefer to see the dot notation here so I know what collection. But maybe that's not needed for experienced users.
| - Set `useSystemRoots` to `false` to use the new CA certs. | |
| - Set `externalServes.useSystemRoots` to `false` to use the new CA certs. |
| - [https://letsencrypt.org/certs/2024/e6-cross.pem](https://letsencrypt.org/certs/2024/e6-cross.pem) | ||
| - [https://letsencrypt.org/certs/2024/r10.pem](https://letsencrypt.org/certs/2024/r10.pem) | ||
| - [https://letsencrypt.org/certs/2024/r11.pem](https://letsencrypt.org/certs/2024/r11.pem) | ||
| - Update the `tlsServerName` field to the appropriate value. It is usually the hostname of the |
There was a problem hiding this comment.
| - Update the `tlsServerName` field to the appropriate value. It is usually the hostname of the | |
| - Update the `externalServers.tlsServerName` field to the appropriate value. It is usually the hostname of the |
I would prefer to see the dot notation here so I know what collection. But maybe that's not needed for experienced users.
|
|
||
| ### Upgrade the cluster | ||
|
|
||
| After you update the `values.yaml` file, run the following command to update the self-managed Kubernetes cluster. |
There was a problem hiding this comment.
| After you update the `values.yaml` file, run the following command to update the self-managed Kubernetes cluster. | |
| After you update the `values.yaml` file, run the `consul-k8s upgrade` command to update the self-managed Kubernetes cluster. |
|
|
||
| ### Verify that the migration was successful | ||
|
|
||
| After you update the CoreDNS entry, check the Consul catalog to ensure that the migration was successful. You can check the Consul UI or run the following CLI command. |
There was a problem hiding this comment.
| After you update the CoreDNS entry, check the Consul catalog to ensure that the migration was successful. You can check the Consul UI or run the following CLI command. | |
| After you update the CoreDNS entry, check the Consul catalog to ensure that the migration was successful. You can check the Consul UI or run the `kubectl exec` command. |
| $ kubectl exec -c consul-server-0 -- consul members | ||
| ``` | ||
|
|
||
| Run `consul members` on the Dedicated cluster as well. Ensure that all service nodes appear as `inactive` or `left`. |
There was a problem hiding this comment.
| Run `consul members` on the Dedicated cluster as well. Ensure that all service nodes appear as `inactive` or `left`. | |
| Run the `consul members` command on the Dedicated cluster as well. Ensure that all service nodes appear as `inactive` or `left`. |
2 participants
Description
This PR re-adds the steps to migrate from HCP Consul Dedicated to a self-managed cluster. HashiCorp retains snapshots for 30 days, and support expects to continue supporting customers through the migration process.
This page was created at
/consul/docs/hcpinstead of in thehcp-docsdirectory because the migration process onboards to Consul Enterprise.The PR also updates the redirect from HCP Consul content, and includes a redirect for the versioned Consul docs.
Preview links
Preview