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.

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

Should skaffold debug be configurable per artifact? #2184

Open
corneliusweig opened this issue May 27, 2019 · 6 comments
Open

Should skaffold debug be configurable per artifact? #2184

corneliusweig opened this issue May 27, 2019 · 6 comments
Labels
area/debug kind/design discussion kind/feature-request priority/awaiting-more-evidence Lowest Priority. May be useful, but there is not yet enough supporting evidence.

Comments

@corneliusweig
Copy link
Contributor

corneliusweig commented May 27, 2019

Maybe this is not a real concern. But if somebody has many microservices and wants to debug exactly one, there is currently no way to tell Skaffold that all the other containers should run conventionally.

My concern is that debug requires more resources and makes applications slower. If I already know which part I want to debug, I don't like all other microservices being run in debug mode as well. WDYT?

CC @briandealwis

@briandealwis
Copy link
Member

I think it makes sense. Perhaps the command line can be extended to allow specifying the specific artifacts to be debugged.

@nkubala
Copy link
Contributor

nkubala commented Jun 3, 2019

we could also mark the artifacts in the skaffold.yaml as debug: false if we know that we don't want to debug them. that might be easier for users than specifying --debug-artifact=gcr.io/debug/container on the CLI, though I don't see any reason why we can't have both.

@corneliusweig
Copy link
Contributor Author

If debug=true/false is also added in the skaffold.yaml, why not open up a new group such as:

artifacts:
- image: gcr.io/foo/bar
  debug:
    enabled: true
    runtimeType: go

See #2203 for details about runtimeType

@tejal29 tejal29 added the priority/p2 May take a couple of releases label Aug 21, 2019
@briandealwis briandealwis added priority/awaiting-more-evidence Lowest Priority. May be useful, but there is not yet enough supporting evidence. and removed priority/p2 May take a couple of releases labels Apr 26, 2020
@briandealwis
Copy link
Member

Right now an artifact can be ignored by adding an annotation to the resource's metadata like the following:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
  annotations:
    debug.cloud.google.com/config: "{}"

@briandealwis
Copy link
Member

Usecase: running a react serving front-end within Kubernetes https://nirajsonawane.github.io/2020/04/25/Deploy-React-Spring-Boot-MongoDB-Fullstack-application-on-Kubernetes/

The react serving container runs NPM but is not debuggable.

@briandealwis briandealwis removed their assignment Apr 26, 2021
@arikkfir
Copy link

Right now an artifact can be ignored by adding an annotation to the resource's metadata like the following:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
  annotations:
    debug.cloud.google.com/config: "{}"

Did not work for me on Skaffold v2.4.1 and configuration file at version v4beta5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/debug kind/design discussion kind/feature-request priority/awaiting-more-evidence Lowest Priority. May be useful, but there is not yet enough supporting evidence.
Projects
None yet
Development

No branches or pull requests

5 participants