From 3f498cf2dcfb8be786d6cc90e23319d2956ae6db Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 31 Jul 2020 09:25:15 +0300 Subject: [PATCH] docs/{vmagent,vmalert}: add instruction on how to build for ARM --- app/vmagent/README.md | 16 ++++++++++++++++ app/vmalert/README.md | 17 +++++++++++++++++ docs/vmagent.md | 16 ++++++++++++++++ docs/vmalert.md | 17 +++++++++++++++++ 4 files changed, 66 insertions(+) diff --git a/app/vmagent/README.md b/app/vmagent/README.md index 6306a75b5..d17ce5c54 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -274,6 +274,22 @@ by setting it via `` environment variable. For example, the followin ROOT_IMAGE=scratch make package-vmagent ``` +#### ARM build + +ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://blog.cloudflare.com/arm-takes-wing/). + +#### Development ARM build + +1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.13. +2. Run `make vmagent-arm` or `make vmagent-arm64` from the root folder of the repository. + It builds `vmagent-arm` or `vmagent-arm64` binary respectively and puts it into the `bin` folder. + +#### Production ARM build + +1. [Install docker](https://docs.docker.com/install/). +2. Run `make vmagent-arm-prod` or `make vmagent-arm64-prod` from the root folder of the repository. + It builds `vmagent-arm-prod` or `vmagent-arm64-prod` binary respectively and puts it into the `bin` folder. + ### Profiling diff --git a/app/vmalert/README.md b/app/vmalert/README.md index 88c85d8e0..0bd9d98da 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -286,3 +286,20 @@ It is recommended using 1. [Install docker](https://docs.docker.com/install/). 2. Run `make vmalert-prod` from the root folder of the repository. It builds `vmalert-prod` binary and puts it into the `bin` folder. + + +#### ARM build + +ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://blog.cloudflare.com/arm-takes-wing/). + +#### Development ARM build + +1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.13. +2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of the repository. + It builds `vmalert-arm` or `vmalert-arm64` binary respectively and puts it into the `bin` folder. + +#### Production ARM build + +1. [Install docker](https://docs.docker.com/install/). +2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of the repository. + It builds `vmalert-arm-prod` or `vmalert-arm64-prod` binary respectively and puts it into the `bin` folder. diff --git a/docs/vmagent.md b/docs/vmagent.md index 6306a75b5..d17ce5c54 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -274,6 +274,22 @@ by setting it via `` environment variable. For example, the followin ROOT_IMAGE=scratch make package-vmagent ``` +#### ARM build + +ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://blog.cloudflare.com/arm-takes-wing/). + +#### Development ARM build + +1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.13. +2. Run `make vmagent-arm` or `make vmagent-arm64` from the root folder of the repository. + It builds `vmagent-arm` or `vmagent-arm64` binary respectively and puts it into the `bin` folder. + +#### Production ARM build + +1. [Install docker](https://docs.docker.com/install/). +2. Run `make vmagent-arm-prod` or `make vmagent-arm64-prod` from the root folder of the repository. + It builds `vmagent-arm-prod` or `vmagent-arm64-prod` binary respectively and puts it into the `bin` folder. + ### Profiling diff --git a/docs/vmalert.md b/docs/vmalert.md index 88c85d8e0..0bd9d98da 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -286,3 +286,20 @@ It is recommended using 1. [Install docker](https://docs.docker.com/install/). 2. Run `make vmalert-prod` from the root folder of the repository. It builds `vmalert-prod` binary and puts it into the `bin` folder. + + +#### ARM build + +ARM build may run on Raspberry Pi or on [energy-efficient ARM servers](https://blog.cloudflare.com/arm-takes-wing/). + +#### Development ARM build + +1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.13. +2. Run `make vmalert-arm` or `make vmalert-arm64` from the root folder of the repository. + It builds `vmalert-arm` or `vmalert-arm64` binary respectively and puts it into the `bin` folder. + +#### Production ARM build + +1. [Install docker](https://docs.docker.com/install/). +2. Run `make vmalert-arm-prod` or `make vmalert-arm64-prod` from the root folder of the repository. + It builds `vmalert-arm-prod` or `vmalert-arm64-prod` binary respectively and puts it into the `bin` folder.