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 info on session keys for node operators #975

Merged
merged 4 commits into from
Aug 12, 2024

Conversation

dawnkelly09
Copy link
Contributor

Description

This is an update resulting from breaking changes. Session keys are no longer automatically generated and must be set up and stored by the user before they can run their node services on Docker or Systemd. This PR adds copy and code to inform users of this new requirement and instruct them on generating and storing their session key.

Checklist

  • [ x] I have added a label to this PR 🏷️
  • [ x] I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@dawnkelly09 dawnkelly09 added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Aug 7, 2024
@themacexpert themacexpert self-requested a review August 8, 2024 21:12
Copy link
Contributor

@themacexpert themacexpert left a comment

Choose a reason for hiding this comment

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

Looks good! Wherever possible you want to use variables for things like version tags... occasionally there are some places where they won't work like embedded snippets from other files but for these they should work. Just double check in the build that everything is formatted correctly.

node-operators/networks/run-a-node/docker.md Outdated Show resolved Hide resolved
node-operators/networks/run-a-node/docker.md Outdated Show resolved Hide resolved
node-operators/networks/run-a-node/docker.md Outdated Show resolved Hide resolved
Co-authored-by: Kevin Neilson <kevin@purestake.com>
Copy link
Contributor Author

@dawnkelly09 dawnkelly09 left a comment

Choose a reason for hiding this comment

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

Last commit adds usage of parachain_release_tag variable where appropriate.

This PR adds information to advise collator node operators of the need to set session keys before running startup commands as the keys will no longer auto-generate if not provided.

node-operators/networks/run-a-node/systemd.md Outdated Show resolved Hide resolved
node-operators/networks/run-a-node/systemd.md Outdated Show resolved Hide resolved
node-operators/networks/run-a-node/systemd.md Outdated Show resolved Hide resolved
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Beautiful! Thanks! ✨

dawnkelly09

This comment was marked as off-topic.

@albertov19 albertov19 merged commit fc4c890 into master Aug 12, 2024
1 check passed
@eshaben eshaben deleted the dawn/network-key-persistence branch August 12, 2024 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants