Skip to content

Commit ba3e331

Browse files
author
cfsdocs
committed
Merge pull request #1942 from coligo/fmo-upd-19Apr22-c
1 parent e2d9f1c commit ba3e331

14 files changed

+168
-69
lines changed

Diff for: appdeploy-access.md

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

33
copyright:
44
years: 2020, 2022
5-
lastupdated: "2022-03-19"
5+
lastupdated: "2022-04-19"
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

@@ -49,8 +49,8 @@ ibmcloud ce app get --name myapp
4949
```
5050
{: pre}
5151

52-
#### Example output
53-
{: #access-appdetails-cli-example}
52+
53+
Example output
5454

5555
```txt
5656
[...]

Diff for: appdeploy-cr.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ subcollection: codeengine
1212

1313
{{site.data.keyword.attribute-definition-list}}
1414

15-
# Deploying application workloads from images in {{site.data.keyword.registryshort}}
15+
# Deploying application workloads from images in {{site.data.keyword.registrylong_notm}}
1616
{: #deploy-app-crimage}
1717

18-
Deploy your app with {{site.data.keyword.codeengineshort}} that uses an image in {{site.data.keyword.registryshort}}. You can create an app from the console or with the CLI.
18+
Deploy your app with {{site.data.keyword.codeengineshort}} that uses an image in {{site.data.keyword.registrylong}}. You can create an app from the console or with the CLI.
1919
{: shortdesc}
2020

2121
Before you begin
@@ -51,16 +51,13 @@ Now that you have deployed your application, you can view information about appl
5151

5252
If you want to add registry access to a {{site.data.keyword.registryshort}} instance that is not in your account, see [Adding access to a {{site.data.keyword.registryshort}}](/docs/codeengine?topic=codeengine-add-registry).
5353

54-
Looking for more code examples? Check out the [Samples for {{site.data.keyword.codeenginefull_notm}} GitHub repo](https://github.com/IBM/CodeEngine){: external}.
55-
{: tip}
56-
5754
## Deploying an app with an image in {{site.data.keyword.registryshort}} with the CLI
5855
{: #deploy-app-crimage-cli}
5956

60-
Deploy an application that uses an image in a container registry with the CLI with the **`ibmcloud ce app create`** command.
57+
Deploy an application that uses an image in in {{site.data.keyword.registrylong}} with the CLI with the **`ibmcloud ce app create`** command.
6158
{: shortdesc}
6259

63-
Before you can work with a {{site.data.keyword.codeengineshort}} application that references an image in {{site.data.keyword.registryshort}}, you must first add access to the registry, pull the image, and then deploy it.
60+
Before you can work with a {{site.data.keyword.codeengineshort}} application that references an image in {{site.data.keyword.registryshort}}, you must first add access to the registry so {{site.data.keyword.codeengineshort}} can pull the image when the app is deployed.
6461

6562
1. To add access to {{site.data.keyword.registryshort_notm}}, [create an IAM API key](/docs/codeengine?topic=codeengine-add-registry#images-your-account-api-key). To create an {{site.data.keyword.cloud_notm}} IAM API key with the CLI, run the [**`iam api-key-create`**](/docs/account?topic=cli-ibmcloud_commands_iam#ibmcloud_iam_api_key_create) command. For example, to create an API key called `cliapikey` with a description of "My CLI APIkey" and save it to a file called `key_file`, run the following command:
6663

@@ -104,8 +101,6 @@ Before you can work with a {{site.data.keyword.codeengineshort}} application tha
104101
```
105102
{: pre}
106103
107-
Looking for more code examples? Check out the [Samples for {{site.data.keyword.codeenginefull_notm}} GitHub repo](https://github.com/IBM/CodeEngine){: external}.
108-
{: tip}
109104
110105
## Next steps for apps
111106
{: #nextsteps-appdeploycr}

Diff for: appdeploy-private.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Before you begin
2222

2323
To pull images from a private registry, you must first create a private registry. For example, to create a private Docker Hub registry, see [Docker Hub documentation](https://docs.docker.com/docker-hub/repos/){: external}. After you create a private registry, [push an image to it](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub){: external}. You can also set up an access token. By using an access token, you can more easily grant and revoke access to your Docker Hub account without requiring a password change. For more information about access tokens and Docker Hub, see [Managing access tokens](https://docs.docker.com/docker-hub/access-tokens/){: external}.
2424

25-
## Deploying an app that references an image in private registry with the console
25+
## Deploying an app that references an image in a private registry with the console
2626
{: #deploy-app-private-console}
2727

2828
Deploy an application that uses an image in a private registry with the {{site.data.keyword.codeengineshort}} console.
@@ -56,9 +56,6 @@ Now that you have deployed your application, you can view information about appl
5656

5757
If you want to add registry access before you create an app, see [Adding access to a private container registry](/docs/codeengine?topic=codeengine-add-registry).
5858

59-
Looking for more code examples? Check out the [Samples for {{site.data.keyword.codeenginefull_notm}} GitHub repo](https://github.com/IBM/CodeEngine){: external}.
60-
{: tip}
61-
6259
## Deploying an app with an image from a private registry with CLI
6360
{: #deploy-app-private-cli}
6461

@@ -76,7 +73,7 @@ Before you can work with a {{site.data.keyword.codeengineshort}} application tha
7673
```
7774
{: pre}
7875
79-
**Example output**
76+
Example output
8077
8178
```txt
8279
Creating image registry access secret 'privatedocker'...
@@ -101,8 +98,6 @@ Before you can work with a {{site.data.keyword.codeengineshort}} application tha
10198
```
10299
{: pre}
103100
104-
Looking for more code examples? Check out the [Samples for {{site.data.keyword.codeenginefull_notm}} GitHub repo](https://github.com/IBM/CodeEngine){: external}.
105-
{: tip}
106101
107102
## Next steps for apps
108103
{: #nextsteps-appdeploypriv}

Diff for: appdeploy-public.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ ibmcloud ce application create --name myapp --image icr.io/codeengine/hello
5656
```
5757
{: pre}
5858

59-
**Example output**
59+
Example output
6060

6161
```txt
6262
Creating application 'myapp'...

Diff for: appdeploy-source.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can deploy your application directly from source code with the console.
2929

3030
Before you begin, [plan for your build](/docs/codeengine?topic=codeengine-plan-build). You can also find [tips for creating a Dockerfile](/docs/codeengine?topic=codeengine-dockerfile).
3131

32-
{{site.data.keyword.codeengineshort}} can automatically push (upload) images to {{site.data.keyword.registryshort}} namespaces in your account and even create a namespace for you. To upload images to a different {{site.data.keyword.registryshort}} account or to a private Docker Hub account, see [Adding access to a private container registry](/docs/codeengine?topic=codeengine-add-registry).
32+
{{site.data.keyword.codeengineshort}} can automatically push (upload) images to {{site.data.keyword.registrylong}} namespaces in your account and even create a namespace for you. To upload images to a different {{site.data.keyword.registryshort}} account or to a private Docker Hub account, see [Accessing container registries](/docs/codeengine?topic=codeengine-add-registry).
3333

3434
1. Open the [{{site.data.keyword.codeengineshort}}](https://cloud.ibm.com/codeengine/overview){: external} console.
3535
2. Select **Start creating** from **Start from source code**.
@@ -41,8 +41,8 @@ Before you begin, [plan for your build](/docs/codeengine?topic=codeengine-plan-b
4141
8. Select a source repository, for example, `https://github.com/IBM/CodeEngine`. Because we are using sample source that does not require credentials, select `None` for the Code repo access. You can optionally provide a branch name. If you do not provide a branch name and you leave the field empty, {{site.data.keyword.codeengineshort}} automatically uses the default branch of the specified repository. Click **Next**.
4242
9. Select a strategy for your build and resources for your build. For more information about build options, see [Planning your build](/docs/codeengine?topic=codeengine-plan-build). Click **Next**.
4343
10. Select a container registry location, such as `IBM Registry, Dallas` to specify where to store the image of your build output. If your registry is private, you must [set up access](/docs/codeengine?topic=codeengine-add-registry) to it.
44-
11. Select an existing **Registry access secret** or create a new one. If you are building your image to a {{site.data.keyword.registryshort}} instance that is in your account, you can select `{{site.data.keyword.codeengineshort}} managed secret` and let {{site.data.keyword.codeengineshort}} create and manage the secret for you.
45-
12. Select a namespace, name, and a tag for your image. If you are building your image to a {{site.data.keyword.registryshort}} instance that is in your account, you can select an existing namespace or let {{site.data.keyword.codeengineshort}} create and manage the namespace for you.
44+
11. Provide registry information about where to store the image of your build output. Select an existing **Registry access secret** or create a new one. If you are building your image to a {{site.data.keyword.registryshort}} instance that is in your account, you can select `{{site.data.keyword.codeengineshort}} managed secret` and let {{site.data.keyword.codeengineshort}} create and manage the secret for you.
45+
12. Select a namespace, name, and a tag for your image. If you are building your image to a {{site.data.keyword.registrylong_notm}} instance that is in your account, you can select an existing namespace or let {{site.data.keyword.codeengineshort}} create and manage the namespace for you.
4646
13. Click **Done**.
4747
14. Modify any runtime settings or environment variables for your app. For more information about these options, see [Options for endpoint visibility of apps](/docs/codeengine?topic=codeengine-application-workloads#optionsdeploy) and [Options for deploying an app](/docs/codeengine?topic=codeengine-application-workloads#optionsdeploy).
4848
15. Click **Create**.

Diff for: appdeploy-update.md

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

33
copyright:
44
years: 2020, 2022
5-
lastupdated: "2022-04-14"
5+
lastupdated: "2022-04-19"
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

@@ -175,7 +175,7 @@ The sample `icr.io/codeengine/hello` image reads the environment variable `TARGE
175175
```
176176
{: pre}
177177
178-
**Example output**
178+
Example output
179179
180180
```txt
181181
Hello Stranger
@@ -193,7 +193,7 @@ The sample `icr.io/codeengine/hello` image reads the environment variable `TARGE
193193
```
194194
{: pre}
195195
196-
**Example output**
196+
Example output
197197
198198
```txt
199199
Listing all application revisions...
@@ -226,7 +226,7 @@ In this scenario, update the application that you created in [Deploying an appli
226226
```
227227
{: pre}
228228
229-
**Example output**
229+
Example output
230230
231231
```txt
232232
Updating application 'myapp' to latest revision.
@@ -245,7 +245,7 @@ In this scenario, update the application that you created in [Deploying an appli
245245
```
246246
{: pre}
247247
248-
**Example output**
248+
Example output
249249
250250
```txt
251251
[...]
@@ -367,7 +367,7 @@ In this scenario, update the application that you created in [Deploying an appli
367367
```
368368
{: pre}
369369
370-
**Example output**
370+
Example output
371371
372372
```txt
373373
Updating application 'myapp' to latest revision.
@@ -386,7 +386,7 @@ In this scenario, update the application that you created in [Deploying an appli
386386
```
387387
{: pre}
388388
389-
**Example output**
389+
Example output
390390
391391
```txt
392392
[...]
@@ -543,7 +543,7 @@ From the previous example, the `myhelloapp` app references the `us.icr.io/myname
543543
544544
The following output displays the details of the build run by using the [**`ibmcloud ce buildrun get`**](/docs/codeengine?topic=codeengine-cli#cli-buildrun-get) command.
545545
546-
**Example output**
546+
Example output
547547
548548
```txt
549549
Getting build run 'helloworld-build-run'...
@@ -582,7 +582,7 @@ From the previous example, the `myhelloapp` app references the `us.icr.io/myname
582582
```
583583
{: pre}
584584
585-
**Example output**
585+
Example output
586586
587587
```txt
588588
[...]

Diff for: batch-tutorial.md

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

33
copyright:
44
years: 2020, 2022
5-
lastupdated: "2022-04-05"
5+
lastupdated: "2022-04-19"
66

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

@@ -108,9 +108,27 @@ When the job is in ready state, you can update the job. Let's update the job tha
108108
## Next steps for jobs
109109
{: #nextsteps-deployjobtut}
110110

111-
After you create your job, you can submit it to [run the job](/docs/codeengine?topic=codeengine-run-job). For more information about jobs, see [Working with jobs](/docs/codeengine?topic=codeengine-job-plan).
111+
After you create your job, you must submit the job to run it. See [Run a job](/docs/codeengine?topic=codeengine-run-job).
112112

113-
Now that you have created your job, you can use event subscriptions to make your jobs event-driven, so that your jobs are triggered by [periodic schedules](/docs/codeengine?topic=codeengine-subscribe-cron#eventing-cron-job) or react to events like [file uploads](/docs/codeengine?topic=codeengine-eventing-cosevent-producer#obstorage_ev_job).
113+
After you [run your job](/docs/codeengine?topic=codeengine-run-job), to view details of your job and job runs, see [access job details](/docs/codeengine?topic=codeengine-access-job-details).
114+
115+
You can update your job in any of the following ways:
116+
117+
* By accessing and referencing your existing built container image in a [public registry](/docs/codeengine?topic=codeengine-create-job) or [private registry](/docs/codeengine?topic=codeengine-create-job-private). For more information, see [Accessing container registries](/docs/codeengine?topic=codeengine-add-registry).
118+
119+
* By using the [build container images](/docs/codeengine?topic=codeengine-build-image) feature available in {{site.data.keyword.codeengineshort}} to build your image and then access the referenced image from your job run.
120+
121+
* You can choose to let {{site.data.keyword.codeengineshort}} handle the build of your [local source](/docs/codeengine?topic=codeengine-run-job-local-source-code) or [Git repository source](/docs/codeengine?topic=codeengine-run-job-source-code) for you. The job run can then access the referenced image.
122+
123+
For example, you might choose to let {{site.data.keyword.codeengineshort}} handle the build of your local source while you evolve the development of your source for the job. Then, after the image is "matured", you can update the job to reference the specific image that you want. You can repeat this process as needed.
124+
125+
Each time your job runs, the most current version of your referenced container image is downloaded and run.
126+
127+
For more information about updating jobs, see [Updating a job](/docs/codeengine?topic=codeengine-update-job).
128+
129+
130+
131+
Now that you have created your job, consider making your jobs event-driven. By using event subscriptions, you can trigger your jobs by [periodic schedules](/docs/codeengine?topic=codeengine-subscribe-cron#eventing-cron-job) or set your job to react to events like [file uploads](/docs/codeengine?topic=codeengine-eventing-cosevent-producer#obstorage_ev_job).
114132

115133

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

0 commit comments

Comments
 (0)