tilt-dev / tilt-dev/tilt

Provide a way to hide port-forwards in the Tilt UI

Open
#5,485 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
10.1k
Forks
413
Avg merge
1d 10h
Merged PRs (30d)
6

Description

When I am developing APIs that are used internally (e.g. REST or gRPC), I need to create port-forwards to things that do not display a webpage, but are used by other applications. In these situations, I want to add a Link to a k8s_resource referencing my other application that uses an API, and not show an HTTP address to the API endpoint itself in the Tilt UI.

One example is when I am running a GraphQL Playground separately that connects to a graphql API. I do not want to show the API endpoint as an HTTP URL in the Tilt UI. Instead, I can add a Link to the GraphQL Playground website where I can make interactive calls to the API using my port-forward.

Unfortunately, there does not seem to be any option to create a port-forward and completely hide or make non-clickable the hyperlink in the UI.
https://github.com/tilt-dev/tilt/blob/d79b05e6a6f667e0a34599878a36394590fc8932/pkg/model/manifest.go#L448-L450

This has been pretty confusing for my users, since they get a set of links like http://localhost:8080 that just show error codes if clicked. Right now I am using the option name="dontclickme", but this is a silly workaround.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the k8s_resource port-forward fields in pkg/model/manifest.go around lines 448-450, then trace how those values are rendered in the Tilt UI. Done means a port-forward can be created without showing a clickable HTTP endpoint, while an explicit Link to another application remains visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
devtools, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.