mirror of https://github.com/ByConity/ByConity
d44e8fc44b
ci(clickhousech@m-4770399785): add ci metric case See merge request: !23853 # Conflicts: # docker/docker-compose/byconity-simple-cluster/worker.yml |
||
---|---|---|
.. | ||
byconity-multi-cluster | ||
byconity-multiworkers-cluster | ||
byconity-simple-cluster | ||
hdfs | ||
hive/config | ||
hudi | ||
scripts | ||
.env.tpl | ||
.gitignore | ||
README.md | ||
docker-compose.essentials.yml | ||
docker-compose.hive.yml | ||
docker-compose.multi.yml | ||
docker-compose.multiworkers.yml | ||
docker-compose.simple.yml |
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
andSERVER_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
- Update the BYCONITY_IMAGE variable in the .env file to the desired release version, e.g., byconity/byconity:0.2.0.
- 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
- Update the BYCONITY_IMAGE variable in the .env file to byconity/debian-runner.
- 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