From 8981e7f5bb5ec29d5a4dd2fc89108fcbd3ffada6 Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Tue, 11 Jul 2023 11:14:18 -0700 Subject: [PATCH] Document the / URL of the HTTP port --- README.md | 7 +++++-- main.go | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f5a7e52..d5b4a47 100644 --- a/README.md +++ b/README.md @@ -237,8 +237,11 @@ OPTIONS Print help text and exit. --http-bind , $GITSYNC_HTTP_BIND - The bind address (including port) for git-sync's HTTP endpoint. If - not specified, the HTTP endpoint is not enabled. + The bind address (including port) for git-sync's HTTP endpoint. + The '/' URL of this endpoint is suitable for Kubernetes startup and + liveness probes, returning a 5xx error until the first sync is + complete, and a 200 status thereafter. If not specified, the HTTP + endpoint is not enabled. Examples: ":1234": listen on any IP, port 1234 diff --git a/main.go b/main.go index a97bf2b..8ddb7e9 100644 --- a/main.go +++ b/main.go @@ -2370,8 +2370,11 @@ OPTIONS Print help text and exit. --http-bind , $GITSYNC_HTTP_BIND - The bind address (including port) for git-sync's HTTP endpoint. If - not specified, the HTTP endpoint is not enabled. + The bind address (including port) for git-sync's HTTP endpoint. + The '/' URL of this endpoint is suitable for Kubernetes startup and + liveness probes, returning a 5xx error until the first sync is + complete, and a 200 status thereafter. If not specified, the HTTP + endpoint is not enabled. Examples: ":1234": listen on any IP, port 1234