Different Options for Function Development Environments

Find out about the different OCI Functions development environments you can set up.

When setting up your OCI Functions development environment, you have different options:

  • Option 1: Setting up Cloud Shell. (Recommended) For users trying out OCI Functions for the first time, this is the recommended way to get started quickly. By copying and pasting a few commands from the Console into the Cloud Shell window, you can set up an OCI Functions development environment in just a few minutes.

    This option enables you to experiment creating, deploying, and invoking new functions. You can also explore OCI Functions using the samples on Git Hub (see Oracle Functions Samples).

    Use the Functions QuickStart on Cloud Shell if you want to set up Cloud Shell as your OCI Functions development environment.

  • Option 2: Setting up a local machine. For most users (especially Mac and Linux users), this will be the way to work with OCI Functions. If you set up a local machine, you'll have to specify --provider oracle when you create a new Fn Project CLI context.

    This option enables OCI Functions to perform authentication and authorization using Oracle Cloud Infrastructure request signing, private keys, user groups, and policies that grant permissions to those user groups.

    Use the Functions QuickStart on Local Host if you want to set up a local machine as your OCI Functions development environment.

  • Option 3: Setting up an Oracle Cloud Infrastructure compute instance. For some users, this will be more convenient than setting up a local machine. If you set up an Oracle Cloud Infrastructure compute instance, you'll have to specify --provider oracle-ip when you create a new Fn Project CLI context.

    This option enables OCI Functions to perform authentication and authorization using instance OCIDs, dynamic groups, and policies granting permissions to those dynamic groups. This approach removes the requirement for users to manage private keys. Note that to set up an OCI Functions development environment on an Oracle Cloud Infrastructure compute instance, you must:

    • have permission to create dynamic groups
    • create a new dynamic group that includes the compute instance's OCID
    • create a policy to give the new dynamic group access to function resources, network resources, and Oracle Cloud Infrastructure Registry
    • specify --provider oracle-ip when you create a new Fn Project CLI context

    Use the Functions QuickStart on an OCI Compute Instance if you want to set up an Oracle Cloud Infrastructure compute instance as your OCI Functions development environment.