Add docs for running a new EN using AWS AMI#115
Conversation
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
a3b4027 to
546a62d
Compare
546a62d to
22d8957
Compare
Co-authored-by: Yunjong Jeong (ollie) <5933330+blukat29@users.noreply.github.com>
| $ tail -f /var/kend/logs/kend.out | ||
| ``` | ||
|
|
||
| Kaia provides a CLI client `ken console`. You can interact with the Kaia node using the `ken console` via multiple endpoints, and one option is to use IPC (inter-process communication). The IPC file `kaia.ipc` is located in the data directory on an EN, in our case `/var/kend/data`. Thus in order to use `ken console`: |
There was a problem hiding this comment.
The two ipc files 'kaia.ipc' and 'klay.ipc' coexist?
There was a problem hiding this comment.
No, my bad. But I'm afraid that there're some kaia.ipc in docs..
Anyway, updated. PTAL.
There was a problem hiding this comment.
You mean every instance of 'kaia.ipc' in docs needs to be changed to 'klay.ipc' all together?
There was a problem hiding this comment.
Yes, currently we use the name of the IPC file as klay.ipc.
|
|
||
| ## AWS AMI | ||
|
|
||
| AWS AMI provides a convienient way to launch a fully operational Kaia endpoint node. The AMIs are open to public so that anyone can use. We produce AMIs every day, so the chaindata in the latest AMI should be less than one day behind. See [AWS AMI](./aws-ami.md) for more information. |
There was a problem hiding this comment.
| AWS AMI provides a convienient way to launch a fully operational Kaia endpoint node. The AMIs are open to public so that anyone can use. We produce AMIs every day, so the chaindata in the latest AMI should be less than one day behind. See [AWS AMI](./aws-ami.md) for more information. | |
| AWS AMI provides a convenient way to launch a fully operational Kaia endpoint node. The AMIs are open to the public so that anyone can use them. We produce AMIs every day, so the chaindata in the latest AMI should be less than one day behind. AWS AMI provides the fastest way to run a node, even faster than using a chaindata snapshot. See [Use AWS AMI](../../misc/operation/aws-ami.md) for more information. |
I suggest moving 'aws-ami.md' page to the Node Quick Reference section for consistency with other pages like Upstream EN and Use Chaindata Snapshots. This page is also more of a guide rather than a concept.
There was a problem hiding this comment.
Thank you, movded aws-ami.md page to the Node Quick Reference section per your suggestion.
However, using AMI may not be the "fastest" way because of the warmup phase. The launch of the new instance is quick (than downloading & extracting chaindata snapshot), however the EN becomes "usable" after the warmup phase (to my personal experience), which may take several days. So I removed the additional sentence you suggested, instead added "Why use AMI" section in the aws-ami.md to cover the advantage of using AMI.
There was a problem hiding this comment.
Looks like the location of 'aws-ami.md' file remains unchanged (AS-IS: docs/learn/storage, TO-BE: docs/misc/operation). The same goes for image path (AS-IS: static/image/learn, TO-BE: static/image/misc).
There was a problem hiding this comment.
Sorry, now I moved aws-ami.md page.
Also, moved img files. Thanks for pointing out.
scott-klaytn
left a comment
There was a problem hiding this comment.
Please make sure that the new 'aws-ami.md' entry is added to sidebars.js as well.
For example, with my suggested changes, the sidebars.js is shown as below:
const commonSidebar = [
{
type: 'html',
value: '<span class="sidebar-divider" />',
},
{
type: 'category',
label: 'Node Quick Reference',
link: { type: 'doc', id: 'misc/operation/operation' },
items: [
'misc/operation/configuration',
'misc/operation/node-log',
'misc/operation/log-management',
'misc/operation/kaia-command',
'misc/operation/troubleshooting',
'misc/operation/chaindata-snapshot',
'misc/operation/aws-ami',
'misc/operation/node-pruning',
'misc/operation/upstream-en',
],
}, ...
Co-authored-by: Scott Lee <scott.l@kaia.io>
Co-authored-by: Scott Lee <scott.l@kaia.io>
Co-authored-by: Scott Lee <scott.l@kaia.io>
Co-authored-by: Scott Lee <scott.l@kaia.io>
Co-authored-by: Scott Lee <scott.l@kaia.io>
Also, fix typos and paths.
@scott-klaytn Thanks, added to sidebar as you suggested. |
84c2a7b to
df13b9a
Compare
df13b9a to
957cf33
Compare
Proposed changes
Types of changes
Please put an x in the boxes related to your change.
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
I have read the CLA Document and I hereby sign the CLAin first time contribute