Skip to content

Commit edcac75

Browse files
committed
Frances Overby: Merge pull request #1440 from SCHWARZS/sascha-buildkit
1 parent 8e68c23 commit edcac75

6 files changed

+22
-22
lines changed

Diff for: build-tutorial-buildpacks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2021
5-
lastupdated: "2021-09-01"
5+
lastupdated: "2021-09-16"
66

77
keywords: code engine, tutorial, build, source, application, buildpack, access, build run, image
88

@@ -272,7 +272,7 @@ Creating application 'tutorial-app'...
272272

273273
For more information, see [Deploying applications](/docs/codeengine?topic=codeengine-application-workloads).
274274

275-
Does your source code project use Dockerfile? Follow the same steps, but specify the `Kaniko` build strategy to build an image for your application or job. For more information about Dockerfile, see [Writing a Dockerfile for {{site.data.keyword.codeengineshort}}](/docs/codeengine?topic=codeengine-dockerfile).
275+
Does your source code project use Dockerfile? Follow the same steps, but specify the `Dockerfile` build strategy to build an image for your application or job. For more information about Dockerfile, see [Writing a Dockerfile for {{site.data.keyword.codeengineshort}}](/docs/codeengine?topic=codeengine-dockerfile).
276276
{: tip}
277277

278278
Looking for more code examples? Check out the [Samples for {{site.data.keyword.codeenginefull_notm}} GitHub repo](https://github.com/IBM/CodeEngine){: external}.

Diff for: plan-build.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2021
5-
lastupdated: "2021-09-08"
5+
lastupdated: "2021-09-16"
66

77
keywords: build for code engine, planning for code engine, source code building for code engine, source code repositories and code engine, image builds for code engine, container image builds for code engine, build strategy for code engine, build size for code engine, build, build run, source repository, image registry
88

@@ -130,7 +130,7 @@ To give {{site.data.keyword.codeengineshort}} access to your source code, you ne
130130
### Dockerfile
131131
{: #build-dockerfile-strat}
132132

133-
[Dockerfile](https://docs.docker.com/engine/reference/builder/){: external} build that uses the [Kaniko](https://github.com/GoogleContainerTools/kaniko){: external} tool. To use this strategy, add a Dockerfile to your source repository. This Dockerfile describes the steps that are needed to build a container image from your source repository. The Dockerfile might contain steps that copy static files from your sources into the container to be hosted by a web service, for example. It might compile source code that is written in the language of your choice and add the resulting binary to your container image. For more information about Dockerfile builds, see [Writing a Dockerfile for {{site.data.keyword.codeengineshort}}](/docs/codeengine?topic=codeengine-dockerfile).
133+
[Dockerfile](https://docs.docker.com/engine/reference/builder/){: external} build that uses the [BuildKit](https://github.com/moby/buildkit){: external} tool. To use this strategy, add a Dockerfile to your source repository. This Dockerfile describes the steps that are needed to build a container image from your source repository. The Dockerfile might contain steps that copy static files from your sources into the container to be hosted by a web service, for example. It might compile source code that is written in the language of your choice and add the resulting binary to your container image. For more information about Dockerfile builds, see [Writing a Dockerfile for {{site.data.keyword.codeengineshort}}](/docs/codeengine?topic=codeengine-dockerfile).
134134

135135
When you pull an image from Docker Hub to use with apps or jobs in Code Engine, be aware of [Docker rate limits](https://docs.docker.com/docker-hub/download-rate-limit){: external} for free plan (anonymous) users. You might experience pull limits if you receive a `429` error that indicates you reached your pull rate limit. To [increase rate limits](https://www.docker.com/increase-rate-limits){: external}, you can upgrade your account to a Docker `Pro` or `Team` subscription.
136136
{: tip}
@@ -157,10 +157,10 @@ When you pull an image from Docker Hub to use with apps or jobs in Code Engine,
157157

158158
| Size | Dockerfile | Buildpacks |
159159
| --------- | -------- | -------- |
160-
| `small` | <ul><li><strong>CPU</strong> 0.5</li><li><strong>Memory</strong> 2 GB</li></ul> | <ul><li><strong>CPU</strong> 0.5</li><li><strong>Memory</strong> 2 GB</li></ul> |
161-
| `medium` | <ul><li><strong>CPU</strong> 1</li><li><strong>Memory</strong> 4 GB</li></ul> | <ul><li><strong>CPU</strong> 1</li><li><strong>Memory</strong> 4 GB</li></ul> |
162-
| `large` | <ul><li><strong>CPU</strong> 2</li><li><strong>Memory</strong> 8 GB</li></ul> | <ul><li><strong>CPU</strong> 2</li><li><strong>Memory</strong> 8 GB</li></ul> |
163-
| `xlarge` | <ul><li><strong>CPU</strong> 4</li><li><strong>Memory</strong> 16 GB</li></ul> | <ul><li><strong>CPU</strong> 4</li><li><strong>Memory</strong> 16 GB</li></ul> |
160+
| `small` | <ul><li><strong>CPU</strong> 0.5</li><li><strong>Memory</strong> 2 GB</li><li><strong>Disk</strong> 2 GB</li></ul> | <ul><li><strong>CPU</strong> 0.5</li><li><strong>Memory</strong> 2 GB</li><li><strong>Disk</strong> 2 GB</li></ul> |
161+
| `medium` | <ul><li><strong>CPU</strong> 1</li><li><strong>Memory</strong> 4 GB</li><li><strong>Disk</strong> 4 GB</li></ul> | <ul><li><strong>CPU</strong> 1</li><li><strong>Memory</strong> 4 GB</li><li><strong>Disk</strong> 4 GB</li></ul> |
162+
| `large` | <ul><li><strong>CPU</strong> 2</li><li><strong>Memory</strong> 8 GB</li><li><strong>Disk</strong> 8 GB</li></ul> | <ul><li><strong>CPU</strong> 2</li><li><strong>Memory</strong> 8 GB</li><li><strong>Disk</strong> 8 GB</li></ul> |
163+
| `xlarge` | <ul><li><strong>CPU</strong> 4</li><li><strong>Memory</strong> 16 GB</li><li><strong>Disk</strong> 16 GB</li></ul> | <ul><li><strong>CPU</strong> 4</li><li><strong>Memory</strong> 16 GB</li><li><strong>Disk</strong> 16 GB</li></ul> |
164164
{: caption="Build size values." caption-side="top"}
165165

166166
If you are uncertain about which size to choose, consider starting with `small` or `medium`. If the build fails due to lack of memory or disk space, or is not fast enough, then switch to larger sizes.

Diff for: responsibilities.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2021
5-
lastupdated: "2021-09-14"
5+
lastupdated: "2021-09-16"
66

77
subcollection: codeengine
88

@@ -179,8 +179,8 @@ IBM is responsible for the security and compliance of {{site.data.keyword.codeen
179179

180180
| Task | IBM responsibilities | Your responsibilities |
181181
| ------ | ----------------------- | ---------------------- |
182-
| General | <ul><li>Maintain controls commensurate to various industry compliance standards.</li><li>Monitor, isolate, and recover user projects.</li><li>Provide highly available replicas of your projects and entities.</li><li>Monitor and report the health of the project and entities in the various interfaces.</li><li>Automatically apply security patch updates for infrastructure.</li><li>Enable certain security settings, such as encrypted disks.</li><li>Disable certain insecure actions, such as not permitting users to SSH into the host.</li><li>Encrypt communication with TLS.</li><li>Continuously monitor {{site.data.keyword.codeengineshort}} projects and entities to detect vulnerability and security compliance issues.</li><li>Provide options for network connectivity.<li>Integrate {{site.data.keyword.codeengineshort}} with {{site.data.keyword.cloud_notm}} Identity and Access Management (IAM).</li></li></ul> | <ul><li>Set up and maintain security and regulation compliance for your {{site.data.keyword.codeengineshort}} entities and data.</li><li>As part of your incident and operations management responsibilities for {{site.data.keyword.codeengineshort}} entities and data, apply any security updates.</li><li> Do not include sensitive or private information in {{site.data.keyword.codeengineshort}} resource metadata, including configuration values.</li> </ul> |
183-
| Building from source | <ul><li>Continuously update the build tools, including Kaniko, and Paketo buildpacks to the latest version.</li></ul> | <ul><li>Resubmit builds to pick up fixes in the base image of your Dockerfile-based builds and to pick up operating system and runtime environment fixes in your Buildpacks-based builds.</li></ul> |
182+
| General | <ul><li>Maintain controls commensurate to various industry compliance standards.</li><li>Monitor, isolate, and recover user projects.</li><li>Provide highly available replicas of your projects and entities.</li><li>Monitor and report the health of the project and entities in the various interfaces.</li><li>Automatically apply security patch updates for infrastructure.</li><li>Enable certain security settings, such as encrypted disks.</li><li>Disable certain insecure actions, such as not permitting users to SSH into the host.</li><li>Encrypt communication with TLS.</li><li>Continuously monitor {{site.data.keyword.codeengineshort}} projects and entities to detect vulnerability and security compliance issues.</li><li>Provide options for network connectivity.<li>Integrate {{site.data.keyword.codeengineshort}} with {{site.data.keyword.cloud_notm}} Identity and Access Management (IAM).</li></li></ul> | <ul><li>Set up and maintain security and regulation compliance for your {{site.data.keyword.codeengineshort}} entities and data.</li><li>As part of your incident and operations management responsibilities for {{site.data.keyword.codeengineshort}} entities and data, apply any security updates.</li></ul> |
183+
| Building from source | <ul><li>Continuously update the build tools, including BuildKit, and Paketo buildpacks to the latest version.</li></ul> | <ul><li>Resubmit builds to pick up fixes in the base image of your Dockerfile-based builds and to pick up operating system and runtime environment fixes in your Buildpacks-based builds.</li></ul> |
184184
{: summary="The rows are read from left to right. The resource area of comparing responsibilities is in the first column, with the responsibilities of IBM in the second column and your responsibilities in the third column."}
185185
{: caption="Table 5. Responsibilities for security and regulation compliance" caption-side="top"}
186186

Diff for: sitemap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2021
5-
lastupdated: "2021-09-15"
5+
lastupdated: "2021-09-16"
66

77
keywords: sitemap, code engine, about, tutorial, project, app, job, configmaps, secret, event, log, monitor, cli, api, troubleshoot, support, source code, faq, memory, cpu, commands, arguments, release notes
88

Diff for: troubleshoot-build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-09-02"
5+
lastupdated: "2021-09-16"
66

77
keywords: troubleshooting for code engine, troubleshooting builds in code engine, tips for builds in code engine, resolution of builds in code engine, builds
88

@@ -274,7 +274,7 @@ System event information can be helpful to troubleshoot problems when you run bu
274274
Normal Pulled 4m40s kubelet, 10.242.0.17 Container image "icr.io/obs/codeengine/git:v0.8.100" already present on machine
275275
Normal Created 4m40s kubelet, 10.242.0.17 Created container step-source-default
276276
Normal Started 4m40s kubelet, 10.242.0.17 Started container step-source-default
277-
Normal Pulled 4m40s kubelet, 10.242.0.17 Container image "icr.io/obs/codeengine/kaniko/executor:v1.6.0-rc1" already present on machine
277+
Normal Pulled 4m40s kubelet, 10.242.0.17 Container image "icr.io/obs/codeengine/buildkit/builder:v0.9.0-rc.19" already present on machine
278278
Normal Created 4m40s kubelet, 10.242.0.17 Created container step-build-and-push
279279
Normal Started 4m40s kubelet, 10.242.0.17 Started container step-build-and-push
280280
```

Diff for: ts-build-fail-buildpushstepfails.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-09-01"
5+
lastupdated: "2021-09-16"
66

77
keywords: troubleshooting for code engine, troubleshooting builds in code engine, tips for builds in code engine, resolution of builds in code engine, builds
88

@@ -119,15 +119,15 @@ After you create and run a build, your build does not complete successfully and
119119
The build and push step is the main step of a {{site.data.keyword.codeengineshort}} build.
120120
{: tsCauses}
121121

122-
- If you chose the Dockerfile build strategy, then Kaniko analyses the Dockerfile, performs the steps that are described there to create a container image, and pushes it.
122+
- If you chose the Dockerfile build strategy, then BuildKit analyses the Dockerfile, performs the steps that are described there to create a container image, and pushes it.
123123

124124
- If you chose the Buildpacks build strategy, then check the files in the source directory to determine which kind of build is requested. For example, if the source directory contains a `pom.xml`, Buildpacks assumes a Maven type and runs a `mvn -Dmaven.test.skip=true` package build. If it finds a `package.json` file, it assumes that the build is for a Node.js application and runs `npm install`. The result is packaged into an image along with the required runtime environment and pushed to the container registry.
125125

126126
**Example error message**
127127

128128
```
129129
Summary: Failed to execute build run
130-
Reason: "step-build-and-push" exited with code 1 (image: "icr.io/obs/codeengine/kaniko/executor@sha256:d60705cb55460f32cee586570d7b14a0e8a5f23030a0532230aaf707ad05cecd"); for logs run: kubectl -n <PROJECT_NAMESPACE> logs <BUILDRUN_NAME>-865rg-pod-m5lrs -c step-build-and-push
130+
Reason: "step-build-and-push" exited with code 1 (image: "icr.io/obs/codeengine/buildkit/builder:v0.9.0-rc.19@sha256:a11e2348f9ee40822fc28dcb501c57cd02ebd31fb441841bfe5c144cc9d77fc6"); for logs run: kubectl -n <PROJECT_NAMESPACE> logs <BUILDRUN_NAME>-865rg-pod-m5lrs -c step-build-and-push
131131
```
132132
{: screen}
133133
@@ -142,12 +142,12 @@ The following table describes error text and potential root causes for this scen
142142
143143
| Error message contains | Strategy | Potential root causes |
144144
| ------------ | ------- | ------------------ |
145-
| `Killed` | Dockerfile (Kaniko), Buildpacks | <ul><li>The memory limit is reached. </li></ul>|
146-
| `error checking pushed permissions`<br /><br /><br />`ERROR: failed to export: failed to write image to the following tags: [...] UNAUTHORIZED`<br /><br />`ERROR: failed to export: failed to write image to the following tags: [...] unsupported status code 401` | Dockerfile (Kaniko)<br /><br />Buildpacks<br /><br /><br /><br />Buildpacks | <ul><li>The container registry secret is not defined.</li><li>The container registry secret is not of the correct type.</li><li>The container registry secret is not for the correct container registry.</li><li>The container registry secret does not allow pushing to the container registry.</li></ul> |
147-
| `Error: error resolving dockerfile path: please provide a valid path to a Dockerfile within the build context` | Dockerfile (Kaniko) | <ul><li>The Dockerfile is not in the root directory of the source repository.</li><li>The source repository does not contain a Dockerfile at all.</li></ul> |
148-
| `DENIED: You have exceeded your storage quota. Delete one or more images, or review your storage quota and pricing plan. For more information, see https://ibm.biz/BdjFwL` | Dockerfile (Kaniko), Buildpacks | <ul><li>{{site.data.keyword.registryfull}} is used and a quota limit is reached.</li></ul> |
145+
| `Killed` | Dockerfile, Buildpacks | <ul><li>The memory limit is reached. </li></ul>|
146+
| `error checking pushed permissions`<br /><br /><br />`ERROR: failed to export: failed to write image to the following tags: [...] UNAUTHORIZED`<br /><br />`ERROR: failed to export: failed to write image to the following tags: [...] unsupported status code 401` | Dockerfile<br /><br />Buildpacks<br /><br /><br /><br />Buildpacks | <ul><li>The container registry secret is not defined.</li><li>The container registry secret is not of the correct type.</li><li>The container registry secret is not for the correct container registry.</li><li>The container registry secret does not allow pushing to the container registry.</li></ul> |
147+
| `error: failed to solve: failed to read dockerfile: open /tmp/buildkit-mount306846082/Dockerfile: no such file or directory` | Dockerfile | <ul><li>The Dockerfile is not in the root directory of the source repository.</li><li>The source repository does not contain a Dockerfile at all.</li></ul> |
148+
| `DENIED: You have exceeded your storage quota. Delete one or more images, or review your storage quota and pricing plan. For more information, see https://ibm.biz/BdjFwL` | Dockerfile, Buildpacks | <ul><li>{{site.data.keyword.registryfull}} is used and a quota limit is reached.</li></ul> |
149149
| `ERROR: No buildpack groups passed detection.` | Buildpacks | <ul><li>The source of the build was not specified correctly. The typical reason for this error is that the sources are not in the root directory of the Git repository, but rather in a child directory.</li><li>Buildpacks is not supported to build the sources.</li></ul>
150-
| Any other error message | Dockerfile (Kaniko), Buildpacks | <ul><li>There's a problem with the Docker build. </li><li>There's a problem with the source code</li></ul> |
150+
| Any other error message | Dockerfile, Buildpacks | <ul><li>There's a problem with the Docker build. </li><li>There's a problem with the source code</li></ul> |
151151
{: caption="Error text and root cases for build and push steps"}
152152
153153
<br />

0 commit comments

Comments
 (0)