hyperweb-io / hyperweb-io/starship

spike: Docker-compose for local setup

Open
#144 3 comments 0 reactions 0 assignees View on GitHub
high-priority spike
Dominant language
TypeScript
Stars
77
Forks
39
PR merge metrics
No merged PRs in 30d

Description

## Overview
As a user, one does not care where and how the system is being run as long as it is consistent, locally, on the CI and in the cluster.

Running k8s locally is still a bit of a hassle with docker-desktop it becomes a little easy.

## Proposal
What if we allow users to define a simple config file, but then still be able to run that with docker-compose. We will solve the local issues.
We can restrict the number of nodes to be spun as well as not allow multi-validator setup, but basically give users a development environment of there choices.

## Design
We would have to redo alot of stuff that k8s provides for free, mostly around init-containers, templating with helm and more to get this to work. But this would be a good feature to have for local testing.

## User inputs
Users still just needs to provide a simple config file as input, same configuration, and we can create a docker-compose template for running it, first via the Makefile, then via the cli.

Multiple backend supports would be really big for Starship, specially for the initial hurdle of onboarding users to Starship.

NOTE: We would need to restrict the features for docker-compose based on the limitations of the framework itself.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing Kubernetes and Helm setup, then inspect the Makefile entry point mentioned for generating local configuration. The issue names no specific files or tests, so first define the supported config inputs and Docker Compose limitations. Done means a documented, working local Compose environment with restricted features and node or validator counts.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, helm, kubernetes
Domain
cli, devops, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.