Skip to content

Commit

Permalink
Merge pull request #1128 from celestiaorg/jcs/node-updates
Browse files Browse the repository at this point in the history
chore: Node Docs Updates
  • Loading branch information
YazzyYaz authored Oct 11, 2023
2 parents f100193 + 520afd0 commit 4834e79
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 15 deletions.
35 changes: 35 additions & 0 deletions docs/nodes/celestia-node-custom-networks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_label: Custom networks and values
description: Learn about custom networks and values on celestia-node.
---

# Custom networks and values

This section will cover importing boostrapper IDs, chain ID,
and network ID. This will allow you to import custom values
for a chain that is not in the default configuration.

If you have a custom network you can export `CELESTIA_CUSTOM`, which will
look something like:

```bash
export BRIDGE="/ip4/<ip-address>/tcp/2121/p2p/<node-ID>"
export GENESIS_HASH=<genesis-hash>
export NETWORK=<network-name>
export CELESTIA_CUSTOM="${NETWORK}:${GENESIS_HASH}:${BRIDGE}"
```

These values with examples would look like:

```bash
export BRIDGE="/ip4/151.115.14.33/tcp/2121/p2p/12D3KooWKEeRtzVMPUdxYsZo2edqps6mS67n6LT5mPdULSkPSxBQ"
export GENESIS_HASH=580B3DFF8A7C716968161D91116A1E171F486298D582874E93714E489C9E6E88
export NETWORK=custom
export CELESTIA_CUSTOM="${NETWORK}:${GENESIS_HASH}:${BRIDGE}"
```

Then, start your node with:

```bash
celestia [<node-type>] start [flags...]
```
20 changes: 5 additions & 15 deletions docs/nodes/celestia-node-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: A guide on how to run metrics for your Celestia Node DA instance.
This tutorial is for running metrics for your `celestia-node` Data
Availability instance.

This tutorial will focus on running metrics for a light-node.
This tutorial will focus on running metrics for a light node.

This tutorial assumes you have already setup your light node
by following the tutorial in the [Node API tutorial](../developers/node-tutorial.mdx).
Expand All @@ -21,21 +21,11 @@ command:
<!-- markdownlint-disable MD013 -->

```sh
celestia light start --core.ip <ip-address> --metrics --metrics.endpoint <ip-address:port> --p2p.network <network>
celestia [<node-type>] start --core.ip <ip-address> --metrics.tls=false --metrics --metrics.endpoint <ip-address:port> --p2p.network <network>
```

:::tip
The `--core.ip` gRPC port defaults to 9090,
so if you do not specify it in the command
line, it will default to that port. You can
add the port after the IP address or use the
`--core.grpc.port` flag to specify another
port if you prefer.

Refer to
[the ports section of the celestia-node troubleshooting page](../../nodes/celestia-node-troubleshooting/#ports)
for information on which ports are required to be open on your machine.
:::
Add metrics flags to your node start command and restart your node to apply it.
The metrics endpoint will gather your node's data to track your uptime.

<!-- markdownlint-enable MD013 -->

Expand All @@ -47,7 +37,7 @@ We will go over what the endpoint will need to be in the following section.
## Metrics endpoint design considerations

At the moment, the architecture of `celestia-node` metrics
works as specified in the following [ADR](https://github.com/celestiaorg/celestia-node/blob/main/docs/adr/adr-010-incentivized-testnet-monitoring.md).
works as specified in the following [ADR #010](https://github.com/celestiaorg/celestia-node/blob/main/docs/adr/adr-010-incentivized-testnet-monitoring.md).

Essentially, the design considerations here will necessitate
running an OpenTelemetry (OTEL) collector that connects to Celestia
Expand Down
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ const sidebars = {
label: "Config.toml guide",
id: "nodes/config-toml"
},
{
type: "doc",
label: "Custom networks and values",
id: "nodes/celestia-node-custom-networks"
},
{
type: "doc",
label: "Troubleshooting",
Expand Down

0 comments on commit 4834e79

Please sign in to comment.