Deployment Docs for Gateway (and archive gateway) #287
Conversation
Codecov Report
@@ Coverage Diff @@
## main #287 +/- ##
=======================================
Coverage 59.84% 59.84%
=======================================
Files 35 35
Lines 3990 3990
=======================================
Hits 2388 2388
Misses 1397 1397
Partials 205 205 Continue to review full report at Codecov.
|
| To deploy an emerald web3 gateway, a single instance (e.g. VM, Bare Metal, | ||
| Kubernetes Pod, etc.) of the deployment looks like this: | ||
|
|
||
|  |
There was a problem hiding this comment.
Hm, the <latest_version> part in the image might be confusing. Staring with the latest few emerald releases, there is a table now at which release that shows compatible oasis-node and emerald-paratime versions.
There was a problem hiding this comment.
I would also write "emerald paratime" to the oasis-node box in the image. (since the node needs also to run the emerald paratime)
|
|
||
| ### Archive architecture | ||
|
|
||
| In order to support archive emerald web3 requests, the following architecture is |
There was a problem hiding this comment.
Maybe add a sentence explaining what archive is/when it's needed. (e.g. it's needed if you'd like to support pre-network upgrade state)
| layers of web3 gateway nodes are required. In the future, multiple layers of | ||
| web3 gateways may exist. | ||
|
|
||
| ## Deploying the Damask (oasis-node v22) Emerald Web3 gateway |
There was a problem hiding this comment.
Maybe the "Deploying the Damask" section should be before the "archive mode" section.
| time, does not go over using that configuration._ | ||
|
|
||
| As is shown in the above diagram, an emerald web3 gateway currently requires a | ||
| colocated oasis-node and (at this time) a colocated postgres server. Not shown |
There was a problem hiding this comment.
Does the gateway really require a colocated postgres server? I think it does not
There was a problem hiding this comment.
Ah ya you're right it wouldn't be required.
At this time this does not include any instructions for sharing a postgres deployment. That still needs to undergo testing.