Frances Overby: Merge pull request #3408 from coligo/fmo-upd-16Feb24-a

Author: cfsdocs

envvar-autoinject.md

@@ -2,7 +2,7 @@
 
 copyright:
   years: 2020, 2024
-lastupdated: "2024-02-15"
+lastupdated: "2024-02-16"
 
 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
 
@@ -68,6 +68,26 @@ Note that each job run instance gets its own index from the array of indices tha
 
 While the job itself doesn't have a URL associated with it, the `CE_DOMAIN` and `CE_SUBDOMAIN` values might be useful if you need to reference an application that is running in the same project. The full external URL of this application is `appName.CE_SUBDOMAIN.CE_DOMAIN`. To reference the private URL of an application, use `appName.CE_SUBDOMAIN`.
 
+## Automatically injected environment variables for functions
+{: #inside-env-vars-fun}
+
+When you deploy an function, {{site.data.keyword.codeengineshort}} automatically injects certain environment variables into the function.  The following table lists automatically injected environment variables into each instance of your deployed function. 
+
+The environment variables, `CE_FUNCTION`, `CE_DOMAIN`, and `CE_SUBDOMAIN` are used to construct the URL of a function, `https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN`. For example, if `CE_FUNCTION=myfunc`, `CE_SUBDOMAIN=01234567-abcd` and `CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud`, your function external URL is `https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud`. The private URL of your application is `CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAIN`, or `myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud`. 
+
+| Environment variable | Description | Example |
+|--------------------|-------------------------------------------------------|--------------|
+| `CE_ALLOW_CONCURRENT`| This internal boolean setting is used by the {{site.data.keyword.codeengineshort}} function controller to indicate if the runtime supports concurrent invocations of the same function instance, and can be ignored. | `CE_ALLOW_CONCURRENT=true` |
+| `CE_DOMAIN`          | The domain name portion of the URL of the function (and project).  | `CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud` |
+| `CE_EXECUTION_ENV`   | The managed runtime type and its release version.                     | `CE_EXECUTION_ENV=ibm/action-python-v3.11` This example specifies to use Python v3.11.  |
+| `CE_FUNCTION`        | The name of the function.                                             | `CE_APP=myfunc` |
+| `CE_SUBDOMAIN`       | The subdomain portion of the URL associated with the function (and project). If you are familiar with Kubernetes, `CE_SUBDOMAIN` maps to the Kubernetes namespace associated with your project. | `CE_SUBDOMAIN=01234567-abcd` |
+| `HOME`               | The home directory of the runtime container for the function.         | `HOME=/root` |
+| `LC_CTYPE`           | The locale that is used by the `ctype` and `multibyte` operating system API. Available only with Python runtimes.     | `LC_CTYPE=C.UTF-8` |
+| `PATH`               | The current setting of the PATH variable, which lists the directories in which the system looks for executables. | `PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin` |
+| `PYTHONIOENCODING`   | The standard encoding that is used by standard input, standard output, and standard error streams. This variable only applies to a Python runtime. | `PYTHONIOENCODING=UTF-8` |
+| `PWD`                | The current working directory.                                        | `PWD=/` |
+{: caption="Automatically injected environment variables when deploying {{site.data.keyword.codeengineshort}} functions"}
 
 
 

landing.json

@@ -1,6 +1,6 @@
 {
     "title": "Code Engine",
-    "lastupdated": "2024-02-15",
+    "lastupdated": "2024-02-16",
     "introduction": "Find out how you can use Code Engine to run your containerized workloads",
     "section_devtools": {
       "api": "/apidocs/codeengine/v2", 

release-notes.md

@@ -2,7 +2,7 @@
 
 copyright:
   years: 2020, 2024
-lastupdated: "2024-02-15"
+lastupdated: "2024-02-16"
 
 keywords: release notes for code engine, updates in code engine, what's new in code engine, document changes in code engine, updates, release notes
 
@@ -32,8 +32,10 @@ Updated the user experience for working with jobs and job runs in the console
 :   {{site.data.keyword.codeengineshort}} has enhanced the user experience to simplify working with jobs and job runs in the console. A consolidated list of job runs is now provided. See [Accessing job details from the console](/docs/codeengine?topic=codeengine-access-job-details#access-jobdetails-ui).
 
 Added more information about functions in {{site.data.keyword.codeengineshort}}
-:   - See [Options for visibility for a {{site.data.keyword.codeengineshort}} function](/docs/codeengine?topic=codeengine-fun-work#optionsvisibilityfun).
+:   - See [Automatically injected environment variables for functions](/docs/codeengine?topic=codeengine-inside-env-vars#inside-env-vars-fun).
 :   - See [Function pricing](/docs/codeengine?topic=codeengine-pricing#functions-pricing).
+:   - See [Options for visibility for a {{site.data.keyword.codeengineshort}} function](/docs/codeengine?topic=codeengine-fun-work#optionsvisibilityfun).
+:   - See [Verifying the code bundle reference for my function](/docs/codeengine?topic=codeengine-troubleshoot-function#ts-function-verifyimageg).
 
 Updated behavior change for image builds that are built with Cloud Native Buildpacks
 :   Introduced a behavior change for {{site.data.keyword.codeengineshort}} image builds that are built with Buildpacks. Images that are built using Buildlpacks no longer use the neutral timestamp of `Jan, 1st 1980` as their image creation timestamp. The timestamp of the input source is now used. See [Choosing a build strategy -  Cloud Native Buildpacks](/docs/codeengine?topic=codeengine-plan-build#build-buildpack-strat).

sitemap.md

@@ -2,7 +2,7 @@
 
 copyright:
   years: 2024
-lastupdated: "2024-02-15"
+lastupdated: "2024-02-16"
 
 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
 
@@ -3881,6 +3881,8 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
 
 * [Automatically injected environment variables for jobs](/docs/codeengine?topic=codeengine-inside-env-vars#inside-env-vars-jobs)
 
+* [Automatically injected environment variables for functions](/docs/codeengine?topic=codeengine-inside-env-vars#inside-env-vars-fun)
+
 
 ## Defining commands and arguments for your workloads
 {: #sitemap_defining_commands_and_arguments_for_your_workloads}
@@ -4270,6 +4272,8 @@ Find what you are looking for in the compilation of {{site.data.keyword.codeengi
 
 * [Keep your runtime and CLI versions up to date](/docs/codeengine?topic=codeengine-troubleshoot-function#ts-function-uptodate)
 
+* [Verifying the code bundle reference for my function](/docs/codeengine?topic=codeengine-troubleshoot-function#ts-function-verifyimage)
+
 * [Additional topics](/docs/codeengine?topic=codeengine-troubleshoot-function#ts-function-topics)
 
 [How can I add my {{site.data.keyword.codeengineshort}} function to an allowlist?](/docs/codeengine?topic=codeengine-ts-allowlist-function#ts-allowlist-function)

troubleshoot-function.md

@@ -2,7 +2,7 @@
 
 copyright:
   years: 2023, 2024
-lastupdated: "2024-02-01"
+lastupdated: "2024-02-16"
 
 keywords: troubleshooting for code engine, troubleshooting functions in code engine, function in code engine, function
 
@@ -94,9 +94,14 @@ When you view logs from the console, you must create an {{site.data.keyword.la_f
 
 Verify that your runtime is supported. See [Runtimes](/docs/codeengine?topic=codeengine-fun-runtime).
 
+## Verifying the code bundle reference for my function 
+{: #ts-function-verifyimage}
 
+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.    ``
+  
+When you work with {{site.data.keyword.codeengineshort}} functions, you must specify a code bundle reference and a registry secret to access the image. For the function to work correctly, the code bundle reference and its access properties must remain valid for the life of the function.
 
-
+Because code bundles and images are similar, you can verify your code bundle in the same ways that you verify an image. See [How can I verify my image reference](/docs/codeengine?topic=codeengine-ts-build-verify-image)?
 
 
 ## Additional topics