ByConity/docker/docker-compose
fredwang d44e8fc44b Merge '547/cnch_metrics_ci' into 'cnch-dev'
ci(clickhousech@m-4770399785): add ci metric case

See merge request: !23853
# Conflicts:
#	docker/docker-compose/byconity-simple-cluster/worker.yml
2024-10-02 02:49:01 +00:00
..
byconity-multi-cluster Merge '547/cnch_metrics_ci' into 'cnch-dev' 2024-10-02 02:49:01 +00:00
byconity-multiworkers-cluster Merge '547/cnch_metrics_ci' into 'cnch-dev' 2024-10-02 02:49:01 +00:00
byconity-simple-cluster Merge '547/cnch_metrics_ci' into 'cnch-dev' 2024-10-02 02:49:01 +00:00
hdfs docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00
hive/config docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00
hudi support MOR table in external catalog 2023-09-20 13:35:29 +08:00
scripts fix: fix docker compose 2024-03-11 17:19:50 +08:00
.env.tpl Update .env.tpl (#781) 2023-10-17 02:02:23 +00:00
.gitignore docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00
README.md fix docker-compose docs 2024-06-27 12:14:30 +00:00
docker-compose.essentials.yml docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00
docker-compose.hive.yml docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00
docker-compose.multi.yml fix docker-compose daemon manage config error 2023-12-25 19:16:21 +08:00
docker-compose.multiworkers.yml fix docker-compose daemon manage config error 2023-12-25 19:16:21 +08:00
docker-compose.simple.yml docker dev image and docker-compose for development (#680) 2023-09-14 17:51:01 +08:00

README.md

ByConity Docker Compose

1. Create an Environment File:

Start by creating an environment file named .env from the provided template .env.tpl.

cp .env.tpl .env

2. Modify the Environment Variables:

Modify .env file accordingly. Here are the variables you can configure:

  • COMPOSE_PROJECT_NAME: This sets the project name for your Docker Compose setup.
  • DATA_DIR: Specify the local path that will be mounted into the Docker containers. This path is used for local disk cache, logs, etc.
  • SERVER_TCP_PORT and SERVER_HTTP_PORT: These variables define the exposed ports for the ByConity server's TCP and HTTP ports.

Running a Specific Version of ByConity:

If you want to run a specific release version of ByConity

  1. Update the BYCONITY_IMAGE variable in the .env file to the desired release version, e.g., byconity/byconity:0.2.0.
  2. Set BYCONITY_BINARY_PATH to an empty string.

Running ByConity with a Locally Built Binary

If you want to run ByConity with a locally built binary

  1. Update the BYCONITY_IMAGE variable in the .env file to byconity/debian-runner.
  2. Set BYCONITY_BINARY_PATH to the path where your locally built binary resides.

You can compile the project with ByConity dev-env docker image

Starting ByConity with Docker Compose

To start ByConity using Docker Compose, use the following command:

docker-compose -f docker-compose.essentials.yml [-f docker-compose.simple.yml] up [-d]

The -d option runs the containers in the background.

  • docker-compose.essentials.yml: esential dependencies to start byconity cluster
  • docker-compose.simple.yml: simple byconity cluster
  • docker-compose.multiworkers.yml: multi-worker byconity cluster

To access the ByConity cluster with cli

./scripts/byconity-cli.sh

To access HDFS files

./scripts/hdfs-cli.sh "hdfs dfs -ls /user/clickhouse"

To access fdb cli

./scripts/fdb-cli.sh

Printing Logs to the Console

To print a service's logs to the console, you need to update the configuration file under byconity-*-cluster. Set logger: console: true in the configuration file.

Integrate with Hive

docker-compose -f docker-compose.hive.yml -d up

./scripts/beeline.sh

Integrate with Hudi