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

fix(docs): errors in installation instructions #2086

Closed
vsu727 opened this issue Jun 23, 2024 · 1 comment
Closed

fix(docs): errors in installation instructions #2086

vsu727 opened this issue Jun 23, 2024 · 1 comment
Labels
t-docs Add or update documentation

Comments

@vsu727
Copy link
Contributor

vsu727 commented Jun 23, 2024

What is the bug?

Due to errors or outdated information in the Farcaster Hub installation guides, the Hub cannot be synchronized due to lack of memory which will prevent it from starting and working correctly. This error is very important because it creates difficulties for new users at the very initial stage of work and familiarization with Farcaster Hub

Memory value is 60 GB in the GCP installation guide and 140 GB is the value in the main installation guide. Farcaster Hub currently takes up about 150 GB.

1 screenshot
2 screenshot
3 screenshot
4 screenshot

@github-actions github-actions bot added the s-triage Needs to be reviewed, designed and prioritized label Jun 23, 2024
Wazzymandias pushed a commit that referenced this issue Jul 3, 2024
Fixes issue #2086 

## Motivation

Due to errors or outdated information in the Farcaster Hub installation
guides, the Hub cannot be synchronized due to lack of memory which will
prevent it from starting and working correctly. This error is very
important because it creates difficulties for new users at the very
initial stage of work and familiarization with Farcaster Hub

## Change Summary

Changes have been made regarding the minimum amount of memory required
for Farcaster Hub to work correctly. The old value is 60 GB in the GCP
installation guide and 140 GB is the old value in the main installation
guide. Farcaster Hub currently takes up about 150 GB. The old memory
values have been changed to 160 GB, which allows you to run the Hub and
have a reserve of correct operation for a period of time

## Merge Checklist

_Choose all relevant options below by adding an `x` now or at any time
before submitting for review_

- [ x] PR title adheres to the [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/) standard
- [ ] PR has a
[changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets)
- [ ] PR has been tagged with a change label(s) (i.e. documentation,
feature, bugfix, or chore)
- [ x] PR includes
[documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs)
if necessary.
- [ x] All [commits have been
signed](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#22-signing-commits)

## Additional Context

According to the GCP guide we create a virtual server and set the server
parameters via Google Cloud Console by copying the data from the guide
into the created file "main.tf"
![1
screenshot](https://github.com/farcasterxyz/hub-monorepo/assets/80642652/ae6bbd6e-a3ee-4129-978d-896d932d8c35)

The virtual server has been configured with these memory settings
![2
screenshot](https://github.com/farcasterxyz/hub-monorepo/assets/80642652/ae81634a-d66f-436f-a107-5417f26cf4b4)

Then after running the script specified in the main installation guide
on the created server Hub starts synchronization, but after a while it
stops with the error "code 2".
![3
screenshot](https://github.com/farcasterxyz/hub-monorepo/assets/80642652/3696c741-1234-4834-8218-ed71c179e1af)

This error means that Hub cannot continue synchronization due to lack of
memory
![4
screenshot](https://github.com/farcasterxyz/hub-monorepo/assets/80642652/57aa5e65-b419-4385-ba5c-ca678c4bb60a)

Warpcast: @vsu 

<!-- start pr-codex -->

---

## PR-Codex overview
This PR increases the disk size for the Ubuntu 20.04 LTS image in the
GCP tutorial and adjusts the storage requirement to 160 GB in the
installation guide.

### Detailed summary
- Increased disk size for Ubuntu 20.04 LTS image to 160 GB in GCP
tutorial
- Adjusted storage requirement to 160 GB in the installation guide

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
@sds
Copy link
Member

sds commented Jul 9, 2024

Thanks for the PR in #2087. Closing.

@sds sds closed this as completed Jul 9, 2024
@sds sds added t-docs Add or update documentation and removed s-triage Needs to be reviewed, designed and prioritized labels Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-docs Add or update documentation
Projects
None yet
Development

No branches or pull requests

2 participants