Skip to content

fix(deployment): default k3s image and --k3s-image argument in deploy.py #6151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tombch merged 6 commits into from
Mar 20, 2026
Merged

fix(deployment): default k3s image and --k3s-image argument in deploy.py #6151

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
faf7873
Fixing type error
tombch Mar 18, 2026
4c76082
Added k3s-image argument
tombch Mar 18, 2026
7f58e59
Added default k3s image of v1.31.14
tombch Mar 18, 2026
ace76fa
Added version to help message
tombch Mar 18, 2026
4a8d90b
Merge branch 'main' into k3s-image-arg
tombch Mar 18, 2026
cf76c74
Merge branch 'main' into k3s-image-arg
tombch Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions deploy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
HELM_RELEASE_NAME = "preview"
HELM_CHART_DIR = ROOT_DIR / "kubernetes" / "loculus"

# By default, uses K3s v1.31: https://hub.docker.com/r/rancher/k3s/tags?name=v1.31
# K3s v1.31 is the latest version which installs Traefik v2 (Traefik v3 is not yet supported by Loculus)
# Also see: https://docs.k3s.io/upgrades#version-specific-caveats
DEFAULT_K3S_IMAGE = "rancher/k3s:v1.31.14-k3s1"

WEBSITE_PORT_MAPPING = "-p 127.0.0.1:3000:30081@agent:0"
BACKEND_PORT_MAPPING = "-p 127.0.0.1:8079:30082@agent:0"
LAPIS_PORT_MAPPING = "-p 127.0.0.1:8080:80@loadbalancer"
Expand Down Expand Up @@ -68,6 +73,11 @@
)
cluster_parser.add_argument("--delete", action="store_true", help="Delete the cluster")
cluster_parser.add_argument("--bind-all", action="store_true", help="Bind to all interfaces")
cluster_parser.add_argument(
"--k3s-image",
default=DEFAULT_K3S_IMAGE,
help="Specify the k3s image to use for the cluster (default: %(default)s)",
)

helm_parser = subparsers.add_parser("helm", help="Install the Helm chart to the k3d cluster")
helm_parser.add_argument(
Expand Down Expand Up @@ -180,10 +190,13 @@ def handle_cluster():
if cluster_exists(CLUSTER_NAME):
print(f"Cluster '{CLUSTER_NAME}' already exists.")
else:
run_command(
f"k3d cluster create {CLUSTER_NAME} {' '.join(port_bindings)} --agents 1",
shell=True,
)
command = f"k3d cluster create {CLUSTER_NAME} {' '.join(port_bindings)} --agents 1"

if args.k3s_image:
Comment thread
tombch marked this conversation as resolved.
command += f" --image {args.k3s_image}"

run_command([command], shell=True)

install_secret_generator()
while not is_traefik_running():
print("Waiting for Traefik to start...")
Expand Down Expand Up @@ -413,8 +426,8 @@ def generate_configs(from_live, live_host, enable_ena, values_files=None):
[
"python",
"kubernetes/config-processor/config-processor.py",
temp_dir_path,
output_dir,
str(temp_dir_path),
str(output_dir),
]
)
print(f"Config generation succeeded, processed config files available in {output_dir}")
Expand Down
Loading