From 32be253b38a165c736026f63db2749fe2f741a96 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Mon, 13 May 2024 11:14:12 -0500 Subject: [PATCH 1/3] add a doc with a requirements comparison table --- network/requirements.mdx | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 network/requirements.mdx diff --git a/network/requirements.mdx b/network/requirements.mdx new file mode 100644 index 000000000..c32142c93 --- /dev/null +++ b/network/requirements.mdx @@ -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] | +| 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 From 10b1004ac2403d8d36582f89e0f6960d1a7235b1 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Mon, 13 May 2024 11:14:40 -0500 Subject: [PATCH 2/3] add some sidebar content for new-ish section --- sidebarsNetwork.js | 13 +++++++++++++ src/css/custom.scss | 7 +++++++ src/theme/ApiItem/index.js | 1 + src/theme/DocSidebar/index.js | 5 ++++- 4 files changed, 25 insertions(+), 1 deletion(-) diff --git a/sidebarsNetwork.js b/sidebarsNetwork.js index 7fb4b1b18..4a1b48872 100644 --- a/sidebarsNetwork.js +++ b/sidebarsNetwork.js @@ -2,6 +2,19 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { + overview: [ + 'README', + 'requirements', + { type: 'html', value: 'Data Availability', 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: 'Platforms', 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: 'Network Infrastructure', defaultStyle: true, className: 'networkMenuHtmlItem'}, + { type: 'ref', id: 'core-node/README', label: 'Core Validator Node'}, + ], horizon: [ { type: 'category', diff --git a/src/css/custom.scss b/src/css/custom.scss index a9c9e3d8a..54624bcf4 100644 --- a/src/css/custom.scss +++ b/src/css/custom.scss @@ -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"] { diff --git a/src/theme/ApiItem/index.js b/src/theme/ApiItem/index.js index 634f7aeaa..562f26e1b 100644 --- a/src/theme/ApiItem/index.js +++ b/src/theme/ApiItem/index.js @@ -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 ( diff --git a/src/theme/DocSidebar/index.js b/src/theme/DocSidebar/index.js index 81ca44ccb..68ad9d0b7 100644 --- a/src/theme/DocSidebar/index.js +++ b/src/theme/DocSidebar/index.js @@ -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 From 819b7ba52eca56f03856c6a7c322da6f3589727f Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Mon, 13 May 2024 11:15:01 -0500 Subject: [PATCH 3/3] adjust some heading config for platforms pages --- network/anchor-platform/README.mdx | 7 ++++--- network/stellar-disbursement-platform/README.mdx | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/network/anchor-platform/README.mdx b/network/anchor-platform/README.mdx index 00cac6207..090a18bf6 100644 --- a/network/anchor-platform/README.mdx +++ b/network/anchor-platform/README.mdx @@ -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). \ No newline at end of file +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). diff --git a/network/stellar-disbursement-platform/README.mdx b/network/stellar-disbursement-platform/README.mdx index e1961fe37..56f520bc6 100644 --- a/network/stellar-disbursement-platform/README.mdx +++ b/network/stellar-disbursement-platform/README.mdx @@ -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).