craigcondit commented on code in PR #483: URL: https://github.com/apache/yunikorn-site/pull/483#discussion_r1792086990
########## docs/developer_guide/deployment.md: ########## @@ -31,17 +31,22 @@ scheduler and admission controller. It is primarily intended for developers. ## Build docker image Under project root of the `yunikorn-k8shim`, run the command to build an image using the map for the configuration: + +Build docker image can be triggered by running following command. Review Comment: Let's combine with the previous sentence (i.e. ... run the command to build YuniKorn Docker images: ########## docs/developer_guide/deployment.md: ########## @@ -31,17 +31,22 @@ scheduler and admission controller. It is primarily intended for developers. ## Build docker image Under project root of the `yunikorn-k8shim`, run the command to build an image using the map for the configuration: + +Build docker image can be triggered by running following command. + ``` make image ``` -This command will build an image. The image will be tagged with a default version, image tag and your build architecture. - -**Note** the default build uses a hardcoded user and tag. You *must* update the `IMAGE_TAG` variable in the `Makefile` to push to an appropriate repository. +**Note** that the default build uses a hardcoded registry and tag. If you want to build docker image with specific arch, version or registry, you can refer the following command. +``` +make image DOCKER_ARCH=amd64 REGISTRY=apache VERSION=latest +``` +This command will build an `amd64` binary executable with version `latest` and the docker image tag is `yunikorn/yunikorn:scheduler-amd64-latest`. Review Comment: Given the example, the tag would be `apache/yunikorn:scheduler-amd64-latest`. ########## docs/developer_guide/deployment.md: ########## @@ -31,17 +31,22 @@ scheduler and admission controller. It is primarily intended for developers. ## Build docker image Under project root of the `yunikorn-k8shim`, run the command to build an image using the map for the configuration: + +Build docker image can be triggered by running following command. + ``` make image ``` -This command will build an image. The image will be tagged with a default version, image tag and your build architecture. - -**Note** the default build uses a hardcoded user and tag. You *must* update the `IMAGE_TAG` variable in the `Makefile` to push to an appropriate repository. +**Note** that the default build uses a hardcoded registry and tag. If you want to build docker image with specific arch, version or registry, you can refer the following command. +``` +make image DOCKER_ARCH=amd64 REGISTRY=apache VERSION=latest +``` +This command will build an `amd64` binary executable with version `latest` and the docker image tag is `yunikorn/yunikorn:scheduler-amd64-latest`. -**Note** the latest yunikorn images in docker hub are not updated anymore due to ASF policy. Hence, you should build both scheduler image and web image locally before deploying them. +**Note** that the latest yunikorn images in docker hub are not updated anymore due to ASF policy. Hence, you should build both scheduler image and web image locally before deploying them. Review Comment: Nit: yunikorn -> YuniKorn -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
