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.

Sign up for GitHub

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

Jump to bottom

[doc] debug does not work with buildpack builder and maybe custom builder images too #3204

Merged
merged 2 commits into from Nov 7, 2019
Merged

[doc] debug does not work with buildpack builder and maybe custom builder images too #3204

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
242261d
[doc] `debug` does not work with buildpack builder and maybe custom b…
briandealwis Nov 7, 2019
b59ed15
review nits
briandealwis Nov 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 16 additions & 12 deletions docs/content/en/docs/pipeline-stages/builders/buildpacks.md
View file
Open in desktop
Expand Up @@ -5,25 +5,21 @@ weight: 50
featureId: build.buildpacks
---

[Cloud Native Buildpacks](https://buildpacks.io/) enable building language-based
containers from source code, without the need for a Dockerfile.
[Cloud Native Buildpacks](https://buildpacks.io/) enable building
a container image from source code without the need for a Dockerfile.

Skaffold supports building with Buildpacks natively, without installing
additional software. However, Buildpacks require a local Docker daemon
to be used.
Skaffold supports building with Cloud Native Buildpacks, requiring only
a local Docker daemon. Skaffold performs the build inside a container
briandealwis marked this conversation as resolved.
Show resolved Hide resolved
using the `builder` specified in the `buildpack` config.

Once all the necessary data is present, Skaffold will build inside a container,
with the local Docker daemon, with ther builder image specified in `builder`,
in the `buildpack` config.

On successful build completion, built images will be pushed to the remote registry.
On successful build completion, the built image will be pushed to the remote registry.
You can choose to skip this step.

### Configuration

To use Buildpacks, add a `buildpack` field to each artifact you specify in the
`artifacts` part of the `build` section. `context` should be a path to
your sources.
your source.

The following options can optionally be configured:

Expand Down Expand Up @@ -63,4 +59,12 @@ buildpack:
- src/*.go
ignore:
- vendor/**
```
```

### Limitations

`skaffold debug` is unable to configure the container images produced
by Cloud Native Buildpacks for debugging. Images produced by the
produced by Cloud Native Buildpacks use a `launcher` binary that
briandealwis marked this conversation as resolved.
Show resolved Hide resolved
runs commands specified in a set of configuration files, which cannot
be altered by `debug`.
9 changes: 9 additions & 0 deletions docs/content/en/docs/workflows/debug.md
View file
Open in desktop
Expand Up @@ -102,6 +102,15 @@ DAP is not yet supported by JetBrains IDEs like PyCharm.

`skaffold debug` has some limitations.

### Entrypoints using Launchers or Scripts
briandealwis marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Entrypoints using Launchers or Scripts
### Unsupported container entrypoints

maybe? and then we can link to this from the other doc


`skaffold debug` requires being able to examine and alter the
command-line used to launch a program, and as such will not work
briandealwis marked this conversation as resolved.
Show resolved Hide resolved
with images that use intermediate an launch scripts or binaries.
briandealwis marked this conversation as resolved.
Show resolved Hide resolved
For example, `debug` cannot work with an image produced by the Cloud
Native Buildpacks builder as it uses a `launcher` binary to run
commands that are specified in a set of configuration files.

### Supported Deployers

`skaffold debug` is only supported with the `kubectl` and `kustomize` deployers at the moment: support for
Expand Down