Skip to content

Commit bd3c1c2

Browse files
authored
Merge pull request #3164 from tejal29/update_feature_matrix
[docs] docs changes for feature matrix
2 parents 6ea9103 + b1aad86 commit bd3c1c2

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

docs/content/en/docs/pipeline-stages/builders.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ instead, which enables artifacts with [BuildKit](https://github.com/moby/buildki
4141
After the artifacts are successfully built, Docker images will be pushed
4242
to the remote registry. You can choose to skip this step.
4343

44-
### Configuration
44+
**Configuration**
4545

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

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

51-
### Example
51+
**Example**
5252

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

81-
### Configuration
81+
**Configuration**
8282

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

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

88-
### Example
88+
**Example**
8989

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

105-
### Configuration
105+
**Configuration**
106106

107107
To use Kaniko, add build type `kaniko` to the `build` section of
108108
`skaffold.yaml`. The following options can optionally be configured:
@@ -139,7 +139,7 @@ build:
139139
```
140140
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"`.
141141

142-
### Example
142+
**Example**
143143

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

160160
Skaffold requires using Jib v1.4.0 or later.
161161

162-
### Configuration
162+
**Configuration**
163163

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

185-
### Example
185+
**Example**
186186

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

234-
### Configuration
234+
**Configuration**
235235

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

249249

250-
### Example
250+
**Example**
251251

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

299-
### Configuration
299+
**Configuration**
300300

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

373373

374-
### Example
374+
**Example**
375375

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

docs/content/en/docs/references/deprecation/_index.md

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

9091
|area|feature|state|description|
9192
|----|----|----|----|
93+
Build | buildpacks native support|alpha| Skaffold natively support for buildpacks artifact and buildpacks builder
9294
Debug|debug python apps|alpha|debug python apps
9395
Debug|debug node apps|alpha|debug node apps
9496
Debug|debug java apps|alpha|debug java apps
97+
Debug|debug go apps|alpha|debug go apps
9598
Default-repo|preconcatentation strategy|beta|collision free rewriting strategy
9699
Tagpolicy|latest tagger|alpha|tag with latest, use image digest / image ID for deployment
97100
Tagpolicy|contentDigest tagger|alpha|reintroduce DIGEST and content based digest tag

0 commit comments

Comments
 (0)