-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dashmate): verify system requirements (#1914)
Co-authored-by: thephez <[email protected]>
- Loading branch information
Showing
13 changed files
with
269 additions
and
5 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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
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
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
185 changes: 185 additions & 0 deletions
185
packages/dashmate/src/listr/tasks/setup/regular/verifySystemRequirementsTaskFactory.js
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 |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| import chalk from 'chalk'; | ||
| import { Listr } from 'listr2'; | ||
| import os from 'os'; | ||
| import * as diskusage from 'diskusage'; | ||
| import si from 'systeminformation'; | ||
|
|
||
| /** | ||
| * | ||
| * @param {Docker} docker | ||
| * @param {DockerCompose} dockerCompose | ||
| * @return {verifySystemRequirementsTask} | ||
| */ | ||
| export default function verifySystemRequirementsTaskFactory(docker, dockerCompose) { | ||
| /** | ||
| * @typedef {function} verifySystemRequirementsTask | ||
| * @returns {Listr} | ||
| */ | ||
| async function verifySystemRequirementsTask() { | ||
| return new Listr([ | ||
| { | ||
| title: 'System requirements', | ||
| task: async (ctx, task) => { | ||
| await dockerCompose.throwErrorIfNotInstalled(); | ||
|
|
||
| const MINIMUM_CPU_CORES = ctx.isHP ? 4 : 2; | ||
| const MINIMUM_CPU_FREQUENCY = 2.4; // GHz | ||
| const MINIMUM_RAM = ctx.isHP ? 8 : 4; // GB | ||
| const MINIMUM_DISK_SPACE = ctx.isHP ? 200 : 100; // GB | ||
|
|
||
| const warnings = []; | ||
|
|
||
| // Get system info | ||
| let systemInfo; | ||
| try { | ||
| systemInfo = await docker.info(); | ||
| } catch (e) { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(`Can't get docker info: ${e}`); | ||
| } | ||
| } | ||
|
|
||
| if (systemInfo) { | ||
| if (Number.isInteger(systemInfo.NCPU)) { | ||
| // Check CPU cores | ||
| const cpuCores = systemInfo.NCPU; | ||
|
|
||
| if (cpuCores < MINIMUM_CPU_CORES) { | ||
| warnings.push(`${cpuCores} CPU cores detected. At least ${MINIMUM_CPU_CORES} are required`); | ||
| } | ||
| } else { | ||
| // eslint-disable-next-line no-console | ||
| console.warn('Can\'t get NCPU from docker info'); | ||
| } | ||
|
|
||
| // Check RAM | ||
| if (Number.isInteger(systemInfo.MemTotal)) { | ||
| const memoryGb = systemInfo.MemTotal / (1024 ** 3); // Convert to GB | ||
|
|
||
| if (memoryGb < MINIMUM_RAM) { | ||
| warnings.push(`${memoryGb.toFixed(2)}GB RAM detected. At least ${MINIMUM_RAM}GB is required`); | ||
| } | ||
| } else { | ||
| // eslint-disable-next-line no-console | ||
| console.warn('Can\'t get MemTotal from docker info'); | ||
| } | ||
| } | ||
|
|
||
| // Check CPU frequency | ||
| let hostCpu; | ||
| try { | ||
| hostCpu = await si.cpu(); | ||
| } catch { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn('Can\'t get CPU info'); | ||
| } | ||
| } | ||
|
|
||
| if (hostCpu) { | ||
| if (hostCpu.speed === 0) { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn('Can\'t get CPU frequency'); | ||
| } | ||
| } else if (hostCpu.speed < MINIMUM_CPU_FREQUENCY) { | ||
| warnings.push(`${hostCpu.speed.toFixed(1)}GHz CPU frequency detected. At least ${MINIMUM_CPU_FREQUENCY}GHz is required`); | ||
| } | ||
| } | ||
|
|
||
| // Check swap information | ||
| let swap; | ||
| try { | ||
| swap = await si.mem(); | ||
| } catch (e) { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(`Can't get swap info: ${e}`); | ||
| } | ||
| } | ||
|
|
||
| if (swap) { | ||
| const swapTotalGb = (swap.swaptotal / (1024 ** 3)); // Convert bytes to GB | ||
|
|
||
| if (swapTotalGb < 2) { | ||
| warnings.push(`Swap space is ${swapTotalGb.toFixed(2)}GB. 2GB is recommended`); | ||
| } | ||
| } | ||
|
|
||
| // Get disk usage info | ||
| let diskInfo; | ||
|
|
||
| if (systemInfo) { | ||
| try { | ||
| diskInfo = await diskusage.check(systemInfo.DockerRootDir); | ||
| } catch (e) { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(`Can't get disk usage for '${systemInfo.DockerRootDir}': ${e}`); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (!diskInfo) { | ||
| try { | ||
| diskInfo = await diskusage.check(os.platform() === 'win32' ? 'c:' : '/'); | ||
| } catch (e) { | ||
| if (process.env.DEBUG) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(`Can't get disk usage for root directory: ${e}`); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (diskInfo) { | ||
| const availableDiskSpace = diskInfo.available / (1024 ** 3); // Convert to GB | ||
|
|
||
| if (availableDiskSpace < MINIMUM_DISK_SPACE) { | ||
| warnings.push(`${availableDiskSpace.toFixed(2)}GB available disk space detected. At least ${MINIMUM_DISK_SPACE}GB is required`); | ||
| } | ||
| } | ||
|
|
||
| if (warnings.length > 0) { | ||
| const warningsText = warnings.map((warning) => ` - ${warning}`).join('\n'); | ||
|
|
||
| const header = chalk` Minimum requirements have not been met: | ||
| {red ${warningsText}} | ||
| Dash Platform requires more resources than the current system provides. | ||
| Evonode rewards are paid based on block production, and resource-limited | ||
| nodes may not be able to produce blocks quickly enough to receive reward | ||
| payments. Upgrading system resources is recommended before proceeding. | ||
| {bold This server may not receive Dash Platform reward payments due to its resource limitations.}\n`; | ||
|
|
||
| // This option is used for tests | ||
| if (ctx.acceptUnmetSystemRequirements) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn(header); | ||
| } else { | ||
| const proceed = await task.prompt({ | ||
| type: 'toggle', | ||
| header, | ||
| message: ' Are you sure you want to proceed?', | ||
| enabled: 'Yes', | ||
| disabled: 'No', | ||
| initial: false, | ||
| }); | ||
|
|
||
| if (!proceed) { | ||
| throw new Error('System requirements have not been met'); | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| options: { | ||
| persistentOutput: true, | ||
| }, | ||
| }, | ||
| ]); | ||
| } | ||
|
|
||
| return verifySystemRequirementsTask; | ||
| } |
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
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
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
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
Oops, something went wrong.