Skip to content

Commit

Permalink
[doc] debug does not work with buildpack builder and maybe custom b…
Browse files Browse the repository at this point in the history
…uilder too
  • Loading branch information
briandealwis committed Nov 7, 2019
1 parent f12e9f9 commit 242261d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 12 deletions.
28 changes: 16 additions & 12 deletions docs/content/en/docs/pipeline-stages/builders/buildpacks.md
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
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
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
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

`skaffold debug` requires being able to examine and alter the
command-line used to launch a program, and as such will not work
with images that use intermediate an launch scripts or binaries.
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

0 comments on commit 242261d

Please sign in to comment.