Oracle Cloud Infrastructure Documentation

Managing Functions Using the OCI Functions Plugin for Visual Studio Code (VS Code)

Find out how to manage functions and applications using the OCI Functions Plugin for Visual Studio Code.

Visual Studio Code (often referred to simply as VS Code) is a Microsoft source-code editor made with the Electron Framework, and available for Windows, Linux, and macOS.

The OCI Functions Plugin for Visual Studio Code enables you to view, create, deploy, and invoke functions using OCI Functions, directly from VS Code.

This image shows the OCI Functions Plugin for Visual Studio Code. The left-hand navigator panel shows an expanded hierarchy of a tenancy, that contains compartments, that contain applications, that contain functions. The dex-us-phoenix-1 root compartment is expanded and contains two applications, one of which (demo-uxrb) is selected and contains a number of functions. A pop-up menu is shown, containing the options 'Edit application', 'Delete application', and 'Create function'. The right-hand 'Get Started' panel contains a 'New File' link, an 'Open' link, and a 'Clone Git Repository' link. A 'Recent' section has links to recently opened files. A 'Walkthroughs' section has links to various getting started-type documents..

Prerequisites

As with any Oracle client, obtain an API signing key. For guidance, see How to Generate an API Signing Key.

You must also install the OCI Core extension, which is available from the Visual Studio Marketplace.

Installing the Plugin

For instructions to install the OCI Functions Plugin for Visual Studio Code, see OCI Functions Plugin for VS Code GitHub repository.

Note that to deploy functions you create using the OCI Functions Plugin for Visual Studio Code, your user's profile in the ~/.oci/config file must include a user field that specifies your user's OCID. Be aware that if you generate the ~/.oci/config file automatically by clicking the Sign In button, the profile does not contain a user field. If this is the case, add the user field before deploying functions. For example:

user=ocid1.user.oc1..aaaaaaaaa______adtw4r

Listing Applications, and Opening an Application for Editing

  1. In the tree navigation on the left side, expand the node for the compartment that you want.

    The applications you can access are shown.

  2. Expand the node for the application that you want to edit.

Creating a Function

  1. In the tree navigation on the left side, expand the node for the compartment that you want.
  2. Right click the node for the application that you want and select Create function....
  3. Create the new function in one of the following ways:

    • Create from a template:

      1. Select the Create from a template creation method in the entry field in the Code Editor menu bar.
      2. Select a template from the list of templates.

        The new function is shown in the tree navigation.

    • Create from a sample:

      1. Select the Create from a sample creation method in the entry field in the Code Editor menu bar.
      2. Select a sample from the list of samples.

        The new function is shown in the tree navigation.

    • Create from a code repository:

      1. Select the Create from a code repository creation method in the entry field in the Code Editor menu bar.
      2. Enter a name for the function.
      3. Enter the url of the remote repository containing the function code. For example, https://github.com/jdoe/simple-python-helloworld-repo

        The new function is shown in the tree navigation.

Deploying a Function

  1. In the tree navigation on the left side, expand the node for the compartment that you want.
  2. Expand the node for the application that you want.
  3. Right click the node for the function that you want to deploy, and select Deploy function....

    If your user's profile in the ~/.oci/config file does not include a user field specifying your user's OCID (perhaps because you generated the ~/.oci/config file automatically by clicking the Sign In button), a dialog informs you the user field is missing. If you see the dialog, add the user field to the ~/.oci/config file before continuing.

  4. Specify:
    • Registry location: The location of the registry in which you are going to store the function. For example, phx.ocir.io
    • Auth token: The generated auth token to use as the password when logging in to Oracle Cloud Infrastructure Registry.

Editing Function Settings

  1. In the tree navigation on the left side, expand the node for the compartment that you want.
  2. Expand the node for the application that you want.
  3. Right click the node for the function that you want to edit and select Edit function settings.
  4. Specify:
    • Timeout: The maximum time the function will be allowed to run. Best practice is to specify a timeout that is close to that likely to be required, rather than significantly more.
    • Memory: The maximum memory threshold for the function.

Adding and Editing Custom Configuration Parameters

  1. In the tree navigation on the left side, expand the node for the compartment that you want.
  2. Expand the node for the application that you want.
  3. Expand the node for the function that you want.
  4. Click the Configuration node to edit the function's configuration.
  5. To define a new custom configuration parameter:
    1. Specify:
      • Key: The name of the custom configuration parameter. The name must only contain alphanumeric characters and underscores, and must not start with a number. For example, username
      • Name: A value for the custom configuration parameter. The value must only contain printable Unicode characters. For example, jdoe
    2. Click the plus (+) sign.
  6. To edit an existing configuration parameter, click the pen icon beside the parameter.
  7. Click Save.