From 1822b78139049ac3a25730f492745f07988fffe8 Mon Sep 17 00:00:00 2001 From: Brian de Alwis Date: Fri, 18 Oct 2019 10:33:00 -0400 Subject: [PATCH 1/3] clarify debug docs for deprecated Workload APIs --- docs/content/en/docs/workflows/debug.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/content/en/docs/workflows/debug.md b/docs/content/en/docs/workflows/debug.md index febe4e6e4aa..b61789a4322 100644 --- a/docs/content/en/docs/workflows/debug.md +++ b/docs/content/en/docs/workflows/debug.md @@ -47,7 +47,13 @@ are configured as _init-containers_ to populate a shared-volume that is mounted 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`. +`skaffold debug` does not support deprecated versions of Workload API objects in +`apps/v1beta1` ([deprecated in Kubernetes 1.8](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.8.md#other-notable-changes-16)) +and +`apps/v1beta2` ([deprecated in Kubernetes 1.9](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md#apps)). +These deprecated Workload APIs 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/). {{< /alert >}} ### Supported Language Runtimes From 59b2aa35e725a442ff9d221fbc88b2e8e410be9e Mon Sep 17 00:00:00 2001 From: Brian de Alwis Date: Fri, 18 Oct 2019 15:28:09 -0400 Subject: [PATCH 2/3] Avoid odd Hugo markdown rendering behaviour with shortcodes: - move _Deprecated Workload API_ into _Limitations_ section - render other shortcode to HTML --- .../en/docs/pipeline-stages/builders.md | 6 ++-- docs/content/en/docs/workflows/debug.md | 30 ++++++++++--------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/content/en/docs/pipeline-stages/builders.md b/docs/content/en/docs/pipeline-stages/builders.md index fdc9c393a2f..c4f7f8a86bd 100755 --- a/docs/content/en/docs/pipeline-stages/builders.md +++ b/docs/content/en/docs/pipeline-stages/builders.md @@ -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 +build or dockerBuild goal to the package phase. These bindings are no longer required with Jib 1.4.0 and should be removed. -{{% /alert %}} +{{< /alert >}} #### Gradle diff --git a/docs/content/en/docs/workflows/debug.md b/docs/content/en/docs/workflows/debug.md index b61789a4322..308f40d3ea1 100644 --- a/docs/content/en/docs/workflows/debug.md +++ b/docs/content/en/docs/workflows/debug.md @@ -46,15 +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 in -`apps/v1beta1` ([deprecated in Kubernetes 1.8](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.8.md#other-notable-changes-16)) -and -`apps/v1beta2` ([deprecated in Kubernetes 1.9](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md#apps)). -These deprecated Workload APIs 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/). -{{< /alert >}} ### Supported Language Runtimes @@ -114,9 +105,20 @@ 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) +and + * `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. - From 39b6f985b8ffcbfc0ff219690f9eec6014b4d32b Mon Sep 17 00:00:00 2001 From: Brian de Alwis Date: Fri, 18 Oct 2019 15:32:30 -0400 Subject: [PATCH 3/3] fix the markdown for realz --- docs/content/en/docs/workflows/debug.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/content/en/docs/workflows/debug.md b/docs/content/en/docs/workflows/debug.md index 308f40d3ea1..8ccc60d9a16 100644 --- a/docs/content/en/docs/workflows/debug.md +++ b/docs/content/en/docs/workflows/debug.md @@ -114,10 +114,11 @@ the Helm deployer is not yet available ([#2350](https://github.com/GoogleContain ### 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) -and - * `apps/v1beta2` was [deprecated in Kubernetes 1.9](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md#apps), +`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/).