Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion Tiltfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ load("ext://restart_process", "docker_build_with_restart")
load("ext://helm_resource", "helm_resource", "helm_repo")
load('ext://k8s_attach', 'k8s_attach')
load("ext://configmap", "configmap_create")
load('ext://secret', 'secret_from_dict')

# A list of directories where changes trigger a hot-reload of PATH.
# IMPORTANT_DEV_NOTE: this list needs to be updated each time a new package is added to the repo.
Expand Down Expand Up @@ -101,12 +102,15 @@ LOCAL_DIR = "local"
PATH_LOCAL_DIR = LOCAL_DIR + "/path"
# The configuration file for PATH.
PATH_LOCAL_CONFIG_FILE = PATH_LOCAL_DIR + "/.config.yaml"
# The secrets file for local development.
SECRETS_FILE = LOCAL_DIR + "/secrets.yaml"

# --------------------------------------------------------------------------- #
# Configuration Resources #
# --------------------------------------------------------------------------- #
# 1. PATH Config Updater #
# 2. Patch Envoy Gateway LoadBalancer #
# 2. Local Development Secrets from secrets.yaml #
# 3. Patch Envoy Gateway LoadBalancer #
# --------------------------------------------------------------------------- #

# Start a Tilt resource to update the PATH config with the local config file.
Expand All @@ -123,6 +127,20 @@ local_resource(
labels=["configuration"],
)

# Load and create secrets from secrets.yaml using Tilt's secret extension
# This replaces the manual Python script approach with a cleaner Tilt-native solution
secrets_config = read_yaml(SECRETS_FILE, default={})
if secrets_config:
print("Creating secrets from local/secrets.yaml...")
for secret_name, secret_data in secrets_config.items():
print("Creating secret: " + secret_name)
k8s_yaml(secret_from_dict(secret_name, inputs=secret_data))
else:
print("No secrets.yaml found or empty, skipping secret creation")

# TODO_TECHDEBT(@adshmh): Migrate local development API keys to the new secrets.yaml file
# for centralized secret management and better organization.

# Start a Tilt resource to patch the Envoy Gateway LoadBalancer resource
# to ensure it is reachable from outside the cluster at "localhost:3070".
#
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ An easy way to think about **PATH** and **Pocket Network** is:

## Where do I get started?

To get started, allocate 1-3 hours of time and start with the [PATH Introduction](develop/path/1_introduction.md).
To get started, allocate 1-3 hours of time and start with the [PATH Quick Start](develop/path/1_quick_start.md).

It will go through all the details of how PATH works, how to configure it, and how to run it locally.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 6
title: PATH Helm Config (`.values.yaml`)
sidebar_position: 10
title: Reference - PATH Helm Config (`.values.yaml`)
description: PATH Helm Configurations
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 11
title: Morse Cheat Sheet (30-60 min)
description: Introductory guide for setting up PATH w/ Morse
---
Expand All @@ -26,7 +26,7 @@ This guide covers setting up `PATH` with the **Morse** protocol. In MainNet as o

## 0. Prerequisites

1. Prepare your environment by following the instructions in the [**environment setup**](2_environment.md) guide.
1. Prepare your environment by following the instructions in the [**Quick Start**](1_quick_start.md) guide.
2. Install the [**pocket CLI**](https://github.com/pokt-network/homebrew-pocket-core): CLI for interacting with Pocket's Morse Network

:::tip
Expand Down Expand Up @@ -178,7 +178,7 @@ feature unless you are customizing QoS modules yourself.

For more information, see:

- [PATH Configuration File](./5_configurations_path.md#hydrator_config-optional)
- [PATH Configuration File](./8_ref_configurations_path.md#hydrator_config-optional)
- [Supported QoS Services](../../learn/qos/1_supported_services.md)

:::tip
Expand Down
62 changes: 0 additions & 62 deletions docusaurus/docs/develop/path/1_introduction.md

This file was deleted.

40 changes: 40 additions & 0 deletions docusaurus/docs/develop/path/1_quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
sidebar_position: 1
title: Quick Start (< 10 min)
description: Quick intro and environment setup
---

<div align="center">
<h1>PATH API & Toolkit Harness</h1>
<img src="https://storage.googleapis.com/grove-brand-assets/Presskit/Logo%20Joined-2.png" alt="Grove logo" width="500"/>

</div>
<br/>

![Static Badge](https://img.shields.io/badge/Maintained_by-Grove-green)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/buildwithgrove/path/main-build.yml)
![GitHub last commit](https://img.shields.io/github/last-commit/buildwithgrove/path)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/buildwithgrove/path)
![GitHub Release](https://img.shields.io/github/v/release/buildwithgrove/path)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/buildwithgrove/path/total)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/buildwithgrove/path)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/buildwithgrove/path)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed/buildwithgrove/path)
![App Status](https://argocd.tooling.buildintheshade.com/api/badge?name=path-gateway&revision=true&showAppName=true)

# Quick Start

**1. Clone the repository**:
```bash
git clone https://github.com/buildwithgrove/path.git
cd ./path
```

**2. Install all dependencies**:
```bash
make install_tools
```

# What's Next

**[Shannon Cheat Sheet](2_cheatsheet_shannon.md)** - Configure PATH for the Shannon protocol
Loading