Functions: Function¶

Manage OCI Functions function definitions and images. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot¶

Field	Value
Service	`functions`
Resource	`Function`
API Version	`functions.oracle.com/v1beta1`
Package	Functions
Support Status	Preview
Latest Released Version	`v2.0.0-alpha`
Install Namespace	`oci-service-operator-functions-system`

Quick Links¶

Resource Guide Index
Setup Guide
Package Page
API Reference
Spec Reference
Status Reference
Rendered Sample (config/samples/functions_v1beta1_function.yaml)

Spec Fields¶

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
`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

Status Fields¶

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
`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

Sample Manifest¶

This example is generated from the checked-in sample manifest at config/samples/functions_v1beta1_function.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

apiVersion: functions.oracle.com/v1beta1
kind: Function
metadata:
  name: function-sample
spec: {}