From 25e69c340c758554452a059bce56bb6b0101dc44 Mon Sep 17 00:00:00 2001 From: Rolf Neugebauer Date: Wed, 4 Apr 2018 19:08:07 +0100 Subject: [PATCH] doc: Make supported architectures more explicit Signed-off-by: Rolf Neugebauer --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c1b1d8eec..d7401fc39 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ LinuxKit, a toolkit for building custom minimal, immutable Linux distributions. - Designed to be managed by external tooling, such as [Infrakit](https://github.com/docker/infrakit) or similar tools - Includes a set of longer-term collaborative projects in various stages of development to innovate on kernel and userspace changes, particularly around security +LinuxKit currently supports the `x86_64`, `arm64`, and `s390x` architectures on a variety of platforms, both as virtual machines and baremetal (see [below](#booting-and-testing) for details. + ## Subprojects - [LinuxKit kubernetes](https://github.com/linuxkit/kubernetes) aims to build minimal and immutable Kubernetes images. (previously `projects/kubernetes` in this repository). @@ -56,25 +58,25 @@ Since `linuxkit build` is built around the [Moby tool](https://github.com/moby/t ### Booting and Testing -You can use `linuxkit run ` or `linuxkit run .` to execute the image you created with `linuxkit build .yml`. -This will use a suitable backend for your platform or you can choose one, for example VMWare. -See `linuxkit run --help`. +You can use `linuxkit run ` or `linuxkit run .` to +execute the image you created with `linuxkit build .yml`. This +will use a suitable backend for your platform or you can choose one, +for example VMWare. See `linuxkit run --help`. Currently supported platforms are: - Local hypervisors - - [HyperKit (macOS)](docs/platform-hyperkit.md) - - [Hyper-V (Windows)](docs/platform-hyperv.md) - - [qemu (macOS, Linux, Windows)](docs/platform-qemu.md) - - [VMware (macOS, Windows)](docs/platform-vmware.md) + - [HyperKit (macOS)](docs/platform-hyperkit.md) `[x86_64]` + - [Hyper-V (Windows)](docs/platform-hyperv.md) `[x86_64]` + - [qemu (macOS, Linux, Windows)](docs/platform-qemu.md) `[x86_64, arm64, s390x]` + - [VMware (macOS, Windows)](docs/platform-vmware.md) `[x86_64]` - Cloud based platforms: - - [Amazon Web Services](docs/platform-aws.md) - - [Google Cloud](docs/platform-gcp.md) - - [Microsoft Azure](docs/platform-azure.md) - - [OpenStack](docs/platform-openstack.md) - - [packet.net](docs/platform-packet.md) + - [Amazon Web Services](docs/platform-aws.md) `[x86_64]` + - [Google Cloud](docs/platform-gcp.md) `[x86_64]` + - [Microsoft Azure](docs/platform-azure.md) `[x86_64]` + - [OpenStack](docs/platform-openstack.md) `[x86_64]` - Baremetal: - - x86 and arm64 servers on [packet.net](docs/platform-packet.md) - - [Raspberry Pi Model 3b](docs/platform-rpi3.md) + - [packet.net](docs/platform-packet.md) `[x86_64, arm64]` + - [Raspberry Pi Model 3b](docs/platform-rpi3.md) `[arm64]` #### Running the Tests