Developer Guide

Getting started to develop crane

First, please make sure you’ve got a working Go environment and Docker environment.

Prepare local crane environment

Please referring to quick start

Clone crane

Clone the repository,

  1. mkdir -p $GOPATH/src/github.com/gocrane/
  2. cd $GOPATH/src/github.com/gocrane/
  3. git clone https://github.com/gocrane/crane.git
  4. cd crane

Building Binaries

Run

  1. # build for linux/amd64 by default
  2. make all

to build binaries craned, crane-agent and metric-adapter for linux/amd64.

make_all_finish

Also you could specify other platforms when building, such as,

  1. # build only crane-agent for linux/arm64 and darwin/amd64
  2. # use comma to separate multiple platforms
  3. PLATFORMS=linux/arm64,darwin/amd64 make crane-agent
  4. # below are all the supported platforms
  5. # PLATFORMS=darwin/amd64,darwin/arm64,linux/amd64,linux/arm64,linux/ppc64le,linux/s390x,linux/386,linux/arm

All the built binaries will be placed at $GOPATH/src/github.com/gocrane/crane/bin folder.

make_all_binaries_result

Building Docker Images

You can also build docker images. Here docker buildx is used to help build multi-arch container images.

If you’re running MacOS, please install Docker Desktop and then check the builder,

  1. $ docker buildx ls
  2. NAME/NODE DRIVER/ENDPOINT STATUS  PLATFORMS
  3. default * docker
  4.   default default         running linux/amd64, linux/arm64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7, linux/arm/v6

If you’re running Linux, please refer to docker buildx docs on the installation.

!!! note For better docker buildx support, it is recommended to use Ubuntu Focal 20.04 (LTS), Debian Bullseye 11 and CentOS 8. And install deb/rpm package qemu-user-static as well, such as

  1. ```bash
  2. apt-get install qemu-user-static
  3. ```
  5. or
  7. ```bash
  8. yum install qemu-user-static
  9. ```
  11. ```bash
  12. # build for linux/amd64 by default
  13. # container images for craned, crane-agent, metric-adapter and dashboard
  14. make images
  15. ```

make_image_start

make_image_finish

Also you could build container images for other platforms, such as arm64,

  1. PLATFORMS=linux/amd64,linux/arm64,linux/ppc64le make images
  2. # below are all the supported platforms
  3. # PLATFORMS=linux/amd64,linux/arm64,linux/ppc64le,linux/s390x,linux/386,linux/arm

!!! note For the first make image, It takes a bit of a long time, Please be patient.

When we finish the make image, in the docker desktop, we can see the image we built, and the Tag is the hash value at the time of the git commit.

make_image_docker_images