Skip to content

Commit 39542e7

Browse files
Kersten RichterGitHub Enterprise
authored andcommitted
Merge pull request #176 from cloud-docs/next-prod-push
Next publish push
2 parents c93c59d + a95dd34 commit 39542e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+388
-609
lines changed

about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-12-15"
5+
lastupdated: "2021-12-21"
66

77
keywords: benefits, terminology, developers, capabilities, code engine
88

app-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-12-15"
5+
lastupdated: "2021-12-21"
66

77
keywords: app tutorial for code engine, application, apps, images, tutorial for code engine, deploying
88

@@ -15,7 +15,7 @@ completion-time: 10m
1515

1616
{{site.data.keyword.attribute-definition-list}}
1717

18-
# Deploying applications
18+
# Deploying and scaling applications
1919
{: #deploy-app-tutorial}
2020
{: toc-content-type="tutorial"}
2121
{: toc-completion-time="10m"}

appdeploy-plan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-11-16"
5+
lastupdated: "2021-12-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

@@ -18,7 +18,7 @@ subcollection: codeengine
1818
An application, or app, runs your code to serve HTTP requests. In addition to traditional HTTP requests, {{site.data.keyword.codeenginefull}} also supports applications that use WebSockets as their communications protocol. The number of running instances of an app are automatically scaled up or down (to zero) based on incoming workloads and your configuration settings. An app contains one or more revisions. A revision represents an immutable version of the configuration properties of the app. Each update of an app configuration property creates a new revision of the app.
1919
{: shortdesc}
2020

21-
**Before you begin**
21+
Before you begin
2222

2323
* If you want to use the {{site.data.keyword.codeengineshort}} console, go to [{{site.data.keyword.codeengineshort}} overview](https://cloud.ibm.com/codeengine/overview){: external}.
2424
* If you want to use the CLI, [set up your {{site.data.keyword.codeengineshort}} CLI environment](/docs/codeengine?topic=codeengine-install-cli).
@@ -29,7 +29,7 @@ An application, or app, runs your code to serve HTTP requests. In addition to tr
2929
## Plan a container image for {{site.data.keyword.codeengineshort}} applications
3030
{: #deploy-app-containerimage}
3131

32-
To deploy applications in {{site.data.keyword.codeengineshort}}, you need to first create a container image that has all of the runtime artifacts your application needs to run, such as runtime libraries. You can use many different methods to create the image, including building your app from source code by using the [build container images](/docs/codeengine?topic=codeengine-build-image) feature available in {{site.data.keyword.codeengineshort}}. Your image can be downloaded from either a public or private image registry. For more information, see [Accessing container registries](/docs/codeengine?topic=codeengine-add-registry).
32+
To deploy applications in {{site.data.keyword.codeengineshort}}, you need to first create a container image that includes the runtime artifacts that your application needs to run, such as runtime libraries. You can use many different methods to create the image, including building your app from source code by using the [build container images](/docs/codeengine?topic=codeengine-build-image) feature available in {{site.data.keyword.codeengineshort}}. Your image can be downloaded from either a public or private image registry. For more information, see [Accessing container registries](/docs/codeengine?topic=codeengine-add-registry).
3333

3434
When you deploy your application, the most current version of your referenced container image is downloaded and deployed.
3535

appdeploy-public.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-11-15"
5+
lastupdated: "2021-12-15"
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

@@ -71,31 +71,9 @@ https://myapp.4idmmq6xpss.us-south.codeengine.appdomain.cloud
7171

7272
The following table summarizes the options that are used with the **`app create`** command in this example. For more information about the command and its options, see the [**`ibmcloud ce app create`**](/docs/codeengine?topic=codeengine-cli#cli-application-create) command.
7373

74-
<table>
75-
<caption><code>application create</code> command components</caption>
76-
<thead>
77-
<col width="25%">
78-
<col width="75%">
79-
<th colspan=2><img src="images/idea.png" alt="Idea icon"/> Understanding this command's components</th>
80-
</thead>
81-
<tbody>
82-
<tr>
83-
<td><code>--name</code></td>
84-
<td>The name of the application. Use a name that is unique within the project. This value is required.
85-
<ul>
86-
<li>The name must begin with a lowercase letter.</li>
87-
<li>The name must end with a lowercase alphanumeric character.</li>
88-
<li>The name must be 55 characters or fewer and can contain letters, numbers, and hyphens (-).</li>
89-
</ul>
90-
</td>
91-
</tr>
92-
<tr>
93-
<td><code>--image</code></td>
94-
<td>The name of the image that is used for this application. This value is required. The format is <code>REGISTRY/NAMESPACE/REPOSITORY:TAG</code> where <code>REGISTRY</code> and <code>TAG</code> are optional. If <code>TAG</code> is not specified, the default is <code>latest</code>. For images in <a href="https://hub.docker.com/">Docker Hub</a>, you can specify the image with <code>NAMESPACE/REPOSITORY</code>, as the default for <code>Registry</code> is <code>docker.io</code>. For other registries, use <code>REGISTRY/NAMESPACE/REPOSITORY</code> or <code>REGISTRY/NAMESPACE/REPOSITORY:TAG</code>.
95-
</td>
96-
</tr>
97-
</tbody>
98-
</table>
99-
100-
101-
74+
| Option | Description |
75+
| -------------- | -------------- |
76+
| `--name` | The name of the application. Use a name that is unique within the project. This value is required. \n - The name must begin with a lowercase letter. \n - The name must end with a lowercase alphanumeric character. \n - The name must be 55 characters or fewer and can contain letters, numbers, and hyphens (-). |
77+
| `--image` | The name of the image that is used for this application. This value is required. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `TAG` is not specified, the default is `latest`. For images in [Docker Hub](https://hub.docker.com/){: external}, you can specify the image with `NAMESPACE/REPOSITORY`, as the default for `Registry` is `docker.io`. For other registries, use `REGISTRY/NAMESPACE/REPOSITORY` or `REGISTRY/NAMESPACE/REPOSITORY:TAG`. |
78+
{: caption="Table 1. Command description" caption-side="bottom"}
79+

appdeploy-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ To update your app with the CLI, use the **`app update`** command. This command
8686

8787
Update the application that you created in [Deploying an application with the CLI](/docs/codeengine?topic=codeengine-deploy-app#deploy-app-cli) to add an environment variable.
8888

89-
The sample `docker.io/ibmcom/hello ` image reads the environment variable `TARGET`, and prints `Hello ${TARGET}`. If this environment variable is empty, `Hello World` is returned. The following example updates the app to modify the value of the `TARGET` environment variable to `Stranger`.
89+
The sample `docker.io/ibmcom/hello` image reads the environment variable `TARGET`, and prints `Hello ${TARGET}`. If this environment variable is empty, `Hello World` is returned. The following example updates the app to modify the value of the `TARGET` environment variable to `Stranger`.
9090

9191
1. Run the **`application update`** command. For example,
9292

at-events.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
copyright:
33
years: 2020, 2021
4-
lastupdated: "2021-10-06"
4+
lastupdated: "2021-12-15"
55

66
keywords: events, serverless, code engine, activity tracker, analyzing events
77

@@ -237,24 +237,18 @@ Note:
237237
After you view events that are captured by {{site.data.keyword.at_full_notm}}, you can then analyze the events.
238238
{: shortdesc}
239239

240-
**Identifying the {{site.data.keyword.codeengineshort}} project that generates the event**.
240+
Identifying the {{site.data.keyword.codeengineshort}} project that generates the event
241+
: To identify the project for which the event was generated, look at the `target.id` field. You can use this field to filter events in {{site.data.keyword.loganalysisshort_notm}}, for example, showing events for only a specific project.
242+
: You can use the CLI to find details about your [project](/docs/codeengine?topic=codeengine-manage-project).
241243

242-
To identify the project for which the event was generated, look at the `target.id` field. You can use this field to filter events in {{site.data.keyword.loganalysisshort_notm}}, for example, showing events for only a specific project.
244+
Getting the unique ID of a request
245+
: Each action that you perform on a {{site.data.keyword.codeengineshort}} project resource has a unique ID.
246+
: To find the unique ID of a request, look at the `correlationId` value that is set in the `correlationId` field.
243247

244-
You can use the CLI to find details about your [project](/docs/codeengine?topic=codeengine-manage-project).
248+
Getting information for failures
249+
: All events that are issued for failed actions display `failure` in the `outcome` field, and in addition provide more details as part of the `reason` field. Note that the `reason.reasonForFailure` field might be especially helpful, as it contains details of the failure.
245250

246-
**Getting the unique ID of a request**
247-
248-
Each action that you perform on a {{site.data.keyword.codeengineshort}} project resource has a unique ID.
249-
250-
To find the unique ID of a request, look at the `correlationId` value that is set in the `correlationId` field.
251-
252-
**Getting information for failures**
253-
254-
All events that are issued for failed actions display `failure` in the `outcome` field, and in addition provide more details as part of the `reason` field. Note that the `reason.reasonForFailure` field might be especially helpful, as it contains details of the failure.
255-
256-
**Custom views**
257-
258-
For more information about generating custom views by using event fields, see [Creating custom views in {{site.data.keyword.loganalysislong_notm}}](/docs/activity-tracker?topic=activity-tracker-views).
251+
Custom views
252+
: For more information about generating custom views by using event fields, see [Creating custom views in {{site.data.keyword.loganalysislong_notm}}](/docs/activity-tracker?topic=activity-tracker-views).
259253

260254

batch-tutorial.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2020, 2021
5-
lastupdated: "2021-11-17"
5+
lastupdated: "2021-12-21"
66

77
keywords: job tutorial, jobs, images for code engine jobs, tutorial for code engine, job log
88

@@ -15,7 +15,7 @@ completion-time: 10m
1515

1616
{{site.data.keyword.attribute-definition-list}}
1717

18-
# Running jobs
18+
# Running and updating jobs
1919
{: #run-job-tutorial}
2020
{: toc-content-type="tutorial"}
2121
{: toc-completion-time="10m"}
@@ -25,7 +25,7 @@ With this tutorial, run a batch job by using the {{site.data.keyword.codeenginef
2525

2626
A job runs one or more instances of your executable code. Unlike applications, which handle HTTP requests, jobs are designed to run one time and exit. When you create a job, you can specify workload configuration information that is used each time that the job is run.
2727

28-
**Before you begin**
28+
Before you begin
2929

3030
To use the {{site.data.keyword.codeengineshort}} console, go to [{{site.data.keyword.codeengineshort}} overview](https://cloud.ibm.com/codeengine/overview){: external}.
3131

@@ -58,7 +58,7 @@ After you create your job and specify your workload configuration information, y
5858
* From the Jobs page, click the name of the job that you want to run.
5959

6060
2. From your job page, in the Jobs pane, click **Submit job**.
61-
3. From the Submit job pane, accept all of the default values, and click **Submit job** again to run your job.
61+
3. From the Submit job pane, accept all the default values, and click **Submit job** again to run your job.
6262

6363
From the Submit job pane, you can review and optionally change default configuration values such as instances, CPU, memory, number of job retries, and job timeout. You can specify either **Number of instances** or **Array indices** for the number of parallel job instances to run. For **Number of instances**, provide the number of instances to run in parallel for this job. For **Array indices**, provide a comma-separated list for your custom set of indices. For example, to run this job with a custom set of `5` indices, specify `3,12-14,25`. After you submit this job, the system displays the status of the instances of your job on the Job details page. If you specify **Number of instances** instead of **Array indices** in the Submit job pane, from the `Configuration` section of the Job details page, this information is provided as **Array indices**.
6464
{: note}

build-tutorial-buildpacks.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
copyright:
44
years: 2021
5-
lastupdated: "2021-11-17"
5+
lastupdated: "2021-12-20"
66

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

@@ -20,7 +20,6 @@ completion-time: 10m
2020
{: toc-content-type="tutorial"}
2121
{: toc-completion-time="10m"}
2222

23-
With this tutorial, build a container image from source with the {{site.data.keyword.codeengineshort}} CLI. The build process uses the [buildpacks strategy](/docs/codeengine?topic=codeengine-plan-build#build-strategy) and stores the image from the build process on Docker Hub.
2423
{: shortdesc}
2524

2625
A build, or image build, is a mechanism that you can use to create a container image from your source code. {{site.data.keyword.codeengineshort}} supports building from a Dockerfile and Cloud Native Buildpacks.
@@ -78,7 +77,7 @@ OK
7877
```
7978
{: screen}
8079

81-
The `size` option specifies the size for the build, which determines the amount of resources that are used. Valid values are `small`, `medium`, `large`, `xlarge`. The `size` reflects the build requirements for your source code for your app or job. If the build fails due to lack of memory or disk space, or is not fast enough, try switching to a larger size. A larger build size also means that more memory and CPU cores are assigned to the build process. Increasing this size will probably speed up the build process, but this action also increases the cost. For more information about builds, check the [troubleshooting tips](/docs/codeengine?topic=codeengine-troubleshoot-build).
80+
The `size` option specifies the size for the build, which determines the amount of resources that are used. Valid values are `small`, `medium`, `large`, `xlarge`. The `size` reflects the build requirements for your source code for your app or job. If the build fails due to lack of memory or disk space, or is not fast enough, try switching to a larger size. A larger build size also means that more memory and CPU cores are assigned to the build process. Increasing this size can probably speed up the build process, but this action also increases the cost. For more information about builds, check the [troubleshooting tips](/docs/codeengine?topic=codeengine-troubleshoot-build).
8281
{: tip}
8382

8483
## Submit a build run

0 commit comments

Comments
 (0)