Skip to content

Commit

Permalink
docs: update systemd guide for cometbft
Browse files Browse the repository at this point in the history
Refs #2263.
  • Loading branch information
conorsch committed Sep 28, 2023
1 parent 93ae23d commit 4db2ef3
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion deployments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ a run of the full deploy logic.
There are several DNS records that are not handled
by the automation in this repo. Each testnet should have:

* `rpc.<fqdn>` # the tendermint rpc service
* `rpc.<fqdn>` # the cometbft rpc service
* `grpc.<fqdn>` # the pd grpc service
* `grafana.<fqdn>` # web interface for metrics dashboards

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ spec:
app.kubernetes.io/component: genesis-validator
{{- include "penumbra-network.selectorLabels" $ | nindent 8 }}
spec:
# Force the pods to different k8s nodes, so that egress ip is unique per Tendermint node.
# Force the pods to different k8s nodes, so that egress ip is unique per CometBFT node.
# Effectively limits the number of Penumbra nodes to the number of k8s nodes in the cluster.
affinity:
podAntiAffinity:
Expand Down
4 changes: 2 additions & 2 deletions deployments/charts/penumbra-node/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ You can access the pd gRPC service here:

https://{{.Values.ingressRoute.hosts.pd }}

You can access the Tendermint RPC service here:
You can access the CometBFT RPC service here:

https://{{.Values.ingressRoute.hosts.tm }}

Expand All @@ -15,7 +15,7 @@ run this command locally:

{{- else }}
You have not enabled an ingress (via `ingressRoute.enabled=true`),
so consult the logs to ensure that Tendermint is processing blocks
so consult the logs to ensure that CometBFT is processing blocks
to catch up with the network. Even without an HTTPS ingress,
your node is still able to interact with the network.
{{- end }}
8 changes: 4 additions & 4 deletions deployments/scripts/relayer-local-devnet
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ fi
echo "Generating new local devnet..."
cargo run --release --bin pd -- testnet generate --chain-id penumbra-devnet-local

echo "Starting Tendermint..."
tendermint start --log_level=error --home "${HOME}/.penumbra/testnet_data/node0/tendermint" &
tendermint_pid="$!"
echo "Starting CometBFT..."
cometbft start --log_level=error --home "${HOME}/.penumbra/testnet_data/node0/cometbft" &
cometbft_pid="$!"

export RUST_LOG="info,[CheckTx]=debug"
echo "Starting pd..."
cargo run --release --bin pd -- start --home "${HOME}/.penumbra/testnet_data/node0/pd" &
pd_pid="$!"

# Ensure processes are cleaned up after script exits, regardless of status.
trap 'kill -9 "$tendermint_pid" "$pd_pid"' EXIT
trap 'kill -9 "$cometbft_pid" "$pd_pid"' EXIT

echo "Waiting a bit for network to start..."
sleep 10
Expand Down
2 changes: 1 addition & 1 deletion deployments/scripts/smoke-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ echo "Generating testnet config..."
EPOCH_DURATION="${EPOCH_DURATION:-100}"
cargo run --quiet --release --bin pd -- testnet generate --epoch-duration "$EPOCH_DURATION" --timeout-commit 500ms

echo "Starting Tendermint..."
echo "Starting CometBFT..."
cometbft start --log_level=error --home "${HOME}/.penumbra/testnet_data/node0/cometbft" &
cometbft_pid="$!"

Expand Down
12 changes: 6 additions & 6 deletions deployments/systemd/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# systemd unit files for Penumbra

Here are example unit files for running Penumbra (and the required Tendermint instance)
Here are example unit files for running Penumbra (and the required CometBFT instance)
via systemd. *You'll need to customize the the service files*, particularly the `User` declaration
and binary fullpath in `ExecStart`, and possibly the path to the home directory, depending on your system.

Expand All @@ -10,19 +10,19 @@ Copy the service files to a system-wide location:
```bash
# use 'envsubst' to replace `$USER` with your local username
envsubst < penumbra.service | sudo tee /etc/systemd/system/penumbra.service
envsubst < tendermint.service | sudo tee /etc/systemd/system/tendermint.service
envsubst < cometbft.service | sudo tee /etc/systemd/system/cometbft.service
sudo systemctl daemon-reload
sudo systemctl restart penumbra tendermint
sudo systemctl restart penumbra cometbft

# view logs to monitor for errors
sudo journalctl -af -u penumbra -u tendermint
sudo journalctl -af -u penumbra -u cometbft
```

## Uninstalling
To remove the configs, run:

```bash
sudo systemctl disable --now penumbra tendermint
sudo rm /etc/systemd/system/{penumbra,tendermint}.service
sudo systemctl disable --now penumbra cometbft
sudo rm /etc/systemd/system/{penumbra,cometbft}.service
sudo systemctl daemon-reload
```
2 changes: 1 addition & 1 deletion deployments/systemd/penumbra.service
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[Unit]
Description=Penumbra pd
Wants=tendermint.service
Wants=cometbft.service

[Service]
ExecStart=/usr/local/bin/pd start --home $HOME/.penumbra/testnet_data/node0/pd
Expand Down

0 comments on commit 4db2ef3

Please sign in to comment.