Merge branch 'refactor/consolidate-p2p-modules' into fix/raintree

* refactor/consolidate-p2p-modules:
  chore: update changelog
  switch to new dns introduced with helm charts
  [Consensus] Log warnings if server module is not enabled (#679)
  chore: update changelog
  add generated helm docs
  chore: update validator chart P2P hostname config
  chore: remove `use_libp2p` from validator chart
  [Peristence] Fix `TxIndexer` to index sender and recipient transactions with height and index suffixes (#677)
  Update e2e/docs/CHANGELOG.md (#681)
  Update devlog5.md (#672)
  [Infra] validator helm chart for LocalNet (#658)
  Update issue.md

Author: bryanchriswhite

.github/ISSUE_TEMPLATE/issue.md

@@ -70,7 +70,7 @@ assignees: ""
 - [ ] **New tests or benchmarks**: `make ...`
 - [ ] **All tests**: `make test_all`
 - [ ] **LocalNet**: verify a `LocalNet` is still functioning correctly by following the instructions at [docs/development/README.md](https://github.com/pokt-network/pocket/tree/main/docs/development)
-- [ ] ***k8s LocalNet**: verify a `k8s LocalNet` is still functioning correctly by following the instructions [here](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md)
+- [ ] **k8s LocalNet**: verify a `k8s LocalNet` is still functioning correctly by following the instructions [here](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md)
 
 ---
 

.github/workflows/generate-helm-docs.yml

@@ -0,0 +1,31 @@
+name: Generate helm docs
+on:
+  pull_request:
+    paths:
+      - "charts/**/README.md.gotmpl"
+      - "charts/**/values.yaml"
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+      - name: Install helm-docs
+        uses: envoy/[email protected]
+        with:
+          # Helm Docs Version to install (Mandatory)
+          version: 1.11.0
+      - name: Generate helm docs
+        run: helm-docs --chart-search-root=charts
+      - run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+
+          if [[ -n $(git status --porcelain) ]]; then
+            git add .
+            git commit -m "add generated helm docs"
+            git push
+          else
+            echo "No changes detected, skipping commit and push."
+          fi

.github/workflows/main.yml

@@ -63,14 +63,17 @@ jobs:
       - name: Output test failures
         # Makes it easier to find failed tests so no need to scroll through the whole log.
         if: ${{ failure() && env.TARGET_GOLANG_VERSION == matrix.go }}
-        run: jq --argjson fail_tests "$(jq -c -r 'select(.Action == "fail") | select(.Test) | .Test' test_results.json | jq -R -s -c -r 'split("\n") | map(select(length>0))')" 'select(.Test as $t | ($fail_tests | arrays)[] | select($t == .)) | select(.Output) | .Output' test_results.json | jq -r | sed ':a;N;$!ba;s/\n\n/\n/g'
+        run: |
+          jq --argjson fail_tests "$(jq -c -r 'select(.Action == "fail") | select(.Test) | .Test' test_results.json | jq -R -s -c -r 'split("\n") | map(select(length>0))')" 'select(.Test as $t | ($fail_tests | arrays)[] | select($t == .)) | select(.Output) | .Output' test_results.json | jq -r | sed ':a;N;$!ba;s/\n\n/\n/g' > test_failures.json
+          cat test_failures.json
+          exit 1
       - name: Upload test results
         if: ${{ always() && env.TARGET_GOLANG_VERSION == matrix.go }}
         uses: actions/upload-artifact@v3
         with:
           name: test-results
           path: |
-            test_results.json
+            test_*.json
       - name: Annotate tests on GitHub
         # Only annotate if the test failed on target version to avoid duplicated annotations on GitHub.
         if: ${{ always() && env.TARGET_GOLANG_VERSION == matrix.go }}

.gitignore

@@ -41,7 +41,6 @@ libp2p/types/mocks/*
 persistence/types/mocks/*
 !persistence/types/mocks/mocks.go
 
-
 # TODO(team): Does the `types` directory contain generated or raw type files?
 # types/
 
@@ -72,6 +71,7 @@ build/config/gen*.json
 # Binary downloads and manipulations by helm
 **/charts
 **/tmpcharts
+!/charts
 
 # Ignored generated files by build
 bin/*
@@ -88,6 +88,5 @@ localnet_config.yaml
 # Local files created during https://github.com/pokt-network/pocket/wiki creation
 tools/wiki
 
-
 # ignore highest precedence config file read by default
 /config.json

Makefile

@@ -513,9 +513,8 @@ localnet_logs_validators_follow: ## Outputs logs from all validators and follows
 	kubectl logs -l v1-purpose=validator --all-containers=true --max-log-requests=1000 --tail=-1 -f
 
 .PHONY: localnet_down
-localnet_down: ## Stops LocalNet and cleans up dependencies (tl;dr `tilt down` + postgres database)
+localnet_down: ## Stops LocalNet and cleans up dependencies (tl;dr `tilt down`)
 	tilt down --file=build/localnet/Tiltfile
-	kubectl delete pvc --ignore-not-found=true data-dependencies-postgresql-0
 
 .PHONY: localnet_db_cli
 localnet_db_cli: ## Open a CLI to the local containerized postgres instancedb_cli:

app/client/doc/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.0.0.28] - 2023-04-14
+## [0.0.0.28] - 2023-04-17
 
 - Refactor debug CLI post P2P module re-consolidation
 

build/docs/CHANGELOG.md

@@ -7,12 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.0.0.34] - 2023-04-14
+## [0.0.0.35] - 2023-04-17
 
 - Removed runtime/configs.Config#UseLibp2p field
 - Use pod IP for validator DNS resolution tilt localnet
 - Add `LIBP2P_DEBUG` env var
 
+## [0.0.0.34] - 2023-04-14
+
+- Changed LocalNet validators to use the new `pocket-validator` helm chart instead of templating the manifests with `sed`.
+- Each validator now has it's own postgres instance (as a helm chart dependency), which allows for clean scale up/down of the validators.
+- Cleaned up old manifests and scripts that are no longer needed.
+- Changed LocalNet documentation to reflect the new changes.
+
 ## [0.0.0.33] - 2023-04-13
 
 - Add persistent txIndexerPath to node configs

build/localnet/README.md

@@ -151,7 +151,13 @@ For example:
 
 ## How to change configuration files
 
-Currently, we provide [a config file](./manifests/configs.yaml) that is shared between all validators and a pocket client. We make use of `pocket` client feature that allows us to override configuration via environment variables. You can check a [validator template](./templates/v1-validator-template.yaml.tpl) as a reference.
+Configurations can be changed in helm charts where network protocol actor configs are maintained. You can find them in [this directory](../../charts).
+
+`config.json` file is created using the `config` section content in`values.yaml`. For example, you can find the configuration for a validator [here](../../charts/pocket-validator/values.yaml#70).
+
+If you need to add a new parameter – feel free to modify the section in place. Some of the parameters that contain secrets (e.g. private key), are stored in Secrets object and injected as environment variables.
+
+Please refer to helm charts documentation for more details.
 
 ## How does it work?
 
@@ -205,12 +211,9 @@ build/localnet
 │   │   ├── dashboards.yml
 │   │   └── datasources.yml
 │   └── values.yaml # Configuration values that override the default values of the dependencies, this allows us to connect dependencies together and make them available to our LocalNet services
-├── manifests # Static YAML Kubernetes manifests that are consumed by `tilt`
-│   ├── cli-client.yaml # Pod that has the latest binary of the pocket client. Makefile targets run CLI in this pod.
-│   ├── configs.yaml # Location of the config files (default configs for all validators and a genesis file) that are shared across all actors
-│   ├── network.yaml # Networking configuration that is shared between different actors, currently a Service that points to all validators
-│   └── private-keys.yaml # Pre-generated private keys with a semantic format for easier development
-└── templates # Templates for Kubernetes manifests that are consumed by `tilt`
-    ├── v1-validator-template.sh # Shell script that generates Kubenetes manifests for validators, consumed by `tilt`
-    └── v1-validator-template.yaml.tpl # Template for a single validator, consumed by `v1-validator-template.sh`
+└── manifests # Static YAML Kubernetes manifests that are consumed by `tilt`
+    ├── cli-client.yaml # Pod that has the latest binary of the pocket client. Makefile targets run CLI in this pod.
+    ├── configs.yaml # Location of the config files (default configs for all validators and a genesis file) that are shared across all actors
+    ├── network.yaml # Networking configuration that is shared between different actors, currently a Service that points to all validators
+    └── private-keys.yaml # Pre-generated private keys with a semantic format for easier development
 ```

build/localnet/Tiltfile

@@ -44,40 +44,22 @@ deps = [
 
 deps_full_path = [root_dir + "/" + depdir for depdir in deps]
 
-# Deploy dependencies (grafana, postgres, prometheus) and wire it up with localnet
-helm_repo(
-    "grafana",
-    "https://grafana.github.io/helm-charts",
-    resource_name="helm-repo-grafana",
-    labels=["helm"]
-)
-helm_repo(
-    "prometheus-community",
-    "https://prometheus-community.github.io/helm-charts",
-    resource_name="helm-repo-prometheus",
-    labels=["helm"]
-)
-helm_repo(
-    "bitnami",
-    "https://charts.bitnami.com/bitnami",
-    resource_name="helm-repo-bitnami",
-    labels=["helm"]
-)
+# Avoid downloading dependencies if no missing/outdated charts are found
+def check_helm_dependencies_for_chart(path):
+    check_helm_dependencies = local(
+        "helm dependency list " + path + " | awk '{print $4}' | grep -Ev 'ok|STATUS'"
+    )
+    helm_dependencies_not_ok_count = len(str(check_helm_dependencies).splitlines())
+    if helm_dependencies_not_ok_count > 1:
+        local("helm dependency update " + path)
 
-# Avoid downloading dependencies if no missing/outdated charts
-check_helm_dependencies = local(
-    "helm dependency list dependencies | awk '{print $4}' | grep -Ev 'ok|STATUS'"
-)
-helm_dependencies_not_ok_count = len(str(check_helm_dependencies).splitlines())
-if helm_dependencies_not_ok_count > 1:
-    local("helm dependency update dependencies")
+check_helm_dependencies_for_chart("dependencies")
 
 k8s_yaml(helm("dependencies", name="dependencies", namespace="default"))
 k8s_resource("dependencies-prometheus-pushgateway", labels=["monitoring"])
 k8s_resource("dependencies-loki", labels=["monitoring"])
 k8s_resource("dependencies-prometheus-node-exporter", labels=["monitoring"])
 k8s_resource("dependencies-prometheus-alertmanager", labels=["monitoring"])
-k8s_resource("dependencies-postgresql", labels=["database"])
 k8s_resource("dependencies-grafana", labels=["monitoring"])
 k8s_resource("dependencies-kube-state-metrics", labels=["monitoring"])
 k8s_resource("dependencies-promtail", labels=["monitoring"])
@@ -122,8 +104,8 @@ WORKDIR /
     only=["./bin/pocket-linux"],
     entrypoint=[
         "/usr/local/bin/pocket",
-        "-config=/configs/config.json",
-        "-genesis=/genesis.json",
+        "-config=/pocket/configs/config.json",
+        "-genesis=/pocket/configs/genesis.json",
     ],
     live_update=[sync("bin/pocket-linux", "/usr/local/bin/pocket")],
 )
@@ -176,22 +158,25 @@ k8s_yaml(["manifests/cli-client.yaml"])
 k8s_resource('pocket-v1-cli-client', labels=['client'])
 k8s_yaml(['manifests/cluster-manager.yaml'])
 k8s_resource('pocket-v1-cluster-manager', labels=['cluster-manager'])
-k8s_yaml(
-    [
-        local(
-            "templates/v1-validator-template.sh %s"
-            % localnet_config["validators"]["count"],
-            quiet=True,
-        ),
-    ]
-)
-
 
-# Uncomment in order to expose postgres port to 5432 on the host machine in case the developer wants to connect to postgres directly
-# First port is the port on the host machine, second is the port on the container, so if you already have postgres running on the host machine, you can change the first port to something else
-# k8s_resource(new_name='postgres',
-#              workload="dependencies-postgresql",
-#              port_forwards="5432:5432")
+check_helm_dependencies_for_chart(root_dir + "/charts/pocket-validator")
+for x in range(localnet_config["validators"]["count"]):
+    validator_number = x + 1
+    formatted_validator_number = local('printf "%03d" ' + str(validator_number))
+
+    k8s_yaml(helm(root_dir + "/charts/pocket-validator",
+        name="validator-%s" % formatted_validator_number,
+        namespace="default",
+        set=[
+            "image.repository=validator-image",
+            "privateKeySecretKeyRef.name=v1-localnet-validators-private-keys",
+            "privateKeySecretKeyRef.key=%s" % formatted_validator_number,
+            "genesis.preProvisionedGenesis.enabled=false",
+            "genesis.externalConfigMap.name=v1-localnet-genesis",
+            "genesis.externalConfigMap.key=genesis.json",
+            "postgresql.primary.persistence.enabled=false",
+        ]
+    ))
 
 # Exposes grafana
 k8s_resource(

build/localnet/dependencies/requirements.yaml

@@ -15,7 +15,3 @@ dependencies:
     condition: prometheus.enabled
     version: "~15.5.3"
     repository: "https://prometheus-community.github.io/helm-charts"
-  - name: "postgresql"
-    condition: postgresql.enabled
-    version: "~12.1.8"
-    repository: "https://charts.bitnami.com/bitnami"

build/localnet/dependencies/values.yaml

@@ -1,8 +1,3 @@
-global:
-  postgresql:
-    auth:
-      postgresPassword: LocalNetPassword
-
 grafana:
   enabled: true
   adminPassword: none
@@ -64,9 +59,3 @@ prometheus:
   url: http://{{ include "prometheus.fullname" .}}:{{ .Values.prometheus.server.service.servicePort }}{{ .Values.prometheus.server.prefixURL }}
   datasource:
     jsonData: {}
-
-# https://github.com/bitnami/charts/blob/main/bitnami/postgresql/values.yaml
-postgres:
-  enabled: true
-  image:
-    tag: "14"

build/localnet/manifests/cli-client.yaml

@@ -17,13 +17,13 @@ spec:
     spec:
       serviceAccountName: debug-client-account
       initContainers:
-        - name: wait-for-v1-validator001
+        - name: wait-for-validator-001-pocket-validator
           image: busybox
           command:
             [
               "sh",
               "-c",
-              "until nc -z v1-validator001 42069; do echo waiting for v1-validator001...; sleep 2; done;",
+              'until wget -q -O - "http://validator-001-pocket-validator:50832/v1/health" --timeout=2 --tries=2 --spider >/dev/null 2>&1; do echo waiting for validator-001-pocket-validator to be online and healthy...; sleep 2; done;',
             ]
       containers:
         - name: pocket
@@ -75,7 +75,7 @@ spec:
               value: validator1
               # Any host that is visible and connected to the cluster can be arbitrarily selected as the RPC host
             - name: RPC_HOST
-              value: v1-validator001
+              value: pocket-validators
               # TECHDEBT(#678): debug client requires hostname to participate
               # in P2P networking.
             - name: POCKET_P2P_HOSTNAME
@@ -91,7 +91,7 @@ spec:
       volumes:
         - name: config-volume
           configMap:
-            name: v1-validator-default-config
+            name: validator-001-pocket-validator-config
             defaultMode: 420
         - name: genesis-volume
           configMap:

build/localnet/manifests/cluster-manager.yaml

@@ -4,18 +4,21 @@ metadata:
   name: pocket-v1-cluster-manager
 spec:
   initContainers:
-    - name: wait-for-v1-validator001
+    - name: wait-for-validator-001-pocket-validator
       image: busybox
       command:
         [
           "sh",
           "-c",
-          'until wget -q -O - "http://v1-validator001:50832/v1/health" --timeout=2 --tries=2 --spider >/dev/null 2>&1; do echo waiting for v1-validator001 to be online and healthy...; sleep 2; done;',
+          'until wget -q -O - "http://validator-001-pocket-validator:50832/v1/health" --timeout=2 --tries=2 --spider >/dev/null 2>&1; do echo waiting for validator-001-pocket-validator to be online and healthy...; sleep 2; done;',
         ]
   containers:
     - name: cluster-manager
       image: cluster-manager-image
       imagePullPolicy: IfNotPresent
       args:
         - cluster-manager
+      env:
+        - name: RPC_HOST
+          value: pocket-validators
   serviceAccountName: cluster-manager-account