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

docs: tutorial for running hardware node #4678

Merged
merged 2 commits into from
Jun 28, 2024
Merged

docs: tutorial for running hardware node #4678

merged 2 commits into from
Jun 28, 2024

Conversation

conorsch
Copy link
Contributor

@conorsch conorsch commented Jun 27, 2024

Describe your changes

Documents the setup process for renting a hardware box (via Hetzner) and configuring a fullnode on it. Necessarily overlaps with the regular ol' install docs for pd, but tried to be explicit in the tutorial for maximum comprehension.

Making that simplified change, I looked through the old deployment/ci configs and culled a lot that were gathering dust. Now the repo concisely recommends using the systemd config, or links out to other community-maintained options for configuring nodes.

Issue ticket number and link

None.

Checklist before requesting a review

  • If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason:

    no application code changes, just improving docs and cleaning things up

@conorsch conorsch changed the title docs: tutorial for self-hosting frontend docs: tutorial for running hardware node Jun 27, 2024
@conorsch conorsch requested a review from cratelyn June 28, 2024 20:05
@conorsch conorsch marked this pull request as ready for review June 28, 2024 21:23
@conorsch conorsch requested a review from aubrika June 28, 2024 21:27
Copy link
Contributor

@aubrika aubrika left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple potential comment cleanups

blocks streaming in. If not, see the [debugging steps](../node/pd/debugging.md)
to figure out what went wrong.

<!--
Copy link
Contributor

Choose a reason for hiding this comment

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

?

this guide demonstrates how a user can self-host an RPC URL for use by themselves and others.

<!--
Plan:
Copy link
Contributor

Choose a reason for hiding this comment

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

?

Documents the setup process for renting a hardware box
(via Hetzner) and configuring a fullnode on it. Necessarily overlaps
with the regular ol' install docs for pd, but tried to be explicit
in the tutorial for maximum comprehension.
There's a lot of unused content in here, so I'm cleaning out a ton of
cruft from the repo, mostly ci- and deployment-related.
@conorsch conorsch merged commit 48cf5d6 into main Jun 28, 2024
13 checks passed
@conorsch conorsch deleted the docs-node-tutorial branch June 28, 2024 22:09
conorsch added a commit that referenced this pull request Jul 5, 2024
@conorsch conorsch mentioned this pull request Jul 5, 2024
1 task
conorsch added a commit that referenced this pull request Jul 5, 2024
## Describe your changes
Refs #4678.

## Issue ticket number and link

## Checklist before requesting a review

- [x] If this code contains consensus-breaking changes, I have added the
"consensus-breaking" label. Otherwise, I declare my belief that there
are not consensus-breaking changes, for the following reason:

> docs-only

Co-authored-by: Conor Schaefer <[email protected]>
conorsch added a commit that referenced this pull request Jul 25, 2024
We'd previously been triggering container builds on every merge to main,
via the testnet deploy workflows, which were removed in #4678. Let's add
triggers to build containers regularly, even though we're not deploying
them automatically. Also cleans up unused builds like for galileo and
grafana.
conorsch added a commit that referenced this pull request Jul 25, 2024
## Describe your changes
We'd previously been triggering container builds on every merge to main,
via the testnet deploy workflows, which were removed in #4678. Let's add
triggers to build containers regularly, even though we're not deploying
them automatically. Also cleans up unused builds like for galileo and
grafana.

## Issue ticket number and link
N/A

## Checklist before requesting a review

- [x] If this code contains consensus-breaking changes, I have added the
"consensus-breaking" label. Otherwise, I declare my belief that there
are not consensus-breaking changes, for the following reason:

  > ci-only, no code changes

Co-authored-by: Conor Schaefer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants