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.

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

Merged
merged 8 commits into from
Sep 15, 2020

Conversation

troyaws
Copy link
Contributor

@troyaws troyaws commented Sep 3, 2020

Issue number:

#1106

Description of changes:

Updating BUILDING.md to articulate missing dependencies.

Testing done:

Executed a build following the instructions.

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

Enumerating Rust's OS package dependencies
Adding disk space requirements.
@troyaws troyaws changed the title Patch 1 Updates to BUILDING.md to incorporate dependencies Sep 3, 2020
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated
Comment on lines 11 to 13
#### Adequate Disk Space

The build process artifacts and resulting images can consume in excess of 4GB in the local directory.
Copy link
Contributor

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.

BUILDING.md Outdated

Ensure the following OS packages are installed:

- `build-essential`
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

BUILDING.md Outdated

The build process artifacts and resulting images can consume in excess of 4GB in the local directory.

#### Operating System Packages
Copy link
Contributor

Choose a reason for hiding this comment

The 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 System Requirements section.

BUILDING.md Outdated Show resolved Hide resolved
troyaws and others added 3 commits September 4, 2020 06:43
Copy link
Contributor Author

@troyaws troyaws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated per feedback.

BUILDING.md Outdated
@@ -8,6 +8,29 @@ You can skip to the [setup guide for Kubernetes](QUICKSTART-EKS.md) or the [setu

### Dependencies

#### System Requirements

The build process artifacts and resulting images can consume in excess of 4GB in the local directory.
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Updating disk space requirement to 80GB
Copy link
Contributor Author

@troyaws troyaws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disk space requirement updated.

@troyaws troyaws requested a review from zmrow September 9, 2020 18:21
Copy link
Contributor

@zmrow zmrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's squash the commits into a single commit and I'm good to approve! 👍

Copy link
Contributor

@zmrow zmrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

I'll squash the commits when I merge this

@zmrow zmrow merged commit 5205666 into bottlerocket-os:develop Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add recommended HDD space when building the project
3 participants