GoogleContainerTools/skaffold

Allow port-forward mode to be configured in the skaffold.yaml

Open

#6,672 opened on Oct 4, 2021

View on GitHub
 (0 comments) (3 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/configarea/global-configarea/portforwardbugbash/q4-2022help wantedkind/feature-requestpriority/p2

Description

From https://github.com/GoogleContainerTools/skaffold/issues/4163#issuecomment-933830882, requesting that the Skaffold provide a way to configure the port-forward modes in the skaffold.yaml. For example:

deploy:
  portForwardModes: [user, services]

It would seem useful to support this setting in the global config too.

Contributor guide

Tech stack
go
Domain
devopscloud
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingKubernetes conceptsskaffold configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Start by examining the current port forward implementation in `pkg/skaffold/portforward/` to understand how modes are used. Look at the configuration structures in `pkg/skaffold/config/` to see how global settings are defined and loaded. Determine where to add a `portForwardModes` field in the deploy config and how to propagate it to the port forward logic. Check for any existing CLI flags or environment variables that might conflict. Review the referenced issue #4163 for additional context.