Skip to content

updating docker compose with new clickstack repo and docker images #4906

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
dhtclk merged 1 commit into from
Dec 5, 2025
+18 −22
Merged

updating docker compose with new clickstack repo and docker images #4906

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 18 additions & 22 deletions docs/use-cases/observability/clickstack/deployment/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ These ports enable integrations with a variety of telemetry sources and make the

### Clone the repo {#clone-the-repo}

To deploy with Docker Compose clone the HyperDX repo, change into the directory and run `docker-compose up`:
To deploy with Docker Compose clone the ClickStack repo, change into the directory and run `docker-compose up`:

```shell
git clone git@github.com:hyperdxio/hyperdx.git
git clone https://github.com/ClickHouse/ClickStack.git
docker compose up
```

Expand All @@ -60,7 +60,7 @@ Visit [http://localhost:8080](http://localhost:8080) to access the HyperDX UI.

Create a user, providing a username and password which meets the requirements.

On clicking `Create` data sources will be created for the ClickHouse instance deployed with the Helm chart.
On clicking `Create` data sources will be created for the ClickHouse instance deployed with Docker Compose.

:::note Overriding default connection
You can override the default connection to the integrated ClickHouse instance. For details, see ["Using ClickHouse Cloud"](#using-clickhouse-cloud).
Expand All @@ -87,22 +87,18 @@ If prompted to create a source, retain all default values and complete the `Tabl
Users can modify settings for the stack, such as the version used, through the environment variable file:

```shell
user@example-host hyperdx % cat .env
# Used by docker-compose.yml
user@example-host clickstack % cat .env

# Used by docker-compose.yml
HDX_IMAGE_REPO=docker.hyperdx.io
IMAGE_NAME=ghcr.io/hyperdxio/hyperdx
IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx
LOCAL_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-local
LOCAL_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-local
ALL_IN_ONE_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-all-in-one
ALL_IN_ONE_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-all-in-one
OTEL_COLLECTOR_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-otel-collector
OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-otel-collector
CODE_VERSION=2.0.0-beta.16
IMAGE_VERSION_SUB_TAG=.16
IMAGE_VERSION=2-beta
IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-all-in-one
LOCAL_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-local
ALL_IN_ONE_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-all-in-one
OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-otel-collector
CODE_VERSION=2.8.0
IMAGE_VERSION_SUB_TAG=.8.0
IMAGE_VERSION=2
IMAGE_NIGHTLY_TAG=2-nightly
IMAGE_LATEST_TAG=latest

# Set up domain URLs
HYPERDX_API_PORT=8000 #optional (should not be taken by other services)
Expand All @@ -123,12 +119,12 @@ The OTel collector configuration can be modified if required - see ["Modifying c

This distribution can be used with ClickHouse Cloud. Users should:

- Remove the ClickHouse service from the `docker-compose.yaml` file. This is optional if testing, as the deployed ClickHouse instance will simply be ignored - although waste local resources. If removing the service, ensure any references to the service such as `depends_on` are removed.
- Remove the ClickHouse service from the `docker-compose.yml` file. This is optional if testing, as the deployed ClickHouse instance will simply be ignored - although waste local resources. If removing the service, ensure any references to the service such as `depends_on` are removed.
- Modify the OTel collector to use a ClickHouse Cloud instance by setting the environment variables `CLICKHOUSE_ENDPOINT`, `CLICKHOUSE_USER` and `CLICKHOUSE_PASSWORD` in the compose file. Specifically, add the environment variables to the OTel collector service:

```shell
otel-collector:
image: ${OTEL_COLLECTOR_IMAGE_NAME}:${IMAGE_VERSION}
image: ${OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
environment:
CLICKHOUSE_ENDPOINT: '<CLICKHOUSE_ENDPOINT>' # https endpoint here
CLICKHOUSE_USER: '<CLICKHOUSE_USER>'
Expand All @@ -153,11 +149,11 @@ This distribution can be used with ClickHouse Cloud. Users should:

<JSONSupport/>

To set these, modify the relevant services in the `docker-compose.yaml`:
To set these, modify the relevant services in the `docker-compose.yml`:

```yaml
app:
image: ${HDX_IMAGE_REPO}/${IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
image: ${IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
ports:
- ${HYPERDX_API_PORT}:${HYPERDX_API_PORT}
- ${HYPERDX_APP_PORT}:${HYPERDX_APP_PORT}
Expand All @@ -169,7 +165,7 @@ To set these, modify the relevant services in the `docker-compose.yaml`:
# truncated for brevity

otel-collector:
image: ${HDX_IMAGE_REPO}/${OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
image: ${OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
environment:
OTEL_AGENT_FEATURE_GATE_ARG: '--feature-gates=clickhouse.json' # enable JSON
CLICKHOUSE_ENDPOINT: 'tcp://ch-server:9000?dial_timeout=10s'
Expand Down