From 02b34aca2fcd0d13497095d6dba3d3caec7788c4 Mon Sep 17 00:00:00 2001 From: Pierre Marshall Date: Wed, 2 Jul 2025 10:55:56 +0100 Subject: [PATCH 1/3] style: add full stops after sentences and quotes around suggested error message --- frontend/docs/docs/deploy/local.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/frontend/docs/docs/deploy/local.md b/frontend/docs/docs/deploy/local.md index f49f6b1c08..c9b95c56e9 100644 --- a/frontend/docs/docs/deploy/local.md +++ b/frontend/docs/docs/deploy/local.md @@ -180,11 +180,11 @@ There should be 4 pods listed: backend, frontend, minio, and mongodb. If any one To get more details about why a pod has not started, run `#!sh kubectl describe ` and see the latest status at the bottom. -Often, the error may be obvious, such as failed to pull an image. +Often, the error may be obvious, such as "failed to pull an image." -If the pod is running, or previously ran, you can also get the logs from the container by running `#!sh kubectl logs ` +If the pod is running, or previously ran, you can also get the logs from the container by running `#!sh kubectl logs `. -The outputs of these commands are helpful when reporting an issue [on GitHub](https://github.com/webrecorder/browsertrix/issues) +The outputs of these commands are helpful when reporting an issue [on GitHub](https://github.com/webrecorder/browsertrix/issues). ## Updating the Cluster From f170686cce3029957ba2cfc3b66bbd3ebbb3e969 Mon Sep 17 00:00:00 2001 From: Pierre Marshall Date: Wed, 2 Jul 2025 10:58:24 +0100 Subject: [PATCH 2/3] docs(deployment): add note about potential firewall issues on RHEL --- frontend/docs/docs/deploy/local.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/frontend/docs/docs/deploy/local.md b/frontend/docs/docs/deploy/local.md index c9b95c56e9..eeef3fb247 100644 --- a/frontend/docs/docs/deploy/local.md +++ b/frontend/docs/docs/deploy/local.md @@ -186,6 +186,9 @@ If the pod is running, or previously ran, you can also get the logs from the con The outputs of these commands are helpful when reporting an issue [on GitHub](https://github.com/webrecorder/browsertrix/issues). +On Red Hat Enterprise Linux and derivatives, communication between pods might be blocked by firewalld. +There are short guides in the [k3s](https://docs.k3s.io/installation/requirements?&os=rhel#operating-systems) and [Microk8s](https://microk8s.io/docs/troubleshooting#:~:text=Pod%20communication%20problems%20when%20using%20firewall-cmd) documentation showing how to configure the firewall for kubernetes. + ## Updating the Cluster To update the cluster, for example to update to new version `NEWVERSION`, re-run the same command again, which will pull the latest images. In this way, you can upgrade to the latest release of Browsertrix. The upgrade will preserve the database and current archives. From 9fcf35fb5c1f50083debca4b58e216ba7cf96ede Mon Sep 17 00:00:00 2001 From: Pierre Marshall Date: Wed, 2 Jul 2025 11:21:58 +0100 Subject: [PATCH 3/3] style: make this note a warning box --- frontend/docs/docs/deploy/local.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/frontend/docs/docs/deploy/local.md b/frontend/docs/docs/deploy/local.md index eeef3fb247..3f37159956 100644 --- a/frontend/docs/docs/deploy/local.md +++ b/frontend/docs/docs/deploy/local.md @@ -186,8 +186,10 @@ If the pod is running, or previously ran, you can also get the logs from the con The outputs of these commands are helpful when reporting an issue [on GitHub](https://github.com/webrecorder/browsertrix/issues). -On Red Hat Enterprise Linux and derivatives, communication between pods might be blocked by firewalld. -There are short guides in the [k3s](https://docs.k3s.io/installation/requirements?&os=rhel#operating-systems) and [Microk8s](https://microk8s.io/docs/troubleshooting#:~:text=Pod%20communication%20problems%20when%20using%20firewall-cmd) documentation showing how to configure the firewall for kubernetes. +??? info "Firewall rules (on RHEL/Fedora)" + + On Red Hat Enterprise Linux and derivatives, communication between pods might be blocked by firewalld. + There are short guides on configuring the firewall for these systems in the [k3s](https://docs.k3s.io/installation/requirements?&os=rhel#operating-systems) and [Microk8s](https://microk8s.io/docs/troubleshooting#:~:text=Pod%20communication%20problems%20when%20using%20firewall-cmd) documentation. ## Updating the Cluster