Skip to content

Commit 8296ef2

Browse files
authored
Merge pull request #4906 from ClickHouse/link-to-clickstack
updating docker compose with new clickstack repo and docker images
2 parents 4a98d58 + a139e32 commit 8296ef2

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

docs/use-cases/observability/clickstack/deployment/docker-compose.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ These ports enable integrations with a variety of telemetry sources and make the
4747

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

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

5252
```shell
53-
git clone git@github.com:hyperdxio/hyperdx.git
53+
git clone https://github.com/ClickHouse/ClickStack.git
5454
docker compose up
5555
```
5656

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

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

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

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

8989
```shell
90-
user@example-host hyperdx % cat .env
91-
# Used by docker-compose.yml
90+
user@example-host clickstack % cat .env
91+
9292
# Used by docker-compose.yml
93-
HDX_IMAGE_REPO=docker.hyperdx.io
94-
IMAGE_NAME=ghcr.io/hyperdxio/hyperdx
95-
IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx
96-
LOCAL_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-local
97-
LOCAL_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-local
98-
ALL_IN_ONE_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-all-in-one
99-
ALL_IN_ONE_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-all-in-one
100-
OTEL_COLLECTOR_IMAGE_NAME=ghcr.io/hyperdxio/hyperdx-otel-collector
101-
OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB=hyperdx/hyperdx-otel-collector
102-
CODE_VERSION=2.0.0-beta.16
103-
IMAGE_VERSION_SUB_TAG=.16
104-
IMAGE_VERSION=2-beta
93+
IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-all-in-one
94+
LOCAL_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-local
95+
ALL_IN_ONE_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-all-in-one
96+
OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB=clickhouse/clickstack-otel-collector
97+
CODE_VERSION=2.8.0
98+
IMAGE_VERSION_SUB_TAG=.8.0
99+
IMAGE_VERSION=2
105100
IMAGE_NIGHTLY_TAG=2-nightly
101+
IMAGE_LATEST_TAG=latest
106102

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

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

126-
- 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.
122+
- 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.
127123
- 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:
128124

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

154150
<JSONSupport/>
155151

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

158154
```yaml
159155
app:
160-
image: ${HDX_IMAGE_REPO}/${IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
156+
image: ${IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
161157
ports:
162158
- ${HYPERDX_API_PORT}:${HYPERDX_API_PORT}
163159
- ${HYPERDX_APP_PORT}:${HYPERDX_APP_PORT}
@@ -169,7 +165,7 @@ To set these, modify the relevant services in the `docker-compose.yaml`:
169165
# truncated for brevity
170166
171167
otel-collector:
172-
image: ${HDX_IMAGE_REPO}/${OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
168+
image: ${OTEL_COLLECTOR_IMAGE_NAME_DOCKERHUB}:${IMAGE_VERSION}
173169
environment:
174170
OTEL_AGENT_FEATURE_GATE_ARG: '--feature-gates=clickhouse.json' # enable JSON
175171
CLICKHOUSE_ENDPOINT: 'tcp://ch-server:9000?dial_timeout=10s'

0 commit comments

Comments
 (0)