From 9e332610fadb1f6b58c8f434f3e1c48e6f67acf5 Mon Sep 17 00:00:00 2001 From: Mike Guthrie Date: Fri, 11 Apr 2025 13:49:14 -0400 Subject: [PATCH] Update doc to drive users to discourse if they need upgrade help --- docs/myzrok/upgrading.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/myzrok/upgrading.md b/docs/myzrok/upgrading.md index e0994979..f8b046f1 100644 --- a/docs/myzrok/upgrading.md +++ b/docs/myzrok/upgrading.md @@ -5,26 +5,37 @@ title: Upgrading From 0.4 to 1.0 ## Upgrading an existing 0.4 environment If you have not already, [install the latest 1.x zrok binary](/docs/guides/install) into your environment. -Run the following to rebase your environment to use the new versioned API: +:::note +As of zrok `1.0.2`, the zrok rebase is automatic and the configuration will automatically be updated to the v1 API. +No action is necessary. +::: + +If you are running version `1.0.0` or `1.01`, you can run the following to rebase your environment to use the new versioned API: ``` zrok rebase apiEndpoint https://api-v1.zrok.io ``` -:::note -As of zrok `1.0.2`, the zrok rebase is automatic and the configuration will automatically be updated to the v1 API. -::: - - Resume zrok API interactions as normal! ## Trouble after upgrade? -If you run into any issues after upgrading your environment, try running the following: +If you run into any issues after upgrading your environment, first verify your zrok version and review your current zrok configuration: + +``` +zrok version +``` +Review the `apiEndpoint` configuration, if you are running version `1.0` or later, the `apiEndpoint` should be `https://api-v1.zrok.io` +``` +zrok status +``` + +If you're still having issues, we recommend you reach out to our community support team at our [zrok discourse](https://openziti.discourse.group/c/zrok/24) forum. + +If you prefer to do a hard reset of your environment, you can also run the commands below: :::warning Running `zrok disable` will delete any running environments or shares, and will release any reserved shares - ::: ``` zrok disable