extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-19 08:17:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update doc to drive users to discourse if they need upgrade help

Browse Source
This commit is contained in:
Mike Guthrie 2025-04-11 13:49:14 -04:00
parent e00e93db1e
commit 9e332610fa
No known key found for this signature in database
GPG Key ID: 1B882E45188DB83B
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/myzrok/upgrading.md
View File

@ -5,26 +5,37 @@ title: Upgrading From 0.4 to 1.0
## Upgrading an existing 0.4 environment ## Upgrading an existing 0.4 environment
If you have not already, [install the latest 1.x zrok binary](/docs/guides/install) into your 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 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! Resume zrok API interactions as normal!
## Trouble after upgrade? ## 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 :::warning
Running `zrok disable` will delete any running environments or shares, and will release any reserved shares Running `zrok disable` will delete any running environments or shares, and will release any reserved shares
::: :::
``` ```
zrok disable zrok disable