add document to build on arm #46
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yang Keao <[email protected]>
6 tasks
Comment on lines
+20
to
+22
| ## Note | ||
|
|
||
| All functions haven't been well tested on arm, and the `IO/TimeChaos` will not work. If you have any other problem while running Chaos Mesh on an arm cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). |
There was a problem hiding this comment.
Suggested change
| ## Note | |
| All functions haven't been well tested on arm, and the `IO/TimeChaos` will not work. If you have any other problem while running Chaos Mesh on an arm cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). | |
| > **Note**: | |
| > | |
| > - All functions haven't been well tested on arm, and the `IO/TimeChaos` will not work. If you have any other problem while running Chaos Mesh on an arm cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). |
|
@dcalvin PTAL |
|
There is still a problem. |
dcalvin
reviewed
Apr 1, 2021
| sidebar_label: Build ARM Image | ||
| --- | ||
|
|
||
| This document will talk about how to build an ARM image on a x86 host. With the help of docker, it won't be too difficult :) |
There was a problem hiding this comment.
Suggested change
| This document will talk about how to build an ARM image on a x86 host. With the help of docker, it won't be too difficult :) | |
| This document walks you through how to build an ARM image on an x86 host. |
| This document will talk about how to build an ARM image on a x86 host. With the help of docker, it won't be too difficult :) | ||
|
|
||
| ## Prerequisites | ||
|
|
There was a problem hiding this comment.
Suggested change
| Before building, make sure the following items are installed or configured: |
|
|
||
| ## Prerequisites | ||
|
|
||
| * `qemu` has been installed on ths host to emulate arm program. |
| * `qemu` has been installed on ths host to emulate arm program. | ||
| * `docker` > 19.03 with `buildx` installed. You can follow the [instruction](https://github.com/docker/buildx#installing) to install `buildx` toolkit for `docker` | ||
| * Linux Kernel >= 4.8 | ||
| * Arm executables could be run with `binfmt_misc`. You can check it through `cat /proc/sys/fs/binfmt_misc/qemu-aarch64`. If not enabled, `docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64` can register qemu for running arm executables. |
There was a problem hiding this comment.
Suggested change
| * Arm executables could be run with `binfmt_misc`. You can check it through `cat /proc/sys/fs/binfmt_misc/qemu-aarch64`. If not enabled, `docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64` can register qemu for running arm executables. | |
| * ARM executables could be run with `binfmt_misc`. | |
| You can check by running `cat /proc/sys/fs/binfmt_misc/qemu-aarch64`. If it is not enabled, try `docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64` to register QEMU for running ARM executables. |
|
|
||
| ## Build | ||
|
|
||
| Run `TARGET_PLATFORM=arm64 UI=1 SWAGGER=1 DOCKER_REGISTRY="" make image` will build all arm image (`pingcap/chaos-mesh`, `pingcap/chaos-daemon`, `pingcap/chaos-dashboard`...). After building, you can check the architecture of them through `docker image inspect` |
There was a problem hiding this comment.
Suggested change
| Run `TARGET_PLATFORM=arm64 UI=1 SWAGGER=1 DOCKER_REGISTRY="" make image` will build all arm image (`pingcap/chaos-mesh`, `pingcap/chaos-daemon`, `pingcap/chaos-dashboard`...). After building, you can check the architecture of them through `docker image inspect` | |
| Run `TARGET_PLATFORM=arm64 UI=1 SWAGGER=1 DOCKER_REGISTRY="" make image` to build all ARM images, including`pingcap/chaos-mesh`, `pingcap/chaos-daemon`, `pingcap/chaos-dashboard`, etc. | |
| You can check the building result by running `docker image inspect`. |
|
|
||
| Run `TARGET_PLATFORM=arm64 UI=1 SWAGGER=1 DOCKER_REGISTRY="" make image` will build all arm image (`pingcap/chaos-mesh`, `pingcap/chaos-daemon`, `pingcap/chaos-dashboard`...). After building, you can check the architecture of them through `docker image inspect` | ||
|
|
||
| ## Note |
There was a problem hiding this comment.
Suggested change
| ## Note | |
| ## Limitations and bug report |
|
|
||
| ## Note | ||
|
|
||
| All functions haven't been well tested on arm, and the `IO/TimeChaos` will not work. If you have any other problem while running Chaos Mesh on an arm cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). |
There was a problem hiding this comment.
Suggested change
| All functions haven't been well tested on arm, and the `IO/TimeChaos` will not work. If you have any other problem while running Chaos Mesh on an arm cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). | |
| Chaos Mesh components and functions haven't been well tested on ARM. So far `IO/TimeChaos` is known not to work. If you have any other problem running Chaos Mesh on an ARM cluster, please file an issue on [github](https://github.com/chaos-mesh/chaos-mesh). |
|
@YangKeao PTAL |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Yang Keao [email protected]