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

[Documentation] More ways to deploy poktrolld #526

Open
4 tasks
okdas opened this issue May 10, 2024 · 8 comments
Open
4 tasks

[Documentation] More ways to deploy poktrolld #526

okdas opened this issue May 10, 2024 · 8 comments
Assignees
@okdas
Labels
documentation Improvements or additions to documentation
Milestone
Shannon Beta Test...

Comments

@okdas
Copy link
Member

okdas commented May 10, 2024 •
edited
Loading

Objective

Document how to deploy and use poktrolld in different environments.

Origin Document

Currently we only provide an example of how to deploy in poktroll-docker-compose-example repo, but we also need to add documentation how to run in other environments.

Goals

  • Document how to run fullnode/supplier/appgate without docker (systemd?)
  • Document helm charts (v1 helm charts are a good example - they were documented) and provide a simple example on how to push to k8s cluster
  • Document how to maintain the validator process with cosmovisor.

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: @okdas
@okdas okdas self-assigned this May 10, 2024
@okdas okdas added the documentation Improvements or additions to documentation label May 10, 2024
@okdas okdas added this to the Shannon Public TestNet milestone May 10, 2024
@okdas
Copy link
Member Author

okdas commented May 10, 2024

cc @Olshansk

@okdas
Copy link
Member Author

okdas commented May 10, 2024

@Olshansk we can separate k8s helm chart docs into the separate ticket

@Olshansk
Copy link
Member

@Olshansk we can separate k8s helm chart docs into the separate ticket

Let's do it and mark them as deliverables in that ticket.

@okdas
Copy link
Member Author

okdas commented Jul 16, 2024

We must cover https://docs.cosmos.network/main/build/tooling/cosmovisor as this is the sidecar process that is used with x/upgrade to upgrade the binary on particular heights.

@coderabbitai coderabbitai bot mentioned this issue Jul 25, 2024
Merged
14 tasks
@okdas okdas mentioned this issue Aug 28, 2024
Merged
14 tasks
@okdas
Copy link
Member Author

okdas commented Sep 3, 2024

Moving this to the next iteration because I recently realized I want to also add Cosmovisor to the docker-compose setup. It should be quick and easy, but will only become usable after the next release.

After that — I'll create a separate issue to deploy off-chain actors on fly.io as this is a great platform for our use case.

@Olshansk
Copy link
Member

Olshansk commented Sep 3, 2024

@okdas Curious why fly.io over render.com?

Only asking because I know the founding team in the latter.

@okdas
Copy link
Member Author

okdas commented Sep 3, 2024

@Olshansk fly.io offers an entirely different approach to how the service is deployed across regions.

TLDR is their public network IP addresses are anycast - basically what GCP MCI offers but natively (meaning not a half-baked solution, but something that fly.io is built on from the beginning).

From what I understand, render.com is basically a PaaS.

@Olshansk
Copy link
Member

Olshansk commented Sep 4, 2024

@okdas This is really great to know!

I think fly.io might be a good one click deployment partner in the future then :)

okdas added a commit that referenced this issue Sep 9, 2024
@okdas @Olshansk
[Documentation] Cosmovisor (#768)
5ee73d4 
## Summary

Adds documentation on how to deploy a Validator and a Full Node using
Cosmovisor.

## Issue

- #526 

## Type of change

Select one or more:

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [x] 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]>
@okdas okdas mentioned this issue Sep 18, 2024
Merged
15 tasks
Olshansk added a commit that referenced this issue Sep 20, 2024
@okdas @Olshansk
[Documentation] Change container names in the quickstart (#830)
e2ab1fc 
## Summary

Updates the documentation after changes in
pokt-network/poktroll-docker-compose-example#25

## Issue

- #526
- the current names are not great

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

@okdas okdas

Labels
documentation Improvements or additions to documentation
Projects
Shannon
Status: 🏗 In progress
Milestone
Shannon Beta TestNet Launch
Development

No branches or pull requests
2 participants
@Olshansk @okdas