Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: re-organize the description of supported architectures #757

Merged
merged 1 commit into from
May 11, 2022
Merged

fix: re-organize the description of supported architectures #757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs_src/general/PlatformRequirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ EdgeX Foundry is an operating system (OS)-agnostic and hardware (HW)-agnostic Io
=== "Operating Systems"
EdgeX Foundry has been run successfully on many systems, including, but not limited to the following systems

* Windows (ver 7 - 10)
* Ubuntu Desktop (ver 14-20)
* Ubuntu Server (ver 14-20)
* Ubuntu Core (ver 16-18)
* Mac OS X 10
* Windows 7 and higher
* Ubuntu Desktop/Server 14 and higher
* Ubuntu Core 16 and higher
* Mac OS X

!!! Info
EdgeX is agnostic with regards to hardware (x86 and ARM), but only release artifacts for x86 and ARM 64 systems. EdgeX has been successfully run on ARM 32 platforms but has required users to build their own executable from source. EdgeX does not officially support ARM 32.
EdgeX Foundry runs on various distributions and / or versions of Linux, Unix, MacOS, Windows, etc. However, the community only supports the platform on `amd64` (x86-64) and `arm64` architectures.

EdgeX Foundry releases pre-built artifacts as Docker images and Snaps. Please refer to [Getting Started](../../getting-started) for details.

EdgeX can run on `armhf` architecture but that requires users to build their own executables from source. EdgeX does not officially support `armhf`.
2 changes: 1 addition & 1 deletion docs_src/getting-started/Ch-GettingStartedDevelopers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ or changing the existing code base.
### Hardware

EdgeX Foundry is an operating system (OS) and hardware (HW)-agnostic edge software platform.
See the reference page for [platform requirements](./quick-start/index.md#reference-platform-requirements). These provide guidance on a minimal platform to run the EdgeX platform. However, as a developer, you may find that additional memory, disk space, and improved CPU are essential to building and debugging.
See the reference page for [platform requirements](../../general/PlatformRequirements). These provide guidance on a minimal platform to run the EdgeX platform. However, as a developer, you may find that additional memory, disk space, and improved CPU are essential to building and debugging.

### Software

Expand Down
8 changes: 1 addition & 7 deletions docs_src/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Getting Started

!!! Attention

## Supported Architectures

EdgeX Foundry is a hardware and operating system agnostic IoT / edge platform. It is was built to run on Intel and ARM hardware. It runs on various distributions and / or versions of Linux, Unix, MacOS, Windows, etc.

However, the EdgeX Foundry community only supports the platform on Intel (x86, x86_64) and ARM64 hardware. Adopters may build EdgeX for ARM32, but the community does not support or provide pre-built artifacts such as Docker containers, snaps, etc. for ARM32. Building EdgeX for ARM32 will typically require some modifications to the build process. Some services may not compile on ARM32 and/or require removal of components such as ZMQ that are not available or compile on ARM32.
EdgeX Foundry is operating system and architecture agnostic. The community releases artifacts for common architectures. However, it is possible to build the components for other platforms. See the [platform requirements](../general/PlatformRequirements) reference page for details.

To get started you need to get EdgeX Foundry either as a User or as a Developer/Contributor.

Expand Down