Skip to content

Get Started en 1.0.0 beta

Wenyi Duan edited this page Jul 10, 2023 · 5 revisions

Docker Hub access is unstable, Alibaba Cloud image is recommended, image platform: amd64

  • Runtime images: registry.cn-hangzhou.aliyuncs.com/havenask/ha3_runtime:1.0.0-beta2

  • Development images: registry.cn-hangzhou.aliyuncs.com/havenask/ha3_dev:1.0.0-beta2

Run the container

Havenask provides runtime images and allows you to quickly build a search service without recompiling workloads.

To start the engine by using an image, perform the following steps:

  • Create a container.

    CONTAINER_NAME specifies the name of the container.


cd ~
git clone git@github.com:alibaba/havenask.git
cd ~/havenask/docker/havenask
docker pull registry.cn-hangzhou.aliyuncs.com/havenask/ha3_runtime:1.0.0-beta2
./create_container.sh <CONTAINER_NAME> registry.cn-hangzhou.aliyuncs.com/havenask/ha3_runtime:1.0.0-beta2

  • Log on to the container.

./<CONTAINER_NAME>/sshme

Test the container

After you start the runtime container, build the index of the test data and query engine. For more information, see Example.

Compile code

Prepare the compiling environment

  • To ensure the compilation speed, make sure the CPU has at least 8 cores.

Obtain the development image


docker pull registry.cn-hangzhou.aliyuncs.com/havenask/ha3_dev:1.0.0-beta2

Download code


cd ~
git clone git@github.com:alibaba/havenask.git 

Run the container


cd ~/havenask/docker/havenask
./create_container.sh <CONTAINER_NAME> registry.cn-hangzhou.aliyuncs.com/havenask/ha3_dev:1.0.0-beta2


Use SSH to log on to the container


./<CONTAINER_NAME>/sshme

Run the compilation commands


cd ~/havenask
./build.sh

Compile the subproject separately


# Compile the tar package for release
bazel build //package/havenask:havenask_package_tar --config=havenask
# Compile the havenask engine
bazel build //aios/ha3:havenask --config=havenask
# compile bs_local_job
bazel build //aios/apps/facility/build_service:bs_local_job --config=havenask

Clone this wiki locally