Skip to content

Add docs for running a new EN using AWS AMI#115

Merged
2dvorak merged 12 commits into
kaiachain:mainfrom
2dvorak:2dvorak/aws-ami
Oct 2, 2024
Merged

Add docs for running a new EN using AWS AMI#115
2dvorak merged 12 commits into
kaiachain:mainfrom
2dvorak:2dvorak/aws-ami

Conversation

@2dvorak

@2dvorak 2dvorak commented Sep 27, 2024

Copy link
Copy Markdown
Contributor

Proposed changes

  • This PR adds documentation for running a new EN using AWS AMI

Types of changes

Please put an x in the boxes related to your change.

  • Minor Issues and Typos
  • Major Content Contribution
  • Others

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 CONTRIBUTING GUIDELINES
  • I have read the CLA and signed by comment I have read the CLA Document and I hereby sign the CLA in first time contribute
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

@2dvorak 2dvorak self-assigned this Sep 27, 2024
@github-actions

github-actions Bot commented Sep 27, 2024

Copy link
Copy Markdown

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@2dvorak

2dvorak commented Sep 27, 2024

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

Comment thread docs/learn/storage/block-sync.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
@2dvorak
2dvorak force-pushed the 2dvorak/aws-ami branch 3 times, most recently from a3b4027 to 546a62d Compare September 27, 2024 03:44
Comment thread docs/learn/storage/aws-ami.md Outdated
Co-authored-by: Yunjong Jeong (ollie) <5933330+blukat29@users.noreply.github.com>
Comment thread docs/learn/storage/aws-ami.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
Comment thread docs/learn/storage/aws-ami.md Outdated
$ 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`:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two ipc files 'kaia.ipc' and 'klay.ipc' coexist?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, my bad. But I'm afraid that there're some kaia.ipc in docs..
Anyway, updated. PTAL.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean every instance of 'kaia.ipc' in docs needs to be changed to 'klay.ipc' all together?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, currently we use the name of the IPC file as klay.ipc.

Comment thread docs/learn/storage/block-sync.md Outdated

## 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@2dvorak 2dvorak Sep 30, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, now I moved aws-ami.md page.
Also, moved img files. Thanks for pointing out.

@scott-klaytn scott-klaytn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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',
    ],
  }, ...

2dvorak and others added 7 commits September 30, 2024 09:24
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.
@2dvorak

2dvorak commented Sep 30, 2024

Copy link
Copy Markdown
Contributor Author

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',
    ],
  }, ...

@scott-klaytn Thanks, added to sidebar as you suggested.

@2dvorak
2dvorak merged commit e758486 into kaiachain:main Oct 2, 2024
@2dvorak
2dvorak deleted the 2dvorak/aws-ami branch October 2, 2024 01:07
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants