From 8488d6e751d97ef044c8cf018dde46a77e895632 Mon Sep 17 00:00:00 2001 From: Jove Zhong Date: Fri, 16 Aug 2024 17:58:23 -0700 Subject: [PATCH] Update README and Docker Pull --- README.md | 19 ++++------- .../awesome-sensor-logger/docker-compose.yml | 32 +++++++++---------- examples/carsharing/docker-compose.yml | 4 +-- examples/cdc/docker-compose.yml | 2 +- examples/clickhouse/docker-compose.yml | 2 +- examples/coinbase/docker-compose.yml | 4 +-- examples/ecommerce/docker-compose.yml | 2 +- examples/fraud_detection/docker-compose.yml | 4 +-- examples/grafana/docker-compose.yml | 4 +-- examples/hackernews/compose.yaml | 11 +++---- examples/jdbc/docker-compose.yml | 4 +-- examples/nginx-grafana/docker-compose.yaml | 2 +- 12 files changed, 42 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 2b7c37ef52a..06042b196df 100644 --- a/README.md +++ b/README.md @@ -65,15 +65,10 @@ brew install timeplus-io/timeplus/proton ### Docker: ```bash -docker run -d --pull always --name proton ghcr.io/timeplus-io/proton:latest +docker run -d --pull always -p 8123:8123 -p 8463:8463 --name proton d.timeplus.com/timeplus-io/proton:latest ``` -In case you cannot access ghcr, you can pull the image from `public.ecr.aws/timeplus/proton` -You may need to expose ports from the Proton container so that other tools can connect to it, such as DBeaver. Please check [Server Ports](https://docs.timeplus.com/proton-ports) for each port to expose. For example: - -```shell -docker run -d --pull always -p 8123:8123 -p 8463:8463 --name proton ghcr.io/timeplus-io/proton:latest -``` +Please check [Server Ports](https://docs.timeplus.com/proton-ports) to determine which ports to expose, so that other tools can connect to Timeplus, such as DBeaver. ### Docker Compose: @@ -81,7 +76,7 @@ The [Docker Compose stack](https://github.com/timeplus-io/proton/tree/develop/ex ### Timeplus Cloud: -One step to try Timeplus Proton in [Timeplus Cloud](https://us.timeplus.cloud/) +Don't want to setup by yourself? Try Timeplus Proton in [Cloud](https://us.timeplus.cloud/) ### 🔎 Usage @@ -89,7 +84,7 @@ SQL is the main interface. You can start a new terminal window with `proton clie > [!NOTE] > You can also integrate Timeplus Proton with Python/Java/Go SDK, REST API, or BI plugins. Please check Integrations -From `proton client`, run the following SQL to create a stream of random data: +In the `proton client`, you can write SQL to create [External Stream for Kafka](https://docs.timeplus.com/proton-kafka) or [External Table for ClickHouse](https://docs.timeplus.com/proton-clickhouse-external-table). You can also run the following SQL to create a stream of random data: ```sql -- Create a stream with random data @@ -123,9 +118,9 @@ What features are available with Timeplus Proton versus Timeplus Enterprise? | | **Timeplus Proton** | **Timeplus Enterprise** | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Deployment** | | | -| **Data sources** | | | -| **Data destinations (sinks)** | | | +| **Deployment** | | | +| **Data sources** | | | +| **Data destinations (sinks)** | | | | **Support** | | | ## 🧩 Integrations diff --git a/examples/awesome-sensor-logger/docker-compose.yml b/examples/awesome-sensor-logger/docker-compose.yml index 08652db94c1..19201c198e9 100644 --- a/examples/awesome-sensor-logger/docker-compose.yml +++ b/examples/awesome-sensor-logger/docker-compose.yml @@ -1,24 +1,24 @@ services: proton: - image: ghcr.io/timeplus-io/proton:latest - pull_policy: always - ports: - - 3218:3218 #http port for JDBC driver, default streaming mode - - 8123:8123 #http port for JDBC driver, default batch mode - - 8463:8463 #tcp port for go driver or grafana plugin - volumes: - - ./init_sql:/docker-entrypoint-initdb.d - healthcheck: - test: wget --no-verbose --tries=1 --spider http://localhost:8123/?query=show+create+phone || exit 1 - interval: 2s - timeout: 10s - retries: 3 - start_period: 10s + image: d.timeplus.com/timeplus-io/proton:latest + pull_policy: always + ports: + - 3218:3218 #http port for JDBC driver, default streaming mode + - 8123:8123 #http port for JDBC driver, default batch mode + - 8463:8463 #tcp port for go driver or grafana plugin + volumes: + - ./init_sql:/docker-entrypoint-initdb.d + healthcheck: + test: wget --no-verbose --tries=1 --spider http://localhost:8123/?query=show+create+phone || exit 1 + interval: 2s + timeout: 10s + retries: 3 + start_period: 10s proxy: - image: timeplus/sensor-logger-proxy + image: docker.timeplus.com/timeplus/sensor-logger-proxy ports: - - 8000:3000 #expose internal port 3000 as 8000, avoiding conflicts with Grafana. This will forward HTTP POST to proton:3218 + - 8000:3000 #expose internal port 3000 as 8000, avoiding conflicts with Grafana. This will forward HTTP POST to proton:3218 environment: HOST: proton STREAM: phone diff --git a/examples/carsharing/docker-compose.yml b/examples/carsharing/docker-compose.yml index 43620c97638..d75d4cccacc 100644 --- a/examples/carsharing/docker-compose.yml +++ b/examples/carsharing/docker-compose.yml @@ -1,11 +1,11 @@ name: proton-demo-carsharing services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always carsharing_datagen: - image: timeplus/cardemo:latest + image: docker.timeplus.com/timeplus/cardemo:latest entrypoint: /bin/sh command: -c "sleep 15 && echo \"$$CONSOLE_CONFIG_FILE\" > /timeplus/sink.yaml; /timeplus/cardemo --config /timeplus/.cardemo.yaml -f /timeplus/sink.yaml" environment: diff --git a/examples/cdc/docker-compose.yml b/examples/cdc/docker-compose.yml index 68cc5ebd3db..b5577a8b6cd 100644 --- a/examples/cdc/docker-compose.yml +++ b/examples/cdc/docker-compose.yml @@ -1,6 +1,6 @@ services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: # - 3218:3218 #http port for JDBC driver, default streaming mode diff --git a/examples/clickhouse/docker-compose.yml b/examples/clickhouse/docker-compose.yml index c353451ce21..38b2cf9eca0 100644 --- a/examples/clickhouse/docker-compose.yml +++ b/examples/clickhouse/docker-compose.yml @@ -3,7 +3,7 @@ volumes: redpanda: null services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always clickhouse: diff --git a/examples/coinbase/docker-compose.yml b/examples/coinbase/docker-compose.yml index df2656b113a..c874fe12c62 100644 --- a/examples/coinbase/docker-compose.yml +++ b/examples/coinbase/docker-compose.yml @@ -1,7 +1,7 @@ name: coinbase services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: - "3218:3218" # HTTP Streaming @@ -22,7 +22,7 @@ services: - "4195:4195" init-pipeline: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest command: - sh - -c diff --git a/examples/ecommerce/docker-compose.yml b/examples/ecommerce/docker-compose.yml index f2e2da2aeae..150ccec9bef 100644 --- a/examples/ecommerce/docker-compose.yml +++ b/examples/ecommerce/docker-compose.yml @@ -3,7 +3,7 @@ volumes: redpanda: null services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: # - 3218:3218 #http port for JDBC driver, default streaming mode diff --git a/examples/fraud_detection/docker-compose.yml b/examples/fraud_detection/docker-compose.yml index b16883c7e95..98fe03060d3 100644 --- a/examples/fraud_detection/docker-compose.yml +++ b/examples/fraud_detection/docker-compose.yml @@ -1,7 +1,7 @@ name: proton-fraud-detection services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always healthcheck: test: ["CMD", "curl", "http://localhost:3218/proton/ping"] @@ -11,7 +11,7 @@ services: start_period: 10s online-payment-data: - image: timeplus/fraud:2cfdfbc + image: docker.timeplus.com/timeplus/fraud:2cfdfbc pull_policy: always environment: PROTON_HOST: proton diff --git a/examples/grafana/docker-compose.yml b/examples/grafana/docker-compose.yml index 6ae61b7a98c..ec33d5bbec1 100644 --- a/examples/grafana/docker-compose.yml +++ b/examples/grafana/docker-compose.yml @@ -1,13 +1,13 @@ services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: - 8463:8463 - 3218:3218 carsharing_datagen: - image: timeplus/cardemo:latest + image: docker.timeplus.com/timeplus/cardemo:latest entrypoint: /bin/sh command: -c "sleep 15 && echo \"$$CONSOLE_CONFIG_FILE\" > /timeplus/sink.yaml; /timeplus/cardemo --config /timeplus/.cardemo.yaml -f /timeplus/sink.yaml" environment: diff --git a/examples/hackernews/compose.yaml b/examples/hackernews/compose.yaml index f3d1d4b9151..f759996c0c7 100644 --- a/examples/hackernews/compose.yaml +++ b/examples/hackernews/compose.yaml @@ -1,7 +1,6 @@ services: - proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: - 8463:8463 @@ -13,12 +12,12 @@ services: interval: 5s timeout: 10s retries: 3 - start_period: 10s - + start_period: 10s + hn_stream: build: - context: . - image: timeplus/hackernews_bytewax:latest + context: . + image: docker.timeplus.com/timeplus/hackernews_bytewax:latest environment: - PROTON_HOST=proton depends_on: diff --git a/examples/jdbc/docker-compose.yml b/examples/jdbc/docker-compose.yml index 91d0c1940cf..78ad372c8da 100644 --- a/examples/jdbc/docker-compose.yml +++ b/examples/jdbc/docker-compose.yml @@ -1,6 +1,6 @@ services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: - 3218:3218 #http port for JDBC driver, default streaming mode @@ -8,7 +8,7 @@ services: # - 8463:8463 #tcp port for go driver or grafana plugin carsharing_datagen: - image: timeplus/cardemo:latest + image: docker.timeplus.com/timeplus/cardemo:latest entrypoint: /bin/sh command: -c "sleep 15 && echo \"$$CONSOLE_CONFIG_FILE\" > /timeplus/sink.yaml; /timeplus/cardemo --config /timeplus/.cardemo.yaml -f /timeplus/sink.yaml" environment: diff --git a/examples/nginx-grafana/docker-compose.yaml b/examples/nginx-grafana/docker-compose.yaml index b1e1606ebfd..a565410e023 100644 --- a/examples/nginx-grafana/docker-compose.yaml +++ b/examples/nginx-grafana/docker-compose.yaml @@ -1,6 +1,6 @@ services: proton: - image: ghcr.io/timeplus-io/proton:latest + image: d.timeplus.com/timeplus-io/proton:latest pull_policy: always ports: - 3218:3218 # HTTP Streaming