Skip to content

Commit 05528e7

Browse files
foverbyGitHub Enterprise
authored and
GitHub Enterprise
committed
Merge pull request #489 from cloud-docs/next-publish-push
Next publish push
2 parents d1bc286 + 062aa68 commit 05528e7

12 files changed

+271
-43
lines changed

api-changelog.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ When the API is changed in a way that is not compatible with previous versions,
2828
### Active version dates
2929
{: #active-version-dates}
3030

31-
The following table shows the service behavior changes for each version date. Switching to a later version date will activate all changes introduced in earlier versions.
31+
The following table shows the service behavior changes for each version date. Switching to a later version date activates all changes that are introduced in earlier versions.
3232

3333
| Version date | Summary of changes |
3434
|---|---|
@@ -80,7 +80,7 @@ Added support for service binding operations in the API.
8080
: - See [Get a binding API](https://cloud.ibm.com/apidocs/codeengine/v2#get-binding){: external}.
8181
: - See [Delete a binding API](https://cloud.ibm.com/apidocs/codeengine/v2#delete-binding){: external}.
8282

83-
Added support for service access secrets which are required for service binding operations. Specify to create service access secrets with the `format` field and specify the details of service access secrets with the `service_access` field.
83+
Added support for service access secrets, which are required for service binding operations. Specify to create service access secrets with the `format` field and specify the details of service access secrets with the `service_access` field.
8484
: - See [Create a secret API](https://cloud.ibm.com/apidocs/codeengine/v2#create-secret){: external}.
8585

8686

@@ -91,8 +91,7 @@ Added support for service access secrets which are required for service binding
9191
Added support to get status details for a project.
9292
: - See [Get the status details for a project API](https://cloud.ibm.com/apidocs/codeengine/v2#get-project-status-details){: external}.
9393

94-
95-
## 27 Mar 2023
94+
## 27 March 2023
9695
{: #27-mar-2023}
9796

9897
Added support to provide private and public egress IP addresses for a project.
@@ -105,8 +104,7 @@ Improved documentation for create and update of secrets to include the `One of`
105104
: - See [Update secret API](https://cloud.ibm.com/apidocs/codeengine/v2#replace-secret){: external}.
106105

107106

108-
109-
## 9 Dec 2022
107+
## 9 December 2022
110108
{: #9-dec-2022}
111109

112110
{{site.data.keyword.codeenginefull}} API Version 2.0.0
@@ -115,5 +113,4 @@ API Version 2.0.0 released
115113
: This version of the API is enhanced to support more {{site.data.keyword.codeengineshort}} resources, and more regions.
116114
- The API supports the following {{site.data.keyword.codeengineshort}} resources: `projects`, `reclamations`, `apps`, `revisions`, `job`, `job runs`, `builds`, `build runs`, `config maps`, and `secrets`. See [{{site.data.keyword.codeengineshort}} API](https://cloud.ibm.com/apidocs/codeengine){: external}.
117115
- The API supports more regional endpoints. See [Regions for {{site.data.keyword.codeengineshort}}](/docs/codeengine?topic=codeengine-regions).
118-
119116

api.md

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

33
copyright:
4-
years: 2023
5-
lastupdated: "2023-12-12"
4+
years: 2024
5+
lastupdated: "2024-02-05"
66

77
keywords: api reference, api, Kubernetes configuration and code engine, CRD for code engine, CRD, custom resource definition, guid, kubernetes, authenticate, code engine api
88

@@ -182,13 +182,13 @@ For more information about these CRDs, see [Knative Serving API Specification](h
182182
183183
| Group | Version | Kind |
184184
| --------- | -------- | -------- |
185-
| `shipwright.io` | v1alpha1 | `Build` |
186-
| `shipwright.io` | v1alpha1 | `BuildRun` |
185+
| `shipwright.io` | v1beta1 | `Build` |
186+
| `shipwright.io` | v1beta1 | `BuildRun` |
187187
{: caption="Source-to-image CRDs for {{site.data.keyword.codeengineshort}}" caption-side="bottom"}
188188
189189
After you retrieve the Kubernetes configuration, you can view the Source-to-image CRD details by using one of the following methods.
190190
191-
- Use `kubectl explain --api-version='shipwright.io/v1alpha1' <KIND>`.
191+
- Use `kubectl explain --api-version='shipwright.io/v1beta1' <KIND>`.
192192
- [Download the Swagger or `OpenAPI` specification of CRDs](https://kubernetes.io/docs/concepts/overview/kubernetes-api/){: external}.
193193
194194
### Subscription CRD methods

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-01-25"
5+
lastupdated: "2024-02-05"
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.4 | 2024-02-05 | - Fixed various bugs. |
2324
| 1.49.3 | 2024-01-25 | - Fixed various bugs. |
2425
| 1.49.2 | 2024-01-12 | - Fixed various bugs. |
2526
| 1.49.1 | 2023-12-06 | - Fixed various bugs. |

cmd_defs.md

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

33
copyright:
44
years: 2024
5-
lastupdated: "2024-01-23"
5+
lastupdated: "2024-02-05"
66

77
keywords: cli for code engine, command-line interface for code engine, cli commands for code engine, reference for code engine cli, ibmcloud ce, ibmcloud codeengine, commands, code engine cli, apps, jobs, source code, configmap, build repository, build, secret, image repository, registry, example, example output
88

@@ -61,7 +61,7 @@ ibmcloud ce application bind --name APP_NAME (--service-instance SI_NAME | --ser
6161
{: #cmd-options-application-bind}
6262

6363
`--name`, `-n`
64-
: The name of the application to bind. This value is *required*.
64+
: The name of the application to bind. This value is *required*.
6565

6666
`--no-wait`, `--nw`
6767
: Bind the service instance and do not wait for the service binding to be ready. If you specify the `no-wait` option, the service binding creation is started and the command exits without waiting for it to complete. Use the `app get` command to check the application bind status. This value is *optional*. The default value is `false`.
@@ -364,7 +364,7 @@ Deleted application 'myapp'
364364
### `ibmcloud ce application events`
365365
{: #cli-application-events}
366366

367-
Display the events of application instances.
367+
Display the system events of application instances. System events are retained up to 60 minutes.
368368

369369
```txt
370370
ibmcloud ce application events (--instance APP_INSTANCE | --application APP_NAME) [--output OUTPUT] [--quiet]
@@ -1433,7 +1433,7 @@ OK
14331433
### `ibmcloud ce buildrun events`
14341434
{: #cli-buildrun-events}
14351435

1436-
Display the events of a build run.
1436+
Display the system events of a build run. System events are retained up to 60 minutes.
14371437

14381438
```txt
14391439
ibmcloud ce buildrun events --buildrun BUILDRUN_NAME [--output OUTPUT] [--quiet]
@@ -3669,7 +3669,7 @@ OK
36693669
### `ibmcloud ce jobrun events`
36703670
{: #cli-jobrun-events}
36713671

3672-
Display the events of job run instances.
3672+
Display the system events of job run instances. System events are retained up to 60 minutes.
36733673

36743674
```txt
36753675
ibmcloud ce jobrun events (--instance JOBRUN_INSTANCE | --jobrun JOBRUN_NAME) [--output OUTPUT] [--quiet]
@@ -5661,7 +5661,7 @@ OK
56615661
### `ibmcloud ce revision events`
56625662
{: #cli-revision-events}
56635663

5664-
Display the events of application revision instances.
5664+
Display the system events of application revision instances. System events are retained up to 60 minutes.
56655665

56665666
```txt
56675667
ibmcloud ce revision events (--instance REVISION_INSTANCE | --revision REVISION_NAME) [--output OUTPUT] [--quiet]

fun-migrate.md

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

33
copyright:
4-
years: 2023, 2023
5-
lastupdated: "2023-12-12"
4+
years: 2023, 2024
5+
lastupdated: "2024-01-31"
66

77
keywords: code engine, function, create function, code engine function, create code engine function, migrate function
88

@@ -18,7 +18,7 @@ subcollection: codeengine
1818
[IBM Cloud Functions](https://cloud.ibm.com/docs/openwhisk){: external} has been IBM’s recommended Functions-as-a-Service solution, based on IBM’s public cloud. Available in six data centers around the world, IBM Cloud Functions serves the needs of customers since its inception.
1919
{: shortdesc}
2020

21-
However, the increased demands and additional requirements that our customers have been articulating, lead us to constantly innovate, improve, and evolve the IBM Functions-as-a-Service technologies and offerings. As a result and to address these demands, IBM is adding Functions-as-a-Service technology to IBM Cloud Code Engine. For limitations when you use functions in Code Engine, see [Function limitations](/docs/codeengine?topic=codeengine-fun-work#fun-limitations).
21+
However, the increased demands and additional requirements that our customers have been articulating, lead us to constantly innovate, improve, and evolve the IBM Functions-as-a-Service technologies and offerings. As a result and to address these demands, IBM is adding Functions-as-a-Service technology to {{site.data.keyword.codeenginefull}}. For limitations when you use functions in Code Engine, see [Function limitations](/docs/codeengine?topic=codeengine-fun-work#fun-limitations).
2222

2323
## Comparing Code Engine to Cloud Functions
2424
{: #fun-migrate-compare}
@@ -27,11 +27,11 @@ The SOC2, ISO32k, BSI C5, and Financial Services Cloud-certified IBM Cloud Code
2727

2828
The new Functions-as-a-Service capabilities enable Code Engine customers to perform short running, run-to-completion type of workloads. Whether you are a Cloud Functions customer or you are new to Functions-as-a-Service, you can learn more about [running functions in IBM Cloud Code Engine](/docs/codeengine?topic=codeengine-fun-work). You can even [take a tutorial](/docs/codeengine?topic=codeengine-fun-tutorial).
2929

30-
Functions-as-a-Service in Code Engine offers an improved server-less value proposition in terms of user experience, usage patterns, security, and total cost of ownership.
30+
Functions-as-a-Service in {{site.data.keyword.codeengineshort}} offers an improved server-less value proposition in terms of user experience, usage patterns, security, and total cost of ownership.
3131

32-
Function sin Code Engine simplifies your user experience, with the following options.
32+
Functions in {{site.data.keyword.codeengineshort}} simplifies your user experience, with the following options.
3333

34-
- Integrates fully with the Code Engine development flow and features.
34+
- Integrates fully with the {{site.data.keyword.codeengineshort}} development flow and features.
3535
- Includes common programming languages and provides optimized managed runtimes.
3636
- Offers on-demand code execution with low cold start latency and rapid scale-out.
3737
- Offers a Web-URL based Function invocation mechanism with feature-rich support for web applications.
@@ -40,7 +40,7 @@ Function sin Code Engine simplifies your user experience, with the following opt
4040

4141
With IBM Cloud Code Engine Functions, you can use your favorite programming language to write lightweight code that runs snippets of business logic in a scalable way. You can run code in response to HTTP requests from applications or in response to IBM Cloud services and external events.
4242

43-
Rather than running a container image, Code Engine functions instead, runs a code bundle. A code bundle is a collection of files that represents your function code. This code bundle is injected into the runtime container. Your code bundle is created by {{site.data.keyword.codeengineshort}} and is stored in container registry or inline with the function. A code bundle is not a Open Container Initiative (OCI) standard container image.
43+
Rather than running a container image, {{site.data.keyword.codeengineshort}} functions instead, runs a code bundle. A code bundle is a collection of files that represents your function code. This code bundle is injected into the runtime container. Your code bundle is created by {{site.data.keyword.codeengineshort}} and is stored in container registry or inline with the function. A code bundle is not a Open Container Initiative (OCI) standard container image.
4444

4545
## Key capabilities
4646
{: #fun-migrate-key}
@@ -79,7 +79,7 @@ In addition, {{site.data.keyword.codeengineshort}} includes [Function limits](/d
7979
| Optimized for | Long running, highly complex workload and on-demand scale-out | Scheduled or planned workloads with high resource demands | Startup time and rapid scale-out |
8080
{: caption="Table 1. Comparing {{site.data.keyword.codeengineshort}} apps, jobs, and functions" caption-side="bottom"}
8181

82-
## Migrating IBM Cloud Functions Actions to Code Engine Functions FAQ
82+
## Migrating IBM Cloud Functions Actions to {{site.data.keyword.codeengineshort}} Functions FAQ
8383
{: #fun-migrate-faqs}
8484

8585
### How can I process a bulk-load of computations?
@@ -95,7 +95,7 @@ You can convert your action to a {{site.data.keyword.codeengineshort}} function
9595
### Can I trigger my function code?
9696
{: #fun-migrate-faq3}
9797

98-
While {{site.data.keyword.codeengineshort}} does not include an object called a “trigger”, it does support subscribing to event producers, including cron jobs (alarms), Object storage, and Event Streams (Kafka) data. However, functions do not support eventing. You can instead create your code as an app or job and then add a subscription. For more information, see [Getting started with subscriptions](/docs/codeengine?topic=codeengine-subscribing-events).
98+
No. {{site.data.keyword.codeengineshort}} supports only event producers (or triggers) for applications and jobs. You can create your code as an app or job, and then add a subscription to an event producer, including cron jobs (alarms), Object storage, and Event Streams (Kafka) data. For more information, see [Getting started with subscriptions](/docs/codeengine?topic=codeengine-subscribing-events).
9999

100100
### Can my function be accessed through a public URL?
101101
{: #fun-migrate-faq4}
@@ -127,7 +127,7 @@ If you are using Cloud Functions that are based on `whisk.system` actions, you c
127127

128128
Yes, service binds are supported! See [Working with service bindings to integrate IBM Cloud services with Code Engine](/docs/codeengine?topic=codeengine-service-binding).
129129

130-
### Where can I find information about my in progress and finished Code Engine Function runs?
130+
### Where can I find information about my in progress and finished {{site.data.keyword.codeengineshort}} Function runs?
131131
{: #fun-migrate-faq10}
132132

133133
If you created your Function from source code, you can [view build logs](/docs/codeengine?topic=codeengine-view-logs#view-build-cli).

landing.json

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

release-notes.md

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

33
copyright:
44
years: 2020, 2024
5-
lastupdated: "2024-01-30"
5+
lastupdated: "2024-02-05"
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

@@ -20,6 +20,25 @@ content-type: release-note
2020
Use the release notes to learn about the latest changes to {{site.data.keyword.codeenginefull}} that are grouped by month.
2121
{: shortdesc}
2222

23+
## February 2024
24+
{: #codeengine-feb24}
25+
26+
### 05 February 2024
27+
{: #codeengine-feb0524}
28+
{: release-note}
29+
30+
[CLI release]{: tag-purple} CLI version 1.49.4 released
31+
: See [CLI version history](/docs/codeengine?topic=codeengine-cli_versions).
32+
33+
[New]{: tag-green} Added troubleshooting information about displaying limits and current usage with the CLI
34+
: - See [Debugging apps](/docs/codeengine?topic=codeengine-troubleshoot-apps#ts-app-limits).
35+
: - See [Debugging builds](/docs/codeengine?topic=codeengine-troubleshoot-build#ts-build-limits).
36+
: - See [Debugging functions](/docs/codeengine?topic=codeengine-troubleshoot-function#ts-function-limits).
37+
: - See [Debugging jobs](/docs/codeengine?topic=codeengine-troubleshoot-job#ts-job-limits).
38+
39+
[Update]{: tag-magenta} The `Build` and `BuildRun` Kubernetes API objects are available in a new version
40+
: The `Build` and `BuildRun` Kubernetes API objects are available as `v1beta1` version. The `v1alpha1` version of these objects is deprecated. If you use the Kubernetes API to manage these objects, update to use the `v1beta1` version. No action is required if you use the {{site.data.keyword.codeengineshort}} API, CLI, or console. See [Source-to-image CRD methods](/docs/codeengine?topic=codeengine-api#api-crd-s2i).
41+
2342
## January 2024
2443
{: #codeengine-jan24}
2544

sitemap.md

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

33
copyright:
44
years: 2024
5-
lastupdated: "2024-01-30"
5+
lastupdated: "2024-02-05"
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

@@ -136,6 +136,16 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
136136

137137
[Release notes](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-relnotes)
138138

139+
* [February 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-feb24)
140+
141+
* [05 February 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-feb0524)
142+
143+
* [CLI release]{: tag-purple} CLI version 1.49.4 released
144+
145+
* [New]{: tag-green} Added troubleshooting information about displaying limits and current usage with the CLI
146+
147+
* [Update]{: tag-magenta} The `Build` and `BuildRun` Kubernetes API objects are available in a new version
148+
139149
* [January 2024](/docs/codeengine?topic=codeengine-codeengine-relnotes#codeengine-jan24)
140150

141151
* Review the release notes for January 2024.
@@ -2632,7 +2642,7 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
26322642

26332643
* [What {{site.data.keyword.codeengineshort}} entity is best for my workload?](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-compare-app-job)
26342644

2635-
* [Migrating IBM Cloud Functions Actions to Code Engine Functions FAQ](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faqs)
2645+
* [Migrating IBM Cloud Functions Actions to {{site.data.keyword.codeengineshort}} Functions FAQ](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faqs)
26362646

26372647
* [How can I process a bulk-load of computations?](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faq1)
26382648

@@ -2652,7 +2662,7 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
26522662

26532663
* [Can I bind my function to service credentials?](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faq9)
26542664

2655-
* [Where can I find information about my in progress and finished Code Engine Function runs?](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faq10)
2665+
* [Where can I find information about my in progress and finished {{site.data.keyword.codeengineshort}} Function runs?](/docs/codeengine?topic=codeengine-fun-migrate#fun-migrate-faq10)
26562666

26572667
* [Does {{site.data.keyword.codeengineshort}} provide an OpenAPI specification for the deployed function?](/docs/codeengine?topic=codeengine-fun-migrate#openapi-spec-fun-migrate)
26582668

@@ -3830,9 +3840,9 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
38303840

38313841
* [30 May 2023](/docs/codeengine?topic=codeengine-api-changelog#30-may-2023)
38323842

3833-
* [27 Mar 2023](/docs/codeengine?topic=codeengine-api-changelog#27-mar-2023)
3843+
* [27 March 2023](/docs/codeengine?topic=codeengine-api-changelog#27-mar-2023)
38343844

3835-
* [9 Dec 2022](/docs/codeengine?topic=codeengine-api-changelog#9-dec-2022)
3845+
* [9 December 2022](/docs/codeengine?topic=codeengine-api-changelog#9-dec-2022)
38363846

38373847
[Getting started with the {{site.data.keyword.codeengineshort}} REST API](/docs/codeengine?topic=codeengine-ceapi-getstart#ceapi-getstart)
38383848

0 commit comments

Comments
 (0)