Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Tooling] Integrate pocketdex into Tilt #873

Closed
1 of 5 tasks
bryanchriswhite opened this issue Oct 11, 2024 · 0 comments · Fixed by #885
Closed
1 of 5 tasks

[Tooling] Integrate pocketdex into Tilt #873

bryanchriswhite opened this issue Oct 11, 2024 · 0 comments · Fixed by #885
Assignees
@bryanchriswhite
Labels
enhancement New feature or request observability on-chain On-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Milestone
Shannon Beta Test...

Comments

@bryanchriswhite
Copy link
Contributor

bryanchriswhite commented Oct 11, 2024 •
edited
Loading

Objective

Incorporate an indexer into the Shannon localnet development environment. 💪

Origin Document

image

Goals

  • Integrate the pocketdex services into Shannon localnet Tilt environment.
  • Expose pocketdex for use in a local browser (on the host).

Deliverables

  • A PR which adds:
    • Pocketdex to poktroll as a git submodule. ❓
      • Shannon README update regarding how to sync/update git submodules
    • A pocketdex k8s deployment & service.
    • Shannon docusaurus doc page which links to pocketdex README/docs.

Non-goals / Non-deliverables

  • Adding any tests which exercise the indexer.
  • And unrelated changes to the Tiltfile or k8s resources.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite
Co-Owners: @Olshansk
@bryanchriswhite bryanchriswhite added enhancement New feature or request on-chain On-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc... observability labels Oct 11, 2024
@bryanchriswhite bryanchriswhite self-assigned this Oct 11, 2024
This was referenced Oct 14, 2024
Merged
Merged
@bryanchriswhite bryanchriswhite linked a pull request Oct 17, 2024 that will close this issue
[Indexer] Integrate pocketdex into Tiltfile #885
Merged
15 tasks
bryanchriswhite added a commit to pokt-network/pocketdex that referenced this issue Oct 23, 2024
@bryanchriswhite
[Tooling] Integrate Tilt development environment (#23)
68ff6a5 
## Summary

Integrate [Tilt](https://docs.tilt.dev/) (and k8s/helm) development
environment.

Run:
```
tilt up
```

## Issue

- pokt-network/poktroll#873

## Type of change

Select one or more:

- [x] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Documentation
- [ ] Other (specify)

## Testing

**Documentation changes** (only if making doc changes)
- [ ] `make docusaurus_start`; only needed if you make doc changes

**Local Testing** (only if making code changes)
- [ ] **Unit Tests**: `make go_develop_and_test`
- [ ] **LocalNet E2E Tests**: `make test_e2e`
- See [quickstart
guide](https://dev.poktroll.com/developer_guide/quickstart) for
instructions

**PR Testing** (only if making code changes)
- [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR.
- **THIS IS VERY EXPENSIVE**, so only do it after all the reviews are
complete.
- Optionally run `make trigger_ci` if you want to re-trigger tests
without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as
shown
[here](https://github.com/pokt-network/poktroll/assets/1892194/607984e9-0615-4569-9452-4c730190c1d2)


## Sanity Checklist

- [ ] I have tested my changes using the available tooling
- [ ] I have commented my code
- [ ] I have performed a self-review of my own code; both comments &
source code
- [ ] I create and reference any new tickets, if applicable
- [ ] I have left TODOs throughout the codebase, if applicable
bryanchriswhite added a commit that referenced this issue Oct 24, 2024
@bryanchriswhite @Olshansk
[Indexer] Integrate pocketdex into Tiltfile (#885)
96a9d29 
## Summary

- Adds the pocketdex to the tilt environment **if it has been cloned to
a sibling directory as "pocketdex"**
- Otherwise, if `localnet_config.yaml` has `indexer.enabled` and
`indexer.clone_if_not_present` set to `true` Tilt will clone it to a
sibling directory
- Otherwise a stub service titled "Indexer Disabled" under the
"Pocketdex" label group explains what changes need to be made to the
localnet_config.yaml:


![image](https://github.com/user-attachments/assets/c51f6abc-8430-4788-8442-b309cdbd01a9)

```
Running cmd: echo 'Pocketdex indexer disabled. Set `indexer.enabled` to `true` in `localnet_config.yaml` to enable it.'
Pocketdex indexer disabled. Set `indexer.enabled` to `true` in `localnet_config.yaml` to enable it.
```

```
Running cmd: echo 'Pocketdex repo not found. Set `clone_if_not_present` to `true` in `localnet_config.yaml` to clone the repo.'
Pocketdex repo not found. Set `clone_if_not_present` to `true` in `localnet_config.yaml` to clone the repo.
```

## Issue

- #873 

## Type of change

Select one or more from the following:

- [x] New feature, functionality or library
- [ ] Consensus breaking; add the `consensus-breaking` label if so. See
#791 for details
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Documentation
- [ ] Other (specify)

## Testing

- [ ] **Documentation**: `make docusaurus_start`; only needed if you
make doc changes
- [ ] **Unit Tests**: `make go_develop_and_test`
- [ ] **LocalNet E2E Tests**: `make test_e2e`
- [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR.

## Sanity Checklist

- [ ] I have tested my changes using the available tooling
- [ ] I have commented my code
- [ ] I have performed a self-review of my own code; both comments &
source code
- [ ] I create and reference any new tickets, if applicable
- [ ] I have left TODOs throughout the codebase, if applicable

---------

Co-authored-by: Daniel Olshansky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bryanchriswhite bryanchriswhite

Labels
enhancement New feature or request observability on-chain On-chain business logic tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Shannon
Status: ✅ Done
Milestone
Shannon Beta TestNet Launch
Development

Successfully merging a pull request may close this issue.

[Indexer] Integrate pocketdex into Tiltfile pokt-network/poktroll
1 participant
@bryanchriswhite