Skip to content

functions.oracle.com/v1beta1

Back to API Reference

APIVersion: functions.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

Package Support Latest release Resources
Functions preview v2.0.0-alpha Application, Function

Resources

Kind Scope Sample Packages
Application Namespaced Sample Functions (v2.0.0-alpha)
Function Namespaced Sample Functions (v2.0.0-alpha)

Application

Manage OCI Functions application containers.

  • Plural: applications
  • Scope: Namespaced
  • APIVersion: functions.oracle.com/v1beta1
  • Sample: Sample (config/samples/functions_v1beta1_application.yaml)
  • Packages: Functions (v2.0.0-alpha)

Spec

ApplicationSpec defines the desired state of Application.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment to create the application within. string Yes - -
config Application configuration. These values are passed on to the function as environment variables, functions may override application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"} The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. map[string, string] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName The display name of the application. The display name must be unique within the compartment containing the application. Avoid entering confidential information. string Yes - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
imagePolicyConfig ApplicationImagePolicyConfig defines nested fields for Application.ImagePolicyConfig. object No - -
networkSecurityGroupIds The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. list[string] No - -
securityAttributes Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} map[string, map[string, string]] No - -
shape Valid values are GENERIC_X86, GENERIC_ARM and GENERIC_X86_ARM. Default is GENERIC_X86. Setting this to GENERIC_X86, will run the functions in the application on X86 processor architecture. Setting this to GENERIC_ARM, will run the functions in the application on ARM processor architecture. When set to GENERIC_X86_ARM, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: GENERIC_X86, GENERIC_ARM, GENERIC_X86_ARM string No - -
subnetIds The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. list[string] Yes - -
syslogUrl A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL. Example: tcp://logserver.myserver:1234 string No - -
traceConfig ApplicationTraceConfig defines nested fields for Application.TraceConfig. object No - -

Spec.imagePolicyConfig

Back to Application spec

ApplicationImagePolicyConfig defines nested fields for Application.ImagePolicyConfig.

Field Description Type Required Default Enum
isPolicyEnabled Define if image signature verification policy is enabled for the application. boolean Yes - -
keyDetails A list of KMS key details. list[object] No - -

Spec.imagePolicyConfig.keyDetails[]

Back to Application spec

ApplicationImagePolicyConfigKeyDetail defines nested fields for Application.ImagePolicyConfig.KeyDetail.

Field Description Type Required Default Enum
kmsKeyId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. string Yes - -

Spec.traceConfig

Back to Application spec

ApplicationTraceConfig defines nested fields for Application.TraceConfig.

Field Description Type Required Default Enum
domainId The OCID of the collector (e.g. an APM Domain) trace events will be sent to. string No - -
isEnabled Define if tracing is enabled for the resource. boolean No - -

Status

ApplicationStatus defines the observed state of Application.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that contains the application. string No - -
config Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"} The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. map[string, string] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName The display name of the application. The display name is unique within the compartment containing the application. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application. string No - -
imagePolicyConfig ApplicationImagePolicyConfig defines nested fields for Application.ImagePolicyConfig. object No - -
lifecycleState The current state of the application. string No - -
networkSecurityGroupIds The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. list[string] No - -
securityAttributes Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} map[string, map[string, string]] No - -
shape Valid values are GENERIC_X86, GENERIC_ARM and GENERIC_X86_ARM. Default is GENERIC_X86. Setting this to GENERIC_X86, will run the functions in the application on X86 processor architecture. Setting this to GENERIC_ARM, will run the functions in the application on ARM processor architecture. When set to GENERIC_X86_ARM, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: GENERIC_X86, GENERIC_ARM, GENERIC_X86_ARM string No - -
status - object Yes - -
subnetIds The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. list[string] No - -
syslogUrl A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL. Example: tcp://logserver.myserver:1234 string No - -
timeCreated The time the application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-09-12T22:47:12.613Z string No - -
timeUpdated The time the application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-09-12T22:47:12.613Z string No - -
traceConfig ApplicationTraceConfig defines nested fields for Application.TraceConfig. object No - -

Status.imagePolicyConfig

Back to Application status

ApplicationImagePolicyConfig defines nested fields for Application.ImagePolicyConfig.

Field Description Type Required Default Enum
isPolicyEnabled Define if image signature verification policy is enabled for the application. boolean Yes - -
keyDetails A list of KMS key details. list[object] No - -

Status.imagePolicyConfig.keyDetails[]

Back to Application status

ApplicationImagePolicyConfigKeyDetail defines nested fields for Application.ImagePolicyConfig.KeyDetail.

Field Description Type Required Default Enum
kmsKeyId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. string Yes - -

Status.status

Back to Application status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Application status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Application status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Application status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.traceConfig

Back to Application status

ApplicationTraceConfig defines nested fields for Application.TraceConfig.

Field Description Type Required Default Enum
domainId The OCID of the collector (e.g. an APM Domain) trace events will be sent to. string No - -
isEnabled Define if tracing is enabled for the resource. boolean No - -

Function

Manage OCI Functions function definitions and images.

  • Plural: functions
  • Scope: Namespaced
  • APIVersion: functions.oracle.com/v1beta1
  • Sample: Sample (config/samples/functions_v1beta1_function.yaml)
  • Packages: Functions (v2.0.0-alpha)

Spec

FunctionSpec defines the desired state of Function.

Field Description Type Required Default Enum
applicationId The OCID of the application this function belongs to. string Yes - -
config Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"} The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. map[string, string] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
detachedModeTimeoutInSeconds Timeout for detached function invocations. Value in seconds. integer No - -
displayName The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information. string Yes - -
failureDestination FunctionFailureDestination defines nested fields for Function.FailureDestination. object No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
image The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1 string No - -
imageDigest The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7 string No - -
memoryInMBs Maximum usable memory for the function (MiB). integer (int64) Yes - -
provisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig defines nested fields for Function.ProvisionedConcurrencyConfig. object No - -
sourceDetails FunctionSourceDetails defines nested fields for Function.SourceDetails. object No - -
successDestination FunctionSuccessDestination defines nested fields for Function.SuccessDestination. object No - -
timeoutInSeconds Timeout for executions of the function. Value in seconds. integer No - -
traceConfig FunctionTraceConfig defines nested fields for Function.TraceConfig. object No - -

Spec.failureDestination

Back to Function spec

FunctionFailureDestination defines nested fields for Function.FailureDestination.

Field Description Type Required Default Enum
channelId The ID of the channel in the queue. string No - -
jsonData - string No - -
kind - string No - -
queueId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Spec.provisionedConcurrencyConfig

Back to Function spec

FunctionProvisionedConcurrencyConfig defines nested fields for Function.ProvisionedConcurrencyConfig.

Field Description Type Required Default Enum
count Configuration specifying a constant amount of provisioned concurrency. integer No - -
jsonData - string No - -
strategy - string No - -

Spec.sourceDetails

Back to Function spec

FunctionSourceDetails defines nested fields for Function.SourceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
pbfListingId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this function is sourced from. string No - -
sourceType - string No - -

Spec.successDestination

Back to Function spec

FunctionSuccessDestination defines nested fields for Function.SuccessDestination.

Field Description Type Required Default Enum
channelId The ID of the channel in the queue. string No - -
jsonData - string No - -
kind - string No - -
queueId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Spec.traceConfig

Back to Function spec

FunctionTraceConfig defines nested fields for Function.TraceConfig.

Field Description Type Required Default Enum
isEnabled Define if tracing is enabled for the resource. boolean No - -

Status

FunctionStatus defines the observed state of Function.

Field Description Type Required Default Enum
applicationId The OCID of the application the function belongs to. string No - -
compartmentId The OCID of the compartment that contains the function. string No - -
config Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: {"MY_FUNCTION_CONFIG": "ConfVal"} The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8. map[string, string] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
detachedModeTimeoutInSeconds Timeout for detached function invocations. Value in seconds. Example: {"detachedModeTimeoutInSeconds": 900} integer No - -
displayName The display name of the function. The display name is unique within the application containing the function. string No - -
failureDestination FunctionFailureDestination defines nested fields for Function.FailureDestination. object No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function. string No - -
image The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1 string No - -
imageDigest The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7 string No - -
invokeEndpoint The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached. string No - -
lifecycleState The current state of the function. string No - -
memoryInMBs Maximum usable memory for the function (MiB). integer (int64) No - -
provisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig defines nested fields for Function.ProvisionedConcurrencyConfig. object No - -
shape The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest. string No - -
sourceDetails FunctionSourceDetails defines nested fields for Function.SourceDetails. object No - -
status - object Yes - -
successDestination FunctionSuccessDestination defines nested fields for Function.SuccessDestination. object No - -
timeCreated The time the function was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-09-12T22:47:12.613Z string No - -
timeUpdated The time the function was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-09-12T22:47:12.613Z string No - -
timeoutInSeconds Timeout for executions of the function. Value in seconds. integer No - -
traceConfig FunctionTraceConfig defines nested fields for Function.TraceConfig. object No - -

Status.failureDestination

Back to Function status

FunctionFailureDestination defines nested fields for Function.FailureDestination.

Field Description Type Required Default Enum
channelId The ID of the channel in the queue. string No - -
jsonData - string No - -
kind - string No - -
queueId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Status.provisionedConcurrencyConfig

Back to Function status

FunctionProvisionedConcurrencyConfig defines nested fields for Function.ProvisionedConcurrencyConfig.

Field Description Type Required Default Enum
count Configuration specifying a constant amount of provisioned concurrency. integer No - -
jsonData - string No - -
strategy - string No - -

Status.sourceDetails

Back to Function status

FunctionSourceDetails defines nested fields for Function.SourceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
pbfListingId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this function is sourced from. string No - -
sourceType - string No - -

Status.status

Back to Function status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Function status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Function status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Function status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.successDestination

Back to Function status

FunctionSuccessDestination defines nested fields for Function.SuccessDestination.

Field Description Type Required Default Enum
channelId The ID of the channel in the queue. string No - -
jsonData - string No - -
kind - string No - -
queueId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Status.traceConfig

Back to Function status

FunctionTraceConfig defines nested fields for Function.TraceConfig.

Field Description Type Required Default Enum
isEnabled Define if tracing is enabled for the resource. boolean No - -