doc: clarify support for little-endian CPUs only
@@ -15,6 +15,7 @@ isolation properties provided by hardware virtualization technology with the
speed and flexibility of containers.
## Overview
+
The main component of Firecracker is a virtual machine monitor (VMM) that uses
the Linux Kernel Virtual Machine (KVM) to create and run microVMs. Firecracker
has a minimalist design. It excludes unnecessary devices and guest-facing
@@ -141,6 +142,10 @@ virtualization, but any such platform is currently not supported and not fit
for production. If you want to run Firecracker on such platforms, please
[open a feature request](https://github.com/firecracker-microvm/firecracker/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature+Request%5D+Title).
+Firecracker currently only supports little-endian platforms, which includes x86_64
+and many aarch64 CPUs. Other systems and architectures may not provide a little-endian
+mode, and Firecracker may not work correctly on such systems.
+
## Performance
Firecracker's performance characteristics are listed as part of the
@@ -161,6 +166,7 @@ your disclosure.
Frequently asked questions are collected in our [FAQ doc](FAQ.md).
You can get in touch with the Firecracker community in the following ways:
+
- Security-related issues, see our [security policy document](SECURITY.md).
- Chat with us on our
[Slack workspace](https://join.slack.com/t/firecracker-microvm/shared_invite/enQtNDY2NTUwMzQ3MDE1LWIwMzA0OWFkMTZhMTlmMDZiMmFkYjMyODMxMGQ1ZjliMzJjNjJiNWRhNWNkOGEyNmUxNmRkMjZhYTc3MmVjZjM).
