Merge pull request #37 from pddg/photon-1.0.0

pddg · web-flow · commit 42e8f7118458 · 2026-03-07T15:22:15.000+09:00
photon 1.0.0
diff --git a/.env b/.env
@@ -1,3 +1,3 @@
-PHOTON_VERSION=0.7.3
-PHOTON_SHA256SUM=108438cd5d9404b2f68ee780281fa985f3afba67cf277225d68d038a2a7e69d3
+PHOTON_VERSION=1.0.0
+PHOTON_SHA256SUM=b2eaad11add95aad149d1e72e67a4df5f6694e725ac5363793a912c5b3e3a7df
 CONTAINER_REVISION=0
diff --git a/Dockerfile b/Dockerfile
@@ -3,7 +3,7 @@ FROM mirror.gcr.io/debian:stable-slim AS builder
 ARG PHOTON_VERSION
 ARG PHOTON_SHA256SUM
 
-ADD https://github.com/komoot/photon/releases/download/${PHOTON_VERSION}/photon-opensearch-${PHOTON_VERSION}.jar /photon/photon.jar
+ADD https://github.com/komoot/photon/releases/download/${PHOTON_VERSION}/photon-${PHOTON_VERSION}.jar /photon/photon.jar
 
 RUN echo "${PHOTON_SHA256SUM}  /photon/photon.jar" | sha256sum -c -
 
diff --git a/README.md b/README.md
@@ -101,8 +101,7 @@ Configuration is done via environment variables. The following environment varia
 
 | Environment Variable | Description | Default Value |
 |----------------------|-------------|---------------|
-| `PHOTON_AGENT_DATABASE_URL` | The URL of the Photon database. | `https://download1.graphhopper.com/public/experimental/` |
-| `PHOTON_AGENT_DATABASE_COUNTRY_CODE` | The country code for the Photon index data. The code can be found from [here](https://download1.graphhopper.com/public/experimental/extracts/by-country-code/). | `` (full index data) |
+| `PHOTON_AGENT_DATABASE_URL` | The URL of the Photon database. | `https://download1.graphhopper.com/public/photon-db-planet-1.0-latest.tar.bz2` |
 | `PHOTON_AGENT_UPDATE_STRATEGY` | The update strategy for the Photon index. Can be `sequential` or `parallel`. | `sequential` |
 | `PHOTON_AGENT_DOWNLOAD_SPEED_LIMIT` | The speed limit for downloading the Photon index data. e.g. `10MB` | (no limit) |
 | `PHOTON_AGENT_IO_SPEED_LIMIT` | The speed limit for storage I/O operations. e.g. `10MB` | (no limit) |
diff --git a/cmd/photon-agent/main.go b/cmd/photon-agent/main.go
@@ -31,7 +31,7 @@ var (
 	logLevel                      string
 	logFormat                     string
 	databaseURL                   string
-	databaseCountryCode           string
+	listenIP                      string
 	updateStrategy                string
 	downloadSpeedLimitBytesPerSec string
 	ioSpeedLimitBytesPerSec       string
@@ -48,13 +48,13 @@ func main() {
 	flag.BoolVar(&disableMetrics, "disable-metrics", false, "disable photon database metrics (/metrics only provide go runtime information)")
 
 	// Photon database source options
-	flag.StringVar(&databaseURL, "database-url", getEnv("PHOTON_AGENT_DATABASE_URL", downloader.DefaultDatabaseURL), "URL of the Photon database to download")
-	flag.StringVar(&databaseCountryCode, "database-country-code", getEnv("PHOTON_AGENT_DATABASE_COUNTRY_CODE", ""), "country code of the Photon database to download. If empty, download the full database")
+	flag.StringVar(&databaseURL, "database-url", getEnv("PHOTON_AGENT_DATABASE_URL", photondata.DefaultDatabaseURL), "URL of the Photon database to download")
 
 	// Photon server options
 	flag.StringVar(&photonJarPath, "photon-jar-path", getEnv("PHOTON_AGENT_PHOTON_JAR_PATH", "/photon/photon.jar"), "path to the Photon jar file")
 	flag.StringVar(&photonDir, "photon-dir", getEnv("PHOTON_AGENT_PHOTON_DIR", "/photon"), "directory to store the Photon data")
 	flag.StringVar(&updateStrategy, "update-strategy", getEnv("PHOTON_AGENT_UPDATE_STRATEGY", string(updater.DefaultUpdateStrategy)), "update strategy for the Photon database")
+	flag.StringVar(&listenIP, "photon-listen-ip", getEnv("PHOTON_AGENT_PHOTON_LISTEN_IP", "127.0.0.1"), "IP address to listen on by photon")
 
 	// Speed limit options
 	flag.StringVar(&downloadSpeedLimitBytesPerSec, "download-speed-limit", getEnv("PHOTON_AGENT_DOWNLOAD_SPEED_LIMIT", ""), "download speed limit in bytes per second (e.g. 10MB). default is unlimited")
@@ -101,14 +101,16 @@ func innerMain(ctx context.Context) error {
 		}
 		downloaderOptions = append(downloaderOptions, downloader.WithDownloadSpeedLimit(downloadSpeedLimit))
 	}
-	if databaseCountryCode != "" {
-		archiveOptions = append(archiveOptions, photondata.WithCountryCode(databaseCountryCode))
-	}
 
-	photonArchive := photondata.NewArchive(databaseURL, archiveOptions...)
+	photonArchive, err := photondata.NewArchive(databaseURL, archiveOptions...)
+	if err != nil {
+		return fmt.Errorf("invalid archive: %w", err)
+	}
 	dl := downloader.New(httpClient, downloaderOptions...)
 	ua := unarchiver.NewUnarchiver(unarchiverOptions...)
-	photonServer := photon.NewPhotonServer(ctx, photonJarPath, photonDir)
+	photonServer := photon.NewPhotonServer(ctx, photonJarPath, photonDir, photon.WithArgs(
+		"-listen-ip", listenIP,
+	))
 	photonDataDir := filepath.Join(photonDir, "photon_data")
 	migrator := photondata.NewMigrator(photonDataDir, httpClient)
 	updater, err := updater.New(
diff --git a/cmd/photon-db-updater/main.go b/cmd/photon-db-updater/main.go
@@ -23,7 +23,6 @@ var (
 	logLevel                      string
 	logFormat                     string
 	databaseURL                   string
-	databaseCountryCode           string
 	archivePath                   string
 	archiveDownloadPath           string
 	downloadOnly                  bool
@@ -39,8 +38,7 @@ func main() {
 	flag.StringVar(&logLevel, "log-level", getEnv("PHOTON_AGENT_LOG_LEVEL", "info"), "log level")
 	flag.StringVar(&logFormat, "log-format", getEnv("PHOTON_AGENT_LOG_FORMAT", "json"), "log format")
 
-	flag.StringVar(&databaseURL, "database-url", getEnv("PHOTON_AGENT_DATABASE_URL", downloader.DefaultDatabaseURL), "URL of the Photon database to download")
-	flag.StringVar(&databaseCountryCode, "database-country-code", getEnv("PHOTON_AGENT_DATABASE_COUNTRY_CODE", ""), "country code of the Photon database to download. If empty, download the full database")
+	flag.StringVar(&databaseURL, "database-url", getEnv("PHOTON_AGENT_DATABASE_URL", photondata.DefaultDatabaseURL), "URL of the Photon database to download")
 
 	flag.StringVar(&archivePath, "archive", getEnv("PHOTON_UPDATER_ARCHIVE", ""), "path to the local archive if you want to use it instead of downloading")
 	flag.StringVar(&archiveDownloadPath, "download-to", getEnv("PHOTON_UPDATER_DOWNLOAD_TO", "/tmp/photon-db.tar.bz2"), "path to download the archive. Skip downloading if md5sum matches with the existing file")
@@ -79,7 +77,10 @@ func innerMain(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
-	archive := photondata.NewArchive(databaseURL, archiveOptions...)
+	archive, err := photondata.NewArchive(databaseURL, archiveOptions...)
+	if err != nil {
+		return fmt.Errorf("invalid archive: %w", err)
+	}
 	dl := downloader.New(httpClient, downloadOptions...)
 	agentClient := photonagent.NewClient(httpClient, photonAgentURL)
 
@@ -151,9 +152,6 @@ func initOptions(
 		}
 		downloadOptions = append(downloadOptions, downloader.WithDownloadSpeedLimit(float64(limitBytes)))
 	}
-	if databaseCountryCode != "" {
-		archiveOptions = append(archiveOptions, photondata.WithCountryCode(databaseCountryCode))
-	}
 	if force {
 		uploadOptions = append(uploadOptions, photonagent.WithForceUpload())
 	}
diff --git a/compose.yaml b/compose.yaml
@@ -8,8 +8,8 @@ services:
         - PHOTON_SHA256SUM=${PHOTON_SHA256SUM}
         - GIT_SHA="dev"
     environment:
-      # Small country code for testing
-      - PHOTON_AGENT_DATABASE_COUNTRY_CODE=ad
+      # Small country data for testing
+      - PHOTON_AGENT_DATABASE_URL=https://download1.graphhopper.com/public/europe/andorra/photon-db-andorra-1.0-latest.tar.bz2
     restart: unless-stopped
     ports:
       - "8080:8080"
diff --git a/e2e/cluster_test.go b/e2e/cluster_test.go
@@ -2,6 +2,7 @@ package e2e_test
 
 import (
 	"fmt"
+	"os"
 	"strings"
 	"testing"
 	"time"
@@ -13,6 +14,10 @@ func setup(t *testing.T, ns string) (string, string) {
 	t.Helper()
 	kubectl(t, "create", "ns", ns)
 	t.Cleanup(func() {
+		if os.Getenv("DEBUG") == "true" {
+			t.Logf("skip deleting %q namespace since DEBUG=true", ns)
+			return
+		}
 		kubectl(t, "delete", "ns", ns)
 	})
 
diff --git a/e2e/suite_test.go b/e2e/suite_test.go
@@ -4,6 +4,10 @@ import (
 	"testing"
 )
 
+const (
+	testDataURL = "https://download1.graphhopper.com/public/europe/andorra/photon-db-andorra-1.0-latest.tar.bz2"
+)
+
 func Test_ServerSideDownload(t *testing.T) {
 	t.Parallel()
 	ns := "server-side-dl"
@@ -30,7 +34,7 @@ func Test_UploadFromClientSide(t *testing.T) {
 		"/bin/photon-db-uploader",
 		"-download-to", "/tmp/photon-db.tar.bz2",
 		"-photon-agent-url", photonAgentUrl,
-		"-database-country-code", "ad",
+		"-database-url", testDataURL,
 	)
 
 	// Verify
@@ -50,7 +54,7 @@ func Test_UploadUncompressedFromClientSide(t *testing.T) {
 		"/bin/photon-db-uploader",
 		"-download-to", "/tmp/client-uncompressed.tar.bz2",
 		"-download-only",
-		"-database-country-code", "ad",
+		"-database-url", testDataURL,
 	)
 	bastionExec(t,
 		"bzip2", "-d", "/tmp/client-uncompressed.tar.bz2",
diff --git a/examples/compose/README.md b/examples/compose/README.md
@@ -11,8 +11,7 @@
 ## Steps to Deploy
 
 > [!NOTE]
-> By default, the environment variable `PHOTON_AGENT_DATABASE_COUNTRY_CODE` is set, which limits the download to data for a few countries with smaller index sizes.
-> You can find country codes from [here](https://download1.graphhopper.com/public/experimental/extracts/by-country-code/).
+> By default, the environment variable `PHOTON_AGENT_DATABASE_URL` is set, which limits the download to data for a few countries with smaller index sizes.
 
 > [!WARNING]
 > If you plan to use the full-size index, ensure that the volume has enough capacity to accommodate both the compressed archive and the extracted data. This requires at least 350 GiB of storage space.
diff --git a/examples/compose/compose.yaml b/examples/compose/compose.yaml
@@ -3,11 +3,10 @@ services:
     image: ghcr.io/pddg/photon:latest
     environment:
       # Where to download the data from
-      # Only supports OpenSearch compatible version.
-      # Currently it is only tested with GraphHopper's experimental data.
-      - PHOTON_AGENT_DATABASE_URL=https://download1.graphhopper.com/public/experimental/
-      # Country code if you want to use only a specific country's data
-      - PHOTON_AGENT_DATABASE_COUNTRY_CODE=ad
+      # Only supports archives for photon 1.x or later.
+      - PHOTON_AGENT_DATABASE_URL=https://download1.graphhopper.com/public/europe/andorra/photon-db-andorra-1.0-latest.tar.bz2
+      # Photon listens only 127.0.0.1 by default.
+      - PHOTON_AGENT_PHOTON_LISTEN_IP=0.0.0.0
     volumes:
       # Mount the photon data volume
       # /photon/photon_data is the default path for the index data
diff --git a/examples/kubernetes/01-sts.yaml b/examples/kubernetes/01-sts.yaml
@@ -30,14 +30,14 @@ spec:
               name: photon
           env:
             # URL to download the data from.
-            # Only OpenSearch-compatible versions are supported.
-            # Currently, only experimental data from GraphHopper is available.
+            # Only archives for photon 1.x or later are supported.
             - name: PHOTON_AGENT_DATABASE_URL
-              value: https://download1.graphhopper.com/public/experimental/
-            # Specify the country code if you want to use data for a specific country.
-            # For example, `ad` contains only a small amount of data.
-            - name: PHOTON_AGENT_DATABASE_COUNTRY_CODE
-              value: ad
+              value: https://download1.graphhopper.com/public/europe/andorra/photon-db-andorra-1.0-latest.tar.bz2
+            # Photon listens only 127.0.0.1 by default. This is required to use photon out side of this Pod.
+            - name: PHOTON_AGENT_PHOTON_LISTEN_IP
+              valueFrom:
+                fieldRef:
+                  fieldPath: status.podIP
           volumeMounts:
             - mountPath: /photon/photon_data
               name: photon-data
diff --git a/examples/kubernetes/README.md b/examples/kubernetes/README.md
@@ -19,9 +19,8 @@ Started container has no data. You can call API to download data from the intern
 > This accounts for up to twice the size of the extracted data due to the simultaneous storage of the archive and its expanded contents.
 
 > [!NOTE]
-> If you want to test with small data, you can specify `PHOTON_AGENT_DATABASE_COUNTRY_CODE` .
-> Example manifest uses `PHOTON_AGENT_DATABASE_COUNTRY_CODE: ad`.
-> You can find country codes from [here](https://download1.graphhopper.com/public/experimental/extracts/by-country-code/).
+> If you want to test with small data, you can specify `PHOTON_AGENT_DATABASE_URL` .
+> Example manifest uses [andorra's geo data](https://download1.graphhopper.com/public/europe/andorra/index.html).
 
 ```bash
 # Port forward to management API
diff --git a/internal/downloader/downloader_test.go b/internal/downloader/downloader_test.go
@@ -62,12 +62,12 @@ func Test_Downloader_Download(t *testing.T) {
 				w.Write(want)
 			}))
 			defer srv.Close()
-			archive := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+			archive, err := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+			require.NoError(t, err)
 			d := downloader.New(srv.Client(), tc.options...)
 
 			// Exercise
-			err := d.Download(t.Context(), archive, dest)
-
+			err = d.Download(t.Context(), archive, dest)
 			// Verify
 			require.NoError(t, err)
 			assert.Equal(t, requestPathWant, requestPathGot, "requested path is wrong")
@@ -91,12 +91,12 @@ func Test_Downloader_Download(t *testing.T) {
 			w.Write([]byte("hello, world"))
 		}))
 		defer srv.Close()
-		archive := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+		archive, err := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+		require.NoError(t, err)
 		d := downloader.New(srv.Client())
 
 		// Exercise
-		err := d.Download(t.Context(), archive, dest)
-
+		err = d.Download(t.Context(), archive, dest)
 		// Verify
 		require.Error(t, err)
 	})
@@ -111,7 +111,8 @@ func Test_Downloader_GetLastModified(t *testing.T) {
 		w.WriteHeader(http.StatusOK)
 	}))
 	defer srv.Close()
-	archive := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+	archive, err := photondata.NewArchive(srv.URL, photondata.WithArchiveName("test"))
+	require.NoError(t, err)
 	d := downloader.New(srv.Client())
 
 	// Exercise
diff --git a/internal/downloader/options.go b/internal/downloader/options.go
@@ -2,10 +2,6 @@ package downloader
 
 import "time"
 
-const (
-	DefaultDatabaseURL = "https://download1.graphhopper.com/public/experimental/"
-)
-
 type DownloaderOption func(*Downloader)
 
 // WithoutProgress disables the progress tracking of the downloader.
diff --git a/internal/metrics/photon_test.go b/internal/metrics/photon_test.go
@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
+	"github.com/stretchr/testify/require"
 
 	"github.com/pddg/photon-container/internal/metrics"
 	"github.com/pddg/photon-container/internal/photondata"
@@ -87,10 +88,12 @@ photon_latest_database_last_modified_timestamp_seconds{database_name="%s",databa
 		first := time.Now().UTC().Truncate(time.Second)
 		ticker := newMockTicker()
 		downloader := newMockDownloader(first, nil)
+		archive, err := photondata.NewArchive(baseURL, photondata.WithArchiveName(dbPath))
+		require.NoError(t, err)
 		c := metrics.NewLatestPhotonDataMetrics(
 			t.Context(),
 			downloader,
-			photondata.NewArchive(baseURL, photondata.WithArchiveName(dbPath)),
+			archive,
 			metrics.WithTicker(ticker.C()),
 		)
 
@@ -115,10 +118,12 @@ photon_latest_database_last_modified_timestamp_seconds{database_name="%s",databa
 		initial := time.Now().UTC().Truncate(time.Second)
 		ticker := newMockTicker()
 		downloader := newMockDownloader(initial, nil)
+		archive, err := photondata.NewArchive(baseURL, photondata.WithArchiveName(dbPath))
+		require.NoError(t, err)
 		c := metrics.NewLatestPhotonDataMetrics(
 			t.Context(),
 			downloader,
-			photondata.NewArchive(baseURL, photondata.WithArchiveName(dbPath)),
+			archive,
 			metrics.WithTicker(ticker.C()),
 		)
 
diff --git a/internal/photon/options.go b/internal/photon/options.go
@@ -2,7 +2,7 @@ package photon
 
 type PhotonServerOption func(*PhotonServer)
 
-func WithArgs(args []string) PhotonServerOption {
+func WithArgs(args ...string) PhotonServerOption {
 	return func(s *PhotonServer) {
 		s.additionalArgs = args
 	}
diff --git a/internal/photondata/archive.go b/internal/photondata/archive.go
