GoogleContainerTools/skaffold

Skaffold port forwarding gets into broken state after modifying artifact image name in Skaffold Config

Open

#6,480 opened on Aug 20, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/portforwardbugbash/q4-2022help wantedkind/bugpriority/p1

Description

  1. Clone the cloud-code-samples and go to the golang/go-hello-world dir.
  2. Start a skaffold dev session using a command like /Users/michihara/bin/skaffold dev --filename skaffold.yaml --label ide=Idea --label ideVersion=2021.1.3.0.0 --label ijPluginVersion=21.7.2-SNAPSHOT --rpc-port=50051 --port-forward=true --wait-for-deletions-max=2m0s --status-check=true --enable-rpc=true
  3. The go-hello-world-external service should be port forwarded. A message like Port forwarding service/go-hello-world-external in namespace default, remote port 80 -> http://127.0.0.1:4503 should appear in the logs. Clicking on http://127.0.0.1:4503 should lead to a sample hello world page.
  4. Modify the image name in skaffold.yaml.
  5. Skaffold should rebuild. http://127.0.0.1:4503 should no longer work.
  6. Undo the image name change in skaffold.yaml.
  7. Skaffold should rebuild. http://127.0.0.1:4503 still doesn't work although I expected it to.
  8. Skaffold is now in a state where port forwarding no longer seems to work no matter what change is made.

https://user-images.githubusercontent.com/79073/130265519-45d661d5-317a-4945-8ddb-bfdda411e348.mov

Contributor guide

Tech stack
gokubernetesdocker
Domain
backenddevops
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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 programmingKubernetesSkaffold internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the port forwarding logic in Skaffold, focusing on the code that handles artifact image name changes. Look into the pkg/skaffold/portforward directory for the forwarding manager. The issue likely arises from incorrect cleanup or re initialization of port forwarding when the image name is modified. Check if there are any existing tests for this scenario and consider writing a test to reproduce the bug.