Skip to content

Commit

Permalink
A few minor nits
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed May 2, 2024
1 parent 741eb40 commit 1ebe3eb
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SHELL = /bin/sh
POKTROLLD_HOME ?= ./localnet/poktrolld
POCKET_NODE ?= tcp://127.0.0.1:36657 # The pocket node (validator in the localnet context)
TESTNET_RPC ?= https://testnet-validated-validator-rpc.poktroll.com/ # TestNet RPC endpoint. Update if there's another "main" testnet.
TESTNET_RPC ?= https://testnet-validated-validator-rpc.poktroll.com/ # TestNet RPC endpoint for validator maintained by Grove. Needs to be update if there's another "primary" testnet.
APPGATE_SERVER ?= http://localhost:42069
GATEWAY_URL ?= http://localhost:42079
POCKET_ADDR_PREFIX = pokt
Expand Down
29 changes: 16 additions & 13 deletions docusaurus/docs/develop/internal_infrastructure/localnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ needed to send an end-to-end relay.
- [Developing with LocalNet](#developing-with-localnet)
- [localnet\_config.yaml](#localnet_configyaml)
- [Scaling network actors](#scaling-network-actors)
- [Change configuration](#change-configuration)
- [Off-chain actors configuration](#off-chain-actors-configuration)
- [Modify Kubernetes workloads](#modify-kubernetes-workloads)
- [Observability](#observability)
- [Access dashboards with graphs and logs](#access-dashboards-with-graphs-and-logs)
- [How to update and save an existing dashboard?](#how-to-update-and-save-an-existing-dashboard)
- [High level overview of LocalNet](#high-level-overview-of-localnet)
- [Flow](#flow)
- [High-level overview of LocalNet](#high-level-overview-of-localnet)
- [LocalNet Deployment Flow](#localnet-deployment-flow)
- [Troubleshooting](#troubleshooting)
- [Clean Slate (Nuclear Option)](#clean-slate-nuclear-option)

Expand Down Expand Up @@ -83,14 +83,16 @@ _NOTE: You may need to up to 1 minute for the new actors to be registered and de

### Off-chain actors configuration

We heavily use Helm charts for our LocalNet. The goal is to maximize the tooling involved in deploying production
workloads and local development. As a result, the configuration of our services is defined in Helm charts.
Following best practices in Helm chart design, we have default values defined in the `values.yaml` file of each service Helm chart.
For example, [here are the RelayMiner `values.yaml`](https://github.com/pokt-network/helm-charts/blob/main/charts/relayminer/values.yaml).
Local infrastructure requires some changes to the default values to properly configure RelayMiner or AppGate Server, so we override some of
the values. You can find such overrides in the [poktroll/localnet/kubernetes directory](https://github.com/pokt-network/poktroll/tree/main/localnet/kubernetes).
Should you need to change the configuration of the services on LocalNet, this is the place.
We heavily use Helm charts for configuring LocalNet. The goal is to maximize the tooling involved in deploying production
workloads and local development.

Following best practices in Helm chart design, we have default values defined in the `values.yaml` file of each service
Helm chart. For example, [here are the RelayMiner `values.yaml`](https://github.com/pokt-network/helm-charts/blob/main/charts/relayminer/values.yaml).

Local infrastructure requires some changes to the default values to properly configure RelayMiner or AppGate Server, so
we override some of the values. You can find such overrides in the [poktroll/localnet/kubernetes directory](https://github.com/pokt-network/poktroll/tree/main/localnet/kubernetes).

**IF YOU NEED TO CHANGE LocalNet configs, 👆 is the place.**

### Modify Kubernetes workloads

Expand Down Expand Up @@ -161,17 +163,18 @@ If you wish to change a dashboard, do the following:

## High-level overview of LocalNet

This section describes how LocalNet operates and the interactions between different components to provision a working network.
This section describes how LocalNet operates and the interactions between different
components to provision a working network.

### Flow
### LocalNet Deployment Flow

After you execute `make localnet_up`, many things happen:

1. `ignite` CLI provisions a new `genesis.json` and validator keys.
2. `tilt` starts and runs a [Tiltfile](https://github.com/pokt-network/poktroll/blob/main/Tiltfile) - a Python-like script.
3. Subsequently, the logic described in the `Tiltfile` executes various CLI commands, communicates with the `k8s` API, and creates or reads the LocalNet configuration file:
1. Creates a new `localnet_config.yaml` if it doesn't exist. Updates it with default values if new ones are introduced.
2. Depending on the configuration in `localnet_config.yaml`, uses Helm charts from the local [helm-charts](https://github.com/pokt-network/helm-charts) repository or downloads Helm charts from our Helm chart repository (`https://pokt-network.github.io/helm-charts/`).
2. Depending on the configuration in `localnet_config.yaml`, uses Helm charts from the local [helm-charts](https://github.com/pokt-network/helm-charts)repository or downloads Helm charts from our Helm chart repository (`https://pokt-network.github.io/helm-charts/`).
3. Compiles the `poktrolld` binary from the source code.
4. Using values from `localnet_config.yaml`, provisions an observability stack (Grafana, Prometheus, Loki), a validator, AppGate servers, RelayMiners, etc.
4. With `make localnet_up` continually running in the background, `tilt` monitors for code changes and re-compiles the binary when a code change is detected. After the new binary is built, it is pushed to the containers and all processes restart.
Expand Down
9 changes: 5 additions & 4 deletions docusaurus/docs/operate/networks/private_testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ This is a very volatile network. We need to wipe this network frequently to keep
- [Visibility](#visibility)
- [Deployment Example](#deployment-example)


## Visibility

Community members provide explorers for this testnet:
- https://poktroll-devnet.cryptonode.tools/
- https://poktroll-testnet.qspider.com/

- [poktroll-devnet.cryptonode.tools/](https://poktroll-devnet.cryptonode.tools)
- [poktroll-testnet.qspider.com/](https://poktroll-testnet.qspider.com)

## Deployment Example

We provide an example for the community on how to deploy the Full Node, Relay Miner, and AppGate Server in the [poktroll-docker-compose-example GitHub Repo](https://github.com/pokt-network/poktroll-docker-compose-example).
We provide an example for the community on how to deploy the Full Node, Relay Miner,
and AppGate Server in the [poktroll-docker-compose-example GitHub Repo](https://github.com/pokt-network/poktroll-docker-compose-example).

0 comments on commit 1ebe3eb

Please sign in to comment.