You use Fn Project CLI commands to create and deploy functions to Oracle Functions.
If you aren't able to successfully complete one of the steps in this topic, review the solutions for common problems (see Troubleshooting Oracle Functions).
Using Fn Project CLI Commands
To create and deploy a function to Oracle Functions using Fn Project CLI commands:
Confirm that you have completed the prerequisite steps for using Oracle Functions, as described in Preparing for Oracle Functions. Specifically, that you have:
- set up your tenancy (see Configuring Your Tenancy for Function Development)
- set up your development environment (see Configuring Your Client Environment for Function Development)
If the application to which you want to add the function doesn't yet exist in Oracle Functions, create it now using the Fn Project CLI or the Console. For example, you might create a new application called acmeapp. See Creating Applications.
Log in to your development environment as a functions developer.
In a terminal window, change directory to the directory containing the function code.
Initialize the function by entering:
$ fn init --runtime <runtime-language> <function-name>
<runtime-language>is one of the supported runtime languages (currently go, java, node, python, and ruby are supported)
<function-name>is the name to use as the function name. If you don't specify a function name, the name of the current directory (in lower case) is used. Avoid entering confidential information.
$ fn init --runtime java acme-func
A directory is created with the function name you specified, containing:
- A function definition file called func.yaml, containing the minimum amount of information required to build and run the function. See the Fn Project documentation to find out about the additional parameters you can include in a func.yaml file.
- A /src directory containing source files and directories.
- A Maven configuration file called pom.xml that specifies the project artifacts and dependencies required to compile the function from the source files.
Note that depending on the runtime language you specify, the
fn initcommand might create an /example directory containing code for a helloworld application. As a matter of good practice, you'll probably want to delete the /example directory.
- Change directory to the newly created directory.
Enter the following single Fn Project command to build the function and its dependencies as a Docker image, push the image to the specified Docker registry, and deploy the function to Oracle Functions:
$ fn -v deploy --app <app-name>
<app-name>is the name of the application in Oracle Functions to which you want to add the function. For example:
$ fn -v deploy --app acmeapp
-voption simply shows more detail about what Fn Project commands are doing (see Using the Fn Project CLI with Oracle Functions).
Note that you can build, push, and deploy the function using separate Fn Project commands, instead of the single
- (Optional) Assuming the specified Docker registry is Oracle Cloud Infrastructure Registry, use the Console to confirm that the image has been pushed to Oracle Cloud Infrastructure Registry successfully:
- In the Console, open the navigation menu. Under Solutions and Platform, go to Developer Services and click Registry.
Choose the registry's region.
You see all the repositories in the registry to which you have access. The image you pushed is in a new private repository with a name constructed from:
- the repository name in the address of the Docker registry in the Fn Project CLI context (see 6. Create an Fn Project CLI Context to Connect to Oracle Cloud Infrastructure)
- the name of the image you pushed
For example, the new repository might be called
- Click the name of the new repository. You see details of the image that's been pushed to Oracle Cloud Infrastructure Registry
(Optional) Use the Console to confirm that the function has been deployed to Oracle Functions successfully:
- In the Console, open the navigation menu. Under Solutions and Platform, go to Developer Services and click Functions.
Select the compartment specified in the Fn Project CLI context (see 6. Create an Fn Project CLI Context to Connect to Oracle Cloud Infrastructure).
The Applications page shows the applications in the compartment, including the one you specified in the
Click the name of the application you specified in the
fn deploycommand to see the functions within it.
The Functions page shows that the function has been deployed to Oracle Functions.