From ee64be97bb6bdbe92abf618307728de2fe70ad59 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Wed, 22 Oct 2025 18:23:21 -0500 Subject: [PATCH] Clarify the value of mc-router.itzg.me/defaultServer annotation (#467) --- .github/workflows/test.yml | 6 ++++++ README.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cfb15a6..d38843b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -4,9 +4,15 @@ on: push: branches: - main + paths-ignore: &pathsIgnore + - 'docs/**' + - 'examples/**' + - 'kustomize/**' + - 'README.md' pull_request: branches: - main + paths-ignore: *pathsIgnore jobs: build: diff --git a/README.md b/README.md index 0a021f4..7ee0c34 100644 --- a/README.md +++ b/README.md @@ -235,7 +235,7 @@ For more information on the allow/deny list configuration, see the [json schema] When running `mc-router` as a Kubernetes Pod and you pass the `--in-kube-cluster` command-line argument, then it will automatically watch for any services annotated with - `mc-router.itzg.me/externalServerName` : The value of the annotation will be registered as the external hostname Minecraft clients would used to connect to the routed service. The service is used as the routed backend. You can use more hostnames by splitting them with comma. -- `mc-router.itzg.me/defaultServer` : The service is used as the default if no other `externalServiceName` annotations applies. +- `mc-router.itzg.me/defaultServer` : When set to "true", the service is used as the default if no other `externalServiceName` annotations applies. By default, the router will watch all namespaces for those services; however, a specific namespace can be specified using the `KUBE_NAMESPACE` environment variable. The pod's own namespace could be set using: