Skip to content

Commit

Permalink
Merge pull request #3164 from tejal29/update_feature_matrix
Browse files Browse the repository at this point in the history
[docs] docs changes for feature matrix
  • Loading branch information
tejal29 authored Nov 4, 2019
2 parents 6ea9103 + b1aad86 commit bd3c1c2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
24 changes: 12 additions & 12 deletions docs/content/en/docs/pipeline-stages/builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ instead, which enables artifacts with [BuildKit](https://github.com/moby/buildki
After the artifacts are successfully built, Docker images will be pushed
to the remote registry. You can choose to skip this step.

### Configuration
**Configuration**

To use the local Docker daemon, add build type `local` to the `build` section
of `skaffold.yaml`. The following options can optionally be configured:

{{< schema root="LocalBuild" >}}

### Example
**Example**

The following `build` section instructs Skaffold to build a
Docker image `gcr.io/k8s-skaffold/example` with the local Docker daemon:
Expand Down Expand Up @@ -78,14 +78,14 @@ and will start the building process. Skaffold does not honor `.gitignore` or `.g
exclusions. If you need to ignore files use `.dockerignore`. Any `cloudbuild.yaml` found will not
be used in the build process.

### Configuration
**Configuration**

To use Cloud Build, add build type `googleCloudBuild` to the `build`
section of `skaffold.yaml`. The following options can optionally be configured:

{{< schema root="GoogleCloudBuild" >}}

### Example
**Example**

The following `build` section, instructs Skaffold to build a
Docker image `gcr.io/k8s-skaffold/example` with Google Cloud Build:
Expand All @@ -102,7 +102,7 @@ that cannot easily or securely run a Docker daemon.
Skaffold can help build artifacts in a Kubernetes cluster using the Kaniko
image; after the artifacts are built, kaniko must push them to a registry.

### Configuration
**Configuration**

To use Kaniko, add build type `kaniko` to the `build` section of
`skaffold.yaml`. The following options can optionally be configured:
Expand Down Expand Up @@ -139,7 +139,7 @@ build:
```
Note that the Kubernetes secret must not be of type `kubernetes.io/dockerconfigjson` which stores the config json under the key `".dockerconfigjson"`, but an opaque secret with the key `"config.json"`.

### Example
**Example**

The following `build` section, instructs Skaffold to build a
Docker image `gcr.io/k8s-skaffold/example` with Kaniko:
Expand All @@ -159,7 +159,7 @@ pushes them to the local Docker daemon or to remote registries as instructed by

Skaffold requires using Jib v1.4.0 or later.

### Configuration
**Configuration**

To use Jib, add a `jib` field to each artifact you specify in the
`artifacts` part of the `build` section. `context` should be a path to
Expand All @@ -182,7 +182,7 @@ based on the presence of standard build files in the `artifact`'s
or the Gradle wrapper script (`gradlew`, `gradlew.bat`, or
`gradlew.cmd`).

### Example
**Example**

See the [Skaffold-Jib demo project](https://github.com/GoogleContainerTools/skaffold/blob/master/examples/jib/)
for an example.
Expand Down Expand Up @@ -231,7 +231,7 @@ extensible build system.
Skaffold can help build artifacts using Bazel; after Bazel finishes building
container images, they will be loaded into the local Docker daemon.

### Configuration
**Configuration**

To use Bazel, `bazel` field to each artifact you specify in the
`artifacts` part of the `build` section, and use the build type `local`.
Expand All @@ -247,7 +247,7 @@ with docker load. See
{{% /alert %}}


### Example
**Example**

The following `build` section instructs Skaffold to build a
Docker image `gcr.io/k8s-skaffold/example` with Bazel:
Expand Down Expand Up @@ -296,7 +296,7 @@ Skaffold will pass in the following additional environment variables for the fol
| $DOCKER_CONFIG_SECRET_NAME | The secret containing any required docker authentication for custom builds on cluster.| None. |
| $TIMEOUT | The amount of time an on cluster build is allowed to run.| None. |

### Configuration
**Configuration**

To use a custom build script, add a `custom` field to each corresponding artifact in the `build` section of the skaffold.yaml.
Currently, this only works with the `local` and `cluster` build types. Supported schema for `custom` includes:
Expand Down Expand Up @@ -371,7 +371,7 @@ Syncable files must be included in both the `paths` section of `dependencies`, s
`STDOUT` and `STDERR` from the custom build script will be redirected and displayed within skaffold logs.


### Example
**Example**

The following `build` section instructs Skaffold to build an image `gcr.io/k8s-skaffold/example` with a custom build script `build.sh`:

Expand Down
5 changes: 4 additions & 1 deletion docs/content/en/docs/references/deprecation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ Control API |alpha|Applications can control sync, build and deployment during in
[Default-repo]({{< relref "/docs/environment/image-registries.md" >}})|alpha|specify a default image repository & rewrite image names to default repo
Delete|beta |delete everything deployed by skaffold run from the cluster
[Deploy] ({{< relref "docs/pipeline-stages/deployers" >}})|beta |Deploy a set of deployables as your applications and replace the image name with the built images
Render |alpha| Skaffold render outputs rendered kubernetes manifests|
[Dev]({{< relref "/docs/workflows/dev.md" >}})|beta |Continuous development
Event API v1|alpha|Publish events and state of the application on gRPC and HTTP
[Event API v1]({{<relref "docs/design/api#events-api" >}})|alpha|Publish events and state of the application on gRPC and HTTP
[Filesync]({{< relref "/docs/pipeline-stages/filesync" >}})|alpha|Instead of rebuilding, copy the changed files in the running container
[Global config]({{< relref "/docs/design/config" >}})|alpha|store user preferences in a separate preferences file
Init|alpha|Initialize a skaffold.yaml file based on the contents of the current directory
Expand All @@ -89,9 +90,11 @@ Within a feature area we do have certain features that are expected to change:

|area|feature|state|description|
|----|----|----|----|
Build | buildpacks native support|alpha| Skaffold natively support for buildpacks artifact and buildpacks builder
Debug|debug python apps|alpha|debug python apps
Debug|debug node apps|alpha|debug node apps
Debug|debug java apps|alpha|debug java apps
Debug|debug go apps|alpha|debug go apps
Default-repo|preconcatentation strategy|beta|collision free rewriting strategy
Tagpolicy|latest tagger|alpha|tag with latest, use image digest / image ID for deployment
Tagpolicy|contentDigest tagger|alpha|reintroduce DIGEST and content based digest tag
Expand Down

0 comments on commit bd3c1c2

Please sign in to comment.