Skip to content

Commit

Permalink
ci: update docs pipeline (#2162)
Browse files Browse the repository at this point in the history
* ci: use correct repository name for the restriction

* ci: don't publish docs temporarily

* ci: remove crowdin

* relace <br> with <br />

* ci: bumping version

(cherry picked from commit dc6ee5b)

# Conflicts:
#	docs/src/operations/requirements.md
  • Loading branch information
yihau authored and mergify[bot] committed Jul 17, 2024
1 parent 5d680fd commit 3b52b8d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 24 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
needs:
- check
if: >
github.repository == 'solana-labs/solana' &&
github.repository == 'anza-xyz/agave' &&
needs.check.outputs.continue == 1
# the name is used by .mergify.yml as well
name: build & deploy docs
Expand All @@ -79,9 +79,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 16
node-version: 22

- name: Build
working-directory: docs
Expand Down
21 changes: 0 additions & 21 deletions docs/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,6 @@ source ../ci/rust-version.sh
../ci/docker-run-default-image.sh docs/convert-ascii-to-svg.sh
./set-solana-release-tag.sh

# Get current channel
eval "$(../ci/channel-info.sh)"

# Synchronize translations with Crowdin only on stable channel
if [ "$CHANNEL" = stable ]; then
echo "Downloading & updating translations..."
npm run crowdin:download
npm run crowdin:upload
fi

# Build from /src into /build
npm run build
echo $?

# Publish only from merge commits and beta release tags
if [[ -n $CI ]]; then
if [[ -z $CI_PULL_REQUEST ]]; then
if [[ -n $CI_TAG ]] && [[ $CI_TAG != $BETA_CHANNEL* ]]; then
echo "not a beta tag"
exit 0
fi
./publish-docs.sh
fi
fi
11 changes: 11 additions & 0 deletions docs/src/operations/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ transaction for each block the validator agrees with, which can cost up to

The hardware recommendations below are provided as a guide. Operators are encouraged to do their own performance testing.

<<<<<<< HEAD
- CPU
- 12 cores / 24 threads, or more
- 2.8GHz base clock speed, or faster
Expand Down Expand Up @@ -46,6 +47,16 @@ The hardware recommendations below are provided as a guide. Operators are encou
- GPUs
- Not necessary at this time
- Operators in the validator community do not use GPUs currently
=======
| Component | Validator Requirements | Additional RPC Node Requirements |
|-----------|------------------------|----------------------------------|
| **CPU** | - 2.8GHz base clock speed, or faster<br />- SHA extensions instruction support<br />- AMD Gen 3 or newer<br />- Intel Ice Lake or newer<br />- Higher clock speed is preferable over more cores<br />- AVX2 instruction support (to use official release binaries, self-compile otherwise)<br />- Support for AVX512f is helpful<br />||
| | 12 cores / 24 threads, or more | 16 cores / 32 threads, or more |
| **RAM** | Error Correction Code (ECC) memory is suggested<br />Motherboard with 512GB capacity suggested ||
| | 256GB or more| 512 GB or more for **all [account indexes](https://docs.solanalabs.com/operations/setup-an-rpc-node#account-indexing)** |
| **Disk** | PCIe Gen3 x4 NVME SSD, or better, on each of: <br />- **Accounts**: 500GB, or larger. High TBW (Total Bytes Written)<br />- **Ledger**: 1TB or larger. High TBW suggested<br />- **Snapshots**: 250GB or larger. High TBW suggested<br />- **OS**: (Optional) 500GB, or larger. SATA OK<br /><br />The OS may be installed on the ledger disk, though testing has shown better performance with the ledger on its own disk<br /><br />Accounts and ledger *can* be stored on the same disk, however due to high IOPS, this is not recommended<br /><br />The Samsung 970 and 980 Pro series SSDs are popular with the validator community | Consider a larger ledger disk if longer transaction history is required<br /><br />Accounts and ledger **should not** be stored on the same disk |
| **GPUs** | Not necessary at this time<br />Operators in the validator community do not use GPUs currently | |
>>>>>>> dc6ee5b208 (ci: update docs pipeline (#2162))
### RPC Node Recommendations

Expand Down

0 comments on commit 3b52b8d

Please sign in to comment.