docs: Add docs for verifying gateway upgrade on Docker (#3895)

Helps troubleshoot malfunctioning gateways.

When we start bumping release versions when publishing releases, we can
update this to simply print the gateway version
This commit is contained in:
Jamil
2024-03-04 05:03:08 -08:00
committed by GitHub
parent 5898a2c1e8
commit 5e120eaf90
4 changed files with 31 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View File

@@ -0,0 +1,6 @@
"use client";
import Content from "./readme.mdx";
export default function _Page() {
return <Content />;
}

View File

@@ -1,4 +1,4 @@
import Content from "./readme.mdx";
import _Page from "./_page";
import { Metadata } from "next";
export const metadata: Metadata = {
@@ -7,5 +7,5 @@ export const metadata: Metadata = {
};
export default function Page() {
return <Content />;
return <_Page />;
}

View File

@@ -1,5 +1,6 @@
import { HiCheck } from "react-icons/hi2";
import { TabsItem, TabsGroup } from "@/components/DocsTabs";
import Image from "next/image";
# Upgrading Firezone
@@ -59,6 +60,28 @@ Gateway, and then restarts it using the newer image with the same configuration.
curl -s https://raw.githubusercontent.com/firezone/firezone/main/scripts/gateway-docker-upgrade.sh | bash
```
### Verification
After running the upgrade, you can verify the Gateway is running the latest
version by ensuring the sha256 hash of the pulled image matches the latest
[artifact published on GitHub](https://github.com/firezone/firezone/pkgs/container/gateway/184806062?tag=latest):
<Image
src="/images/kb/administer/upgrading/gateway-upgrade-verify.png"
width={500}
height={500}
className="mx-auto"
alt="Gateway upgrade verification"
/>
```bash
# Get the sha256 hash of the your gateway image
> docker inspect ghcr.io/firezone/gateway:1.0 --format='{{index .RepoDigests 0}}'
# Ensure this hash matches the latest available image above
ghcr.io/firezone/gateway@sha256:0516fa4a305fac10571238db2b7bf02e6adeda0fb5afc1fe7e8d0c4d0a93ebc6
```
</TabsItem>
<TabsItem title="systemd">