Skip to content

Commit b5018aa

Browse files
foverbyGitHub Enterprise
authored and
GitHub Enterprise
committed
Merge pull request #500 from cloud-docs/next-publish-push
Next publish push
2 parents 33bf6a7 + b12169c commit b5018aa

9 files changed

+33
-19
lines changed

Diff for: cli-changelog.md

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

33
copyright:
44
years: 2020, 2024
5-
lastupdated: "2024-02-05"
5+
lastupdated: "2024-02-22"
66

77
keywords: cli change log for code engine, cli version for code engine, change log for cli in code engine, cli history for code engine, change log, cli version history
88

@@ -20,6 +20,7 @@ Find a summary of changes for each version of {{site.data.keyword.codeenginefull
2020

2121
| Version | Release date | Changes |
2222
| ----- | ------- | -------------- |
23+
| 1.49.5 | 2024-02-22 | - Updated the output for the **`app create`**, **`app update`**, **`job create`**, **`job update`**, and **`buildrun submit`** commands to provide more information about checking logs and events. \n - Fixed various bugs. |
2324
| 1.49.4 | 2024-02-05 | - Fixed various bugs. |
2425
| 1.49.3 | 2024-01-25 | - Fixed various bugs. |
2526
| 1.49.2 | 2024-01-12 | - Fixed various bugs. |

Diff for: dockerfiletips.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2023
5-
lastupdated: "2023-10-09"
4+
years: 2024
5+
lastupdated: "2024-02-22"
66

77
keywords: Dockerfile for code engine, build Dockerfile in code engine, container images in code engine, tools in Dockerfile, Dockerfile, image, container as non-root
88

@@ -32,7 +32,7 @@ While you can use either strategy for your build, you might choose Dockerfile, i
3232
## Dockerfile basics
3333
{: #dockerfile-basics}
3434

35-
A Dockerfile describes how a container is built. Within your Dockerfile, you choose a base image that includes the necessary tools that you need during your build and runtime. You can copy files from a build context into the image, run commands, define the runtime behavior such as environment variables, exposed ports, and set the `ENTRYPOINT`. The `ENTRYPOINT` is set by the command that is invoked when the container is started. For more information about how Dockerfile instructions can be specified, see [Dockerfile reference](https://docs.docker.com/engine/reference/builder/){: external}.
35+
A Dockerfile describes how a container is built. Within your Dockerfile, you choose a base image that includes the necessary tools that you need during your build and runtime. You can copy files from a build context into the image, run commands, define the runtime behavior such as environment variables, exposed ports, and set the `ENTRYPOINT`. The `ENTRYPOINT` is set by the command that is invoked when the container is started. For more information about how Dockerfile instructions can be specified, see [Dockerfile reference](https://docs.docker.com/reference/dockerfile/){: external}.
3636

3737
In a {{site.data.keyword.codeengineshort}} build, you define a source that points to a Git repository. The context that is available to the Docker build is, by default, the root directory of your Git repository. For example, if you have a directory that is named `src` in your repository, then you can use the `COPY` statement in the Dockerfile to copy this directory into your image. For example,
3838

@@ -48,7 +48,7 @@ COPY . /app/src
4848
```
4949
{: codeblock}
5050

51-
If you copy the entire Git repository, but want to exclude some files, for example the `README.md` of the repository, then you can add a [`.dockerignore` file](https://docs.docker.com/engine/reference/builder/#dockerignore-file){: external}. Use the same file to also ignore the files and directories that you specify in your [.gitignore file](https://git-scm.com/docs/gitignore){: external}. By using the same file, you ensure that a build that you run locally has the same set of files available as the build running in {{site.data.keyword.codeengineshort}}.
51+
If you copy the entire Git repository, but want to exclude some files, for example the `README.md` of the repository, then you can add a [`.dockerignore` file](https://docs.docker.com/reference/dockerfile/#dockerignore-file){: external}. Use the same file to also ignore the files and directories that you specify in your [.gitignore file](https://git-scm.com/docs/gitignore){: external}. By using the same file, you ensure that a build that you run locally has the same set of files available as the build running in {{site.data.keyword.codeengineshort}}.
5252
{: tip}
5353

5454
Always copy your application files into a subdirectory of the root (`/`) rather than into the root directly to avoid conflicts with operating system files. When you name your application directory, do not use one that is reserved by Unix-based operating systems, Kubernetes or {{site.data.keyword.codeengineshort}} builds, such as `/bin`, `/dev`, `/etc`, `/lib`, `/proc`, `/run`, `/sys`, `/usr`, `/var`, or `/workspace`. Naming your application directory `/app` is a best practice.

Diff for: envvar-autoinject.md

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

33
copyright:
44
years: 2020, 2024
5-
lastupdated: "2024-02-16"
5+
lastupdated: "2024-02-20"
66

77
keywords: applications in code engine, apps in code engine, http requests in code engine, deploy apps in code engine, app workloads in code engine, deploying workloads in code engine, application, app, memory, cpu, environment variables
88

@@ -23,7 +23,7 @@ When you deploy an application or run a job, {{site.data.keyword.codeengineshort
2323

2424
When you deploy an application, {{site.data.keyword.codeengineshort}} automatically injects certain environment variables into the app. The following table lists automatically injected environment variables into each instance of your deployed app. The following examples of automatically injected environment variables are based on an app that is named `myapp`, which references the {{site.data.keyword.codeengineshort}} sample image, `icr.io/codeengine/codeengine`.
2525

26-
The first 3 environment variables, `CE_APP`, `CE_DOMAIN`, and `CE_SUBDOMAIN` are used to construct the URL of an application, `https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN`. For example, if `CE_APP=myapp`, `CE_SUBDOMAIN=01234567-abcd` and `CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud`, your application external URL is `https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud`. The private URL of your application is `appName.CE_SUBDOMAIN`, or `myapp.01234567-abcd`.
26+
The environment variables, `CE_APP`, `CE_DOMAIN`, and `CE_SUBDOMAIN` are used to construct the URL of an application, `https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN`. For example, if `CE_APP=myapp`, `CE_SUBDOMAIN=01234567-abcd` and `CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud`, your application external URL is `https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud`. The private URL of your application is `appName.CE_SUBDOMAIN`, or `myapp.01234567-abcd`.
2727

2828
| Environment variable | Description | Example |
2929
|--------------------|-------------------------------------------------------|--------------|
@@ -45,7 +45,9 @@ Note that you can override the `PORT` variable by deploying your app from the co
4545
## Automatically injected environment variables for jobs
4646
{: #inside-env-vars-jobs}
4747

48-
When you run a job, {{site.data.keyword.codeengineshort}} automatically injects certain environment variables into the job run instance. The following table lists automatically injected environment variables into each instance of your running job. The following examples of automatically injected environment variables are based on a job that is named `myjob`, which references the {{site.data.keyword.codeengineshort}} sample image, `icr.io/codeengine/codeengine`.
48+
When you run a job, {{site.data.keyword.codeengineshort}} automatically injects certain environment variables into the job run instance.
49+
50+
The following table lists automatically injected environment variables into each instance of your running job. The following examples of automatically injected environment variables are based on a job that is named `myjob`, which references the {{site.data.keyword.codeengineshort}} sample image, `icr.io/codeengine/codeengine`.
4951

5052
| Environment variable | Description | Example |
5153
|----------------|---------------------|---------|

Diff for: landing.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"title": "Code Engine",
3-
"lastupdated": "2024-02-20",
3+
"lastupdated": "2024-02-22",
44
"introduction": "Find out how you can use Code Engine to run your containerized workloads",
55
"section_devtools": {
66
"api": "/apidocs/codeengine/v2",

Diff for: limits.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2023
5-
lastupdated: "2023-11-29"
4+
years: 2024
5+
lastupdated: "2024-02-22"
66

77
keywords: limits for code engine, limitations for code engine, quotas for code engine, project quotas in code engine, app limits in code engine, job limits in code engine, limits, limitations, quotas
88

@@ -64,7 +64,7 @@ The following table lists the limits for jobs.
6464
| Category | Default | Maximum value | Need to extend the maximum? |
6565
| ---------------------------- | ------------------------ | ------------------------ |------------------------------------------- |
6666
| Array indices | 0 | 9999999 | [Contact IBM support](/docs/get-support?topic=get-support-open-case&interface=ui) |
67-
| Array size | 1 | 1000 | [Contact IBM support](/docs/get-support?topic=get-support-open-case&interface=ui) |
67+
| Array size | 1 | 1000 | N/A |
6868
| CPU | 1.0 | 12.0 | [Contact IBM support](/docs/get-support?topic=get-support-open-case&interface=ui) |
6969
| Ephemeral storage | 400 M | 48 G \n (limited by memory) | [Contact IBM support](/docs/get-support?topic=get-support-open-case&interface=ui) |
7070
| Memory | 4 G | 48 G | [Contact IBM support](/docs/get-support?topic=get-support-open-case&interface=ui) |

Diff for: plan-build.md

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

33
copyright:
44
years: 2024
5-
lastupdated: "2024-02-19"
5+
lastupdated: "2024-02-22"
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

@@ -51,7 +51,7 @@ You can choose to ignore certain file patterns from within your source code by u
5151
### Dockerfile
5252
{: #build-dockerfile-strat}
5353

54-
[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).
54+
[Dockerfile](https://docs.docker.com/reference/dockerfile/){: 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).
5555

5656
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.
5757
{: tip}

Diff for: release-notes.md

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

33
copyright:
44
years: 2020, 2024
5-
lastupdated: "2024-02-20"
5+
lastupdated: "2024-02-22"
66

77
keywords: release notes for code engine, updates in code engine, what's new in code engine, document changes in code engine, updates, release notes
88

@@ -23,6 +23,13 @@ Use the release notes to learn about the latest changes to {{site.data.keyword.c
2323
## February 2024
2424
{: #codeengine-feb24}
2525

26+
### 22 February 2024
27+
{: #codeengine-feb2224}
28+
{: release-note}
29+
30+
CLI version 1.49.5 released
31+
: See [CLI version history](/docs/codeengine?topic=codeengine-cli_versions).
32+
2633
### 20 February 2024
2734
{: #codeengine-feb2024}
2835
{: release-note}

Diff for: sitemap.md

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

33
copyright:
44
years: 2024
5-
lastupdated: "2024-02-20"
5+
lastupdated: "2024-02-22"
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

@@ -138,6 +138,10 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
138138

139139
* [February 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-feb24)
140140

141+
* [22 February 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-feb2224)
142+
143+
* CLI version 1.49.5 released
144+
141145
* [20 February 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-feb2024)
142146

143147
* Updated versions for buildpacks

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2020, 2023
5-
lastupdated: "2023-07-11"
4+
years: 2020, 2024
5+
lastupdated: "2024-02-22"
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

@@ -235,7 +235,7 @@ If the build and push step failure problem isn't a problem with memory, a contai
235235
236236
If you successfully built your project locally, but the same source code does not build in {{site.data.keyword.codeengineshort}}, then you might have files available locally that are not in your Git repository. For example, for Node.js projects, it is common to run the `npm install` command locally so that project dependencies are downloaded and placed in the `node_modules` directory inside the project directory. It is a good practice to include the `node_modules` directory in the [.gitignore file](https://git-scm.com/docs/gitignore){: external} to keep your Git repository small. A common mistake is to forget to also run `npm install` (or `npm ci`) in the Dockerfile. A Docker build that you run locally can access the local `node_modules` directory, if you copy the whole project into the container, for example, by using the `COPY . /app` command in the Dockerfile. But, the {{site.data.keyword.codeengineshort}} build runs from a freshly checked-out Git repository and cannot access the `node_modules` directory. Therefore, you must run `npm install` (or `npm ci`) in the Dockerfile as part of the build.
237237
238-
A good practice is to include directories like `node_modules` also in a [.dockerignore file](https://docs.docker.com/engine/reference/builder/#dockerignore-file){: external} so that the Docker build that you run locally behaves the same as the Code Engine build.
238+
A good practice is to include directories like `node_modules` also in a [.dockerignore file](https://docs.docker.com/reference/dockerfile/#dockerignore-file){: external} so that the Docker build that you run locally behaves the same as the Code Engine build.
239239
{: tip}
240240
241241
Another reason for a project to be successfully built locally but to fail as {{site.data.keyword.codeengineshort}} build are security limitations. As with applications and batch jobs, {{site.data.keyword.codeengineshort}} does not allow arbitrary system operations within the {{site.data.keyword.codeengineshort}} cluster. Most of those system operations are not relevant for Docker builds anyway. However, {{site.data.keyword.codeengineshort}} does not allow opening server sockets for privileged ports. The range is `0 to 1023`. For example, if you build a web application and your build includes a test step that brings up a web application server, then you must use ports with higher numbers for this server.

0 commit comments

Comments
 (0)