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

Add a table of hardware requirements for various node types #568

Merged
merged 4 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions network/anchor-platform/README.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Anchor Platform API Reference
title: Introduction
sidebar_position: 10
sidebar_label: Introduction
---

# Anchor Platform

The Anchor Platform is a set of tools and APIs that enable developers and businesses to build their own on and off-ramp services for the Stellar network. It provides a standardized interface, including the implementation of several Stellar Ecosystem Proposals (SEPs), to make it easy for businesses to integrate with Stellar-based wallets and exchanges.

The platform also includes features for managing assets, transactions, and user accounts, and supports a variety of deployment options, including using Docker or Kubernetes. Overall, the Anchor Platform aims to simplify the process of building and managing a Stellar-based financial service, allowing businesses to focus on providing value to their customers.

Learn about integrating with the Anchor Platform in the [Admin Guide](./admin-guide/README.mdx) or get API information in the [API Reference](./api-reference/README.mdx).
Learn about integrating with the Anchor Platform in the [Admin Guide](./admin-guide/README.mdx) or get API information in the [API Reference](./api-reference/README.mdx).
23 changes: 23 additions & 0 deletions network/requirements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Node Hardware Requirements
---

Here you can find the requirements for running the various types of nodes the operate the Stellar network. We offer some modest recommendations for each type of resource, as well as a generally applicable SKU for some popular cloud computing providers. These may require customizations or adjustments, depending on your specific use-case.

| Node Type | CPU | RAM | Disk | AWS SKU | Google Cloud SKU |
| --- | --- | --- | --- | --- | --- |
| Core Validator Node | 8x Intel Xeon @ 3.4 GHz | 16 GB | 100 GB NVMe SSD | [c5d.2xlarge] | [n4-highcpu-8] |
ElliotFriend marked this conversation as resolved.
Show resolved Hide resolved
| Horizon API Service | 4 vCPU | 16 GB | 100 GB SSD >= 1.5K IOPS | [c5d.xlarge] |[n4-standard-4] |
| Horizon PostgreSQL | 4 vCPU | 32 GB | 2 TB\* SSD (NVMe or Direct Attached Storage) >= 7K IOPS | [i4g.xlarge] | [c3-highmem-8] |
| Soroban RPC | 2 vCPU | 4 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] |

_\* Assuming a 30-day retention window for data storage._

[c5.large]: https://aws.amazon.com/ec2/instance-types/c5/
[c5d.2xlarge]: https://aws.amazon.com/ec2/instance-types/c5/
[c5d.xlarge]: https://aws.amazon.com/ec2/instance-types/c5/
[n4-highcpu-2]: https://cloud.google.com/compute/docs/general-purpose-machines#n4-highcpu
[n4-highcpu-8]: https://cloud.google.com/compute/docs/general-purpose-machines#n4-highcpu
[n4-standard-4]: https://cloud.google.com/compute/docs/general-purpose-machines#n4-standard
[i4g.xlarge]: https://aws.amazon.com/ec2/instance-types/i4g/
[c3-highmem-8]: https://cloud.google.com/compute/docs/general-purpose-machines#c3_machine_types
7 changes: 4 additions & 3 deletions network/stellar-disbursement-platform/README.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Stellar Disbursement Platform
title: Introduction
sidebar_position: 10
sidebar_label: Introduction
slug: /stellar-disbursement-platform
---

The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network.
# Stellar Disbursement Platform

The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network.

In this section, you'll find an [Admin Guide](./admin-guide/README.mdx) that will teach you how to run the Stellar Disbursement Platform as well as an [API Reference](./api-reference/resources/README.mdx).
13 changes: 13 additions & 0 deletions sidebarsNetwork.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
overview: [
'README',
'requirements',
{ type: 'html', value: '<small>Data Availability</small>', defaultStyle: true, className: 'networkMenuHtmlItem'},
{ type: 'ref', id: 'soroban-rpc/README', label: 'Soroban RPC'},
{ type: 'ref', id: 'hubble/README', label: 'Hubble'},
{ type: 'ref', id: 'horizon/README', label: 'Horizon'},
{ type: 'html', value: '<small>Platforms</small>', defaultStyle: true, className: 'networkMenuHtmlItem'},
{ type: 'ref', id: 'anchor-platform/README', label: 'Anchor Platform'},
{ type: 'ref', id: 'stellar-disbursement-platform/README', label: 'Stellar Disbursement Platform'},
{ type: 'html', value: '<small>Network Infrastructure</small>', defaultStyle: true, className: 'networkMenuHtmlItem'},
{ type: 'ref', id: 'core-node/README', label: 'Core Validator Node'},
],
horizon: [
{
type: 'category',
Expand Down
7 changes: 7 additions & 0 deletions src/css/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,13 @@ div[class^="announcementBar_"] {
color: var(--ifm-color-primary);
}

/* Sidebar HTML item customizations */

.networkMenuHtmlItem small {
text-transform: uppercase;
color: #999;
}

/* Customizations to metamask openrpc package styles */

select[data-testid="example-pairing-select"] {
Expand Down
1 change: 1 addition & 0 deletions src/theme/ApiItem/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export default function ApiItemWrapper(props) {
|| props.location?.pathname?.startsWith('/network/hubble')
|| props.location?.pathname?.startsWith('/network/soroban-rpc')
|| props.location?.pathname?.startsWith('/network/core-node')
|| props.location?.pathname === '/network/requirements'
|| props.location?.pathname === '/network/horizon/horizon-providers'
) {
return (
Expand Down
5 changes: 4 additions & 1 deletion src/theme/DocSidebar/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ export default function DocSidebarWrapper(props) {
if (props.path.startsWith('/network')) {
newProps = {
...props,
sidebar: props.sidebar[0].items
// sidebar: props.sidebar[0].items
}
if (props.sidebar[0].items) {
newProps.sidebar = props.sidebar[0].items
}
}
// For all other sidebars, pass the default props
Expand Down
Loading