Updates to BUILDING.md to incorporate dependencies #1107
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,21 @@ You can skip to the [setup guide for Kubernetes](QUICKSTART-EKS.md) or the [setu | |
|
|
||
| ### Dependencies | ||
|
|
||
| #### Adequate Disk Space | ||
|
|
||
| The build process artifacts and resulting images can consume in excess of 4GB in the local directory. | ||
|
There was a problem hiding this comment. Let's bump up this number quite a bit as @bcressey mentioned: we're probably safe to say around 80GB. |
||
|
|
||
| #### Operating System Packages | ||
|
There was a problem hiding this comment. Maybe call this "Linux" since it'll live at the same level as "Rust" and "Docker". Or we can fold it into the previous |
||
|
|
||
| The Rust tooling requires certain operating system packages to be installed in order to complete builds. | ||
troyaws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Error messages from the Rust tooling do not clearly identify the issues. | ||
troyaws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Ensure the following OS packages are installed: | ||
|
|
||
| - `build-essential` | ||
|
There was a problem hiding this comment. Fedora doesn't have a direct equivalent to this. It might be better to split it into separate commands, with an Ubuntu example and a Fedora example. |
||
| - `openssl-dev` or `libssl-dev` | ||
| - `pkg-config` | ||
|
|
||
| #### Rust | ||
|
|
||
| The build system is based on the Rust language. | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
System Requirementsmight be a better heading, then we can add recommendations for storage + memory + compute.Systems should have at least 80 GB of storage available. There's quite a lot of overhead from the intermediate Docker layers that are created.