[Infrastructure] LocalNet on Kubernetes

.gitignore

@@ -34,7 +34,6 @@ shared/modules/mocks/*
 p2p/types/mocks/*
 !p2p/types/mocks/mocks.go
 
-
 # TODO(team): Does the `types` directory contain generated or raw type files?
 # types/
 
@@ -62,9 +61,15 @@ rpc/client.gen.go
 # Ignored generated files by build/config/main.go
 build/config/gen*.json
 
+# Binary downloads and manipulations by helm
+**/charts
+**/tmpcharts
+
 # Ignored generated files by build
 bin/*
 
 # Validator keys used for testing/demoes
 val1.json
-val2.json
+val2.json
+
+localnet_config.yaml

.tiltignore

@@ -0,0 +1,56 @@
+# Binaries for programs and plugins
+
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Vim swap files
+*.swp**
+
+# Vscode
+.vscode
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# MacOS metadata
+.DS_Store
+
+# Intellij / Goland dot files
+.idea/
+
+# Generated Mocks (for testing)
+shared/modules/mocks/
+p2p/types/mocks/
+
+# TODO(team): Does the `types` directory contain generated or raw type files?
+# types/
+
+# ignore protobuf generated files
+*.pb.go
+
+# Local debugging
+temp_test.go
+
+# Output of the go test results and coverage report (used by CI)
+test_results.json
+coverage.out
+
+# Output of `make build_and_watch`
+main
+
+# generated RPC server and client from openapi.yaml
+rpc/server.gen.go
+rpc/client.gen.go
+
+# Ignored generated files by build/config/main.go
+build/config/gen*.json
+
+# Binary downloads and manipulations by helm
+**/charts
+**/tmpcharts

Makefile

@@ -101,6 +101,7 @@ install_cli_deps: ## Installs `protoc-gen-go`, `mockgen`, 'protoc-go-inject-tag'
 	go install "github.com/golang/mock/mockgen@v1.6.0" && mockgen --version
 	go install "github.com/favadi/protoc-go-inject-tag@latest"
 	go install "github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.11.0"
+	curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash
 
 .PHONY: develop_start
 develop_start: ## Run all of the make commands necessary to develop on the project
@@ -442,6 +443,37 @@ gen_genesis_and_config: ## Generate the genesis and config files for LocalNet
 clear_genesis_and_config: ## Clear the genesis and config files for LocalNet
 	rm build/config/gen.*.json
 
+.PHONY: localnet_up
+## Starts up a LocalNet with all necessary dependencies (tl;dr `tilt up`)
+localnet_up:
+	tilt up
+
+.PHONY: localnet_client_debug
+## Opens a `client debug` cli. It allows to interact with blockchain, e.g. change pace maker mode, reset to genesis, etc. Though the binary updated automatiacally on every code change, if client is already open you need to re-run this command to execute freshly compiled binary.
+localnet_client_debug:
+	kubectl exec -it deploy/pocket-v1-cli-client -- client debug
+
+.PHONY: localnet_shell
+## Opens a shell in the pod that has `client` cli available. The binary updated automatically whenever the code changes.
+localnet_shell:
+	kubectl exec -it deploy/pocket-v1-cli-client -- /bin/bash
+
+.PHONY: localnet_logs_validators
+## Outputs logs from all validators
+localnet_logs_validators:
+	kubectl logs -l v1-purpose=validator --all-containers=true --tail=-1
+
+.PHONY: localnet_logs_validators_follow
+## Outputs logs from all validators and follows them
+localnet_logs_validators_follow:
+	kubectl logs -l v1-purpose=validator --all-containers=true --max-log-requests=1000 --tail=-1 -f
+
+.PHONY: localnet_down
+## Stops LocalNet and cleans up dependencies (tl;dr `tilt down` + postgres database)
+localnet_down:
+	tilt down
+	kubectl delete pvc data-dependencies-postgresql-0
+
 .PHONY: check_cross_module_imports
 check_cross_module_imports: ## Lists cross-module imports
 	$(eval exclude_common=--exclude=Makefile --exclude-dir=shared --exclude-dir=app --exclude-dir=runtime)

Tiltfile

@@ -0,0 +1,100 @@
+load('ext://helm_resource', 'helm_resource', 'helm_repo')
+load('ext://namespace', 'namespace_create')
+load('ext://restart_process', 'docker_build_with_restart')
+
+# Create localnet config file from defaults, and if some default configuration doesn't exist in it - populate with default values
+localnet_config_defaults = {
+    "validators": {
+        "count": 4
+    }
+}
+
+localnet_config_file = read_yaml('localnet_config.yaml', default=localnet_config_defaults)
+localnet_config = {}
+localnet_config.update(localnet_config_defaults)
+localnet_config.update(localnet_config_file)
+
+if localnet_config_file != localnet_config:
+    print('Updating localnet_config.yaml')
+    local('cat - > localnet_config.yaml', stdin=encode_yaml(localnet_config))
+
+# List of directories Tilt watches to trigger a hot-reload on changes
+deps = [
+    'app',
+    # 'build',
+    'consensus',
+    'p2p',
+    'persistance',
+    'rpc',
+    'runtime',
+    'shared',
+    'telemetry',
+    'utility',
+    'vendor',
+    'logger'
+]
+
+# 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')
+helm_repo('prometheus-community', 'https://prometheus-community.github.io/helm-charts', resource_name='helm-repo-prometheus')
+helm_repo('bitnami', 'https://charts.bitnami.com/bitnami', resource_name='helm-repo-bitnami')
+
+# Avoid downloading dependencies if no missing/outdated charts
+check_helm_dependencies = local("helm dependency list build/localnet/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 build/localnet/dependencies')
+
+k8s_yaml(helm("build/localnet/dependencies", name='dependencies', namespace="default"))
+
+# Builds the pocket binary. Note target OS is linux, because no matter what your OS is, container runs linux natively or in VM.
+local_resource('pocket: Watch & Compile', 'GOOS=linux go build -o bin/pocket-linux app/pocket/main.go', deps=deps)
+local_resource('debug client: Watch & Compile', 'GOOS=linux go build -tags=debug -o bin/client-linux app/client/*.go', deps=deps)
+
+# Builds and maintains the validator container image after the binary is built on local machine, restarts a process on code change
+docker_build_with_restart('validator-image', '.',
+    dockerfile_contents='''FROM debian:bullseye
+COPY bin/pocket-linux /usr/local/bin/pocket
+WORKDIR /
+''',
+    only=['./bin/pocket-linux'],
+    entrypoint=["/usr/local/bin/pocket", "-config=/configs/config.json", "-genesis=/genesis.json"],
+    live_update=[
+        sync('bin/pocket-linux', '/usr/local/bin/pocket')
+    ]
+)
+
+# Builds and maintains the client container image after the binary is built on local machine
+docker_build_with_restart('client-image', '.',
+    dockerfile_contents='''FROM debian:bullseye
+WORKDIR /
+COPY bin/client-linux /usr/local/bin/client
+''',
+    only=['bin/client-linux'],
+    entrypoint=["sleep", "infinity"],
+    live_update=[
+        sync('bin/client-linux', '/usr/local/bin/client')
+    ]
+)
+
+# TODO(@okdas): https://github.com/tilt-dev/tilt/issues/3048
+# Pushes localnet manifests to the cluster.
+k8s_yaml([
+    'build/localnet/private-keys.yaml',
+    'build/localnet/configs.yaml',
+    'build/localnet/cli-client.yaml',
+    'build/localnet/network.yaml',
+    local("build/localnet/v1-validator-template.sh %s" % localnet_config['validators']['count'], quiet=True),
+])
+
+# # Exposes postgres port to 5432 on the host machine.
+# k8s_resource(new_name='postgres',
+#              objects=['pocket-database:postgresql'],
+#              extra_pod_selectors=[{'cluster-name': 'pocket-database'}],
+#              port_forwards=5432)
+
+# Exposes grafana
+k8s_resource(new_name='grafana',
+             workload='dependencies-grafana',
+             extra_pod_selectors=[{'app.kubernetes.io/name': 'grafana'}],
+             port_forwards=['42000:3000'])

app/client/cli/debug.go

@@ -24,9 +24,6 @@ const (
 	PromptTriggerNextView        string = "TriggerNextView"
 	PromptTogglePacemakerMode    string = "TogglePacemakerMode"
 	PromptShowLatestBlockInStore string = "ShowLatestBlockInStore"
-
-	defaultConfigPath  = "build/config/config1.json"
-	defaultGenesisPath = "build/config/genesis.json"
 )
 
 var (
@@ -41,6 +38,9 @@ var (
 		PromptShowLatestBlockInStore,
 	}
 
+	defaultConfigPath  = getEnv("CONFIG_PATH", "build/config/config1.json")
+	defaultGenesisPath = getEnv("GENESIS_PATH", "build/config/genesis.json")
+
 	// validators holds the list of the validators at genesis time so that we can use it to create a debug address book provider.
 	// Its purpose is to allow the CLI to "discover" the nodes in the network. Since currently we don't have churn and we run nodes only in LocalNet, we can rely on the genesis state.
 	// HACK(#416): This is a temporary solution that guarantees backward compatibility while we implement peer discovery
@@ -97,6 +97,13 @@ func runDebug(cmd *cobra.Command, args []string) (err error) {
 	}
 }
 
+func getEnv(key, fallback string) string {
+	if value, ok := os.LookupEnv(key); ok {
+		return value
+	}
+	return fallback
+}
+
 func promptGetInput() (string, error) {
 	prompt := promptui.Select{
 		Label: "Select an action",

app/docs/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to CLI binaries will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.0.1] - 2023-01-31
+
+- Introduced `CONFIG_PATH` and `GENESIS_PATH` environment variables for debug CLI commands
+

build/config/config1.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a",
+  "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a"
+    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "c6c136d010d07d7f5e9944aa3594a10f9210dd3e26ebc1bc1516a6d957fd0df353ee26c82826694ffe1773d7b60d5f20dd9e91bdf8745544711bec5ff9c6fb4a",
+    "private_key": "0ca1a40ddecdab4f5b04fa0bfed1d235beaa2b8082e7554425607516f0862075dfe357de55649e6d2ce889acf15eb77e94ab3c5756fe46d3c7538d37f27f115e",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config2.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2",
+  "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2"
+    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "b37d3ba2f232060c41ba1177fea6008d885fcccad6826d64ee7d49f94d1dbc49a8b6be75d7551da093f788f7286c3a9cb885cfc8e52710eac5f1d5e5b4bf19b2",
+    "private_key": "ba81e6e56d293895b299bc495ae75d490644429a5e0028fabeb5e1871c1098e7eb2c78364525a210d994a83e02d18b4287ab81f6670cf4510ab6c9f51e296d91",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config3.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb",
+  "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb"
+    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "5db3e9d97d04d6d70359de924bb02039c602080d6bf01a692bad31ad5ef93524c16043323c83ffd901a8bf7d73543814b8655aa4695f7bfb49d01926fc161cdb",
+    "private_key": "25b385b367a827eaafcdb1003bd17a25f2ecc0d10d41f138846f52ae1015aa941041a9c76539791fef9bee5b4fcd5bf4a1a489e0790c44cbdfa776b901e13b50",
     "max_mempool_count": 100000
   },
   "telemetry": {

build/config/config4.json

@@ -1,14 +1,14 @@
 {
   "root_directory": "/go/src/github.com/pocket-network",
-  "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4",
+  "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45",
   "consensus": {
     "max_mempool_bytes": 500000000,
     "pacemaker_config": {
       "timeout_msec": 5000,
       "manual": true,
       "debug_time_between_steps_msec": 1000
     },
-    "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4"
+    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45"
   },
   "utility": {
     "max_mempool_transaction_bytes": 1073741824,
@@ -30,7 +30,7 @@
     "consensus_port": 8080,
     "use_rain_tree": true,
     "is_empty_connection_type": false,
-    "private_key": "6fd0bc54cc2dd205eaf226eebdb0451629b321f11d279013ce6fdd5a33059256b2eda2232ffb2750bf761141f70f75a03a025f65b2b2b417c7f8b3c9ca91e8e4",
+    "private_key": "4ff3292ff14213149446f8208942b35439cb4b2c5e819f41fb612e880b5614bdd6cea8706f6ee6672c1e013e667ec8c46231e0e7abcf97ba35d89fceb8edae45",
     "max_mempool_count": 100000
   },
   "telemetry": {