-
Notifications
You must be signed in to change notification settings - Fork 510
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.
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
Updates to BUILDING.md to incorporate dependencies #1107
Changes from 2 commits
290c14c
ed06b60
7f66915
358a2e8
80b6888
a5574bc
65dba13
400c5d1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. | ||
|
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 Requirements
might 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.