You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ha...@apache.org on 2024/09/10 14:05:34 UTC
(skywalking-banyandb) branch doc created (now 5d0fb4f5)
This is an automated email from the ASF dual-hosted git repository.
hanahmily pushed a change to branch doc
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
at 5d0fb4f5 Document how to build images
This branch includes the following new commits:
new 5d0fb4f5 Document how to build images
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(skywalking-banyandb) 01/01: Document how to build images
Posted by ha...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hanahmily pushed a commit to branch doc
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
commit 5d0fb4f5e035798bb00fbc41b3ee133193e54d37
Author: Gao Hongtao <ha...@gmail.com>
AuthorDate: Tue Sep 10 14:05:10 2024 +0000
Document how to build images
Signed-off-by: Gao Hongtao <ha...@gmail.com>
---
docs/installation/docker.md | 46 +++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/docs/installation/docker.md b/docs/installation/docker.md
index e4d7d999..2fdcddfe 100644
--- a/docs/installation/docker.md
+++ b/docs/installation/docker.md
@@ -42,3 +42,49 @@ The BanyanDB server would be listening on the `0.0.0.0:17912` to access gRPC req
At the same time, the BanyanDB server would be listening on the `0.0.0.0:17913` to access HTTP requests. if no errors occurred. The HTTP server is used for CLI and Web UI.
The Web UI is hosted at `http://localhost:17913/`.
+
+## Build and Push the Custom Docker image
+
+The BanyanDB Docker image can be built from the source code. You can build the Docker image by running the following commands:
+
+```shell
+make generate
+make release
+HUB=<private_hub> IMG_NAME=<private_name> TAG=<private_tag> make docker.build
+```
+
+The `make release` command builds binaries and generates the necessary files for building the Docker image. The `make docker.build` command builds the Docker image with the architecture aligned with the host machine.
+
+`HUB` is the Docker Hub username or the Docker Hub organization name. `IMG_NAME` is the Docker image name. `TAG` is the Docker image tag.
+
+Note: You can't build other OS or architecture images not identical to the host machine. That's because the docker build command fails to load the image after the build process.
+
+The `make docker.push` command pushes the Docker image to the Docker Hub. You need to log in to the Docker Hub before running this command.
+
+```shell
+docker login
+make generate
+make release
+make docker.push
+```
+
+If you want to push other OS or architecture images, you can run the following commands:
+
+```shell
+docker login
+make generate
+TARGET_OS=linux PLATFORMS=linux/amd64,linux/arm64 make release
+PLATFORMS=linux/amd64,linux/arm64 make docker.push
+```
+
+The `TARGET_OS` environment variable specifies the target OS. The `PLATFORMS` environment variable specifies the target architectures. The `PLATFORMS` environment variable is a comma-separated list of the target architectures.
+
+If you want to build and publish slim images, you can run the following commands:
+
+```shell
+docker login
+make generate
+make release
+BINARYTYPE=slim make docker.build
+BINARYTYPE=slim make docker.push
+```