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

Clarify debug docs for deprecated Workload APIs #3092

Merged
merged 3 commits into from
Oct 18, 2019
Merged

Clarify debug docs for deprecated Workload APIs #3092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1822b78
clarify debug docs for deprecated Workload APIs
briandealwis Oct 18, 2019
59b2aa3
Avoid odd Hugo markdown rendering behaviour with shortcodes:
briandealwis Oct 18, 2019
39b6f98
fix the markdown for realz
briandealwis Oct 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/en/docs/pipeline-stages/builders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,11 @@ in Maven) that should produce a container image. Then for each such sub-project:
`:artifactId`, `groupId:artifactId`, or the relative path to the sub-project
_within the project_.

{{% alert title="Updating from earlier versions" %}}
{{< alert title="Updating from earlier versions" >}}
Skaffold had required Maven multi-module projects bind a Jib
`build` or `dockerBuild` goal to the *package* phase. These bindings are
<code>build</code> or <code>dockerBuild</code> goal to the <em>package</em> phase. These bindings are
no longer required with Jib 1.4.0 and should be removed.
{{% /alert %}}
{{< /alert >}}

#### Gradle

Expand Down
25 changes: 17 additions & 8 deletions docs/content/en/docs/workflows/debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ For these languages, a special set of [runtime-specific images](https://github.c
are configured as _init-containers_ to populate a shared-volume that is mounted into
each of the appropriate containers. These images are hosted at `gcr.io/gcp-dev-tools/duct-tape`.

{{< alert title="Caution" >}}
`skaffold debug` does not support deprecated versions of Workload API objects such as `apps/v1beta1`.
{{< /alert >}}

### Supported Language Runtimes

Expand Down Expand Up @@ -108,9 +105,21 @@ DAP is not yet supported by JetBrains IDEs like PyCharm.

## Limitations

`skaffold debug` has some limitations:
`skaffold debug` has some limitations.

### Supported Deployers

`skaffold debug` is only supported with the `kubectl` and `kustomize` deployers at the moment: support for
the Helm deployer is not yet available ([#2350](https://github.com/GoogleContainerTools/skaffold/issues/2350)).

### Deprecated Workload API Objects

`skaffold debug` does not support deprecated versions of Workload API objects:

- `apps/v1beta1` was [deprecated in Kubernetes 1.8](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.8.md#other-notable-changes-16)
- `apps/v1beta2` was [deprecated in Kubernetes 1.9](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md#apps)

Both have been [removed in Kubernetes 1.16](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/).
Applications should transition to the `apps/v1` APIs,
[introduced in Kubernetes 1.9](https://kubernetes.io/blog/2017/12/kubernetes-19-workloads-expanded-ecosystem/).

- Only the `kubectl` and `kustomize` deployers are supported at the moment: support for
the Helm deployer is not yet available.
- File sync is disabled for all artifacts.