oci-objectstorage-get-object-python

Function that retrieves an object from a bucket in Object Storage

This function uses Resource Principals to securely authorize a function to make API calls to OCI services using the OCI Python SDK. It returns the content of an object from a bucket in Object Storage.

The function calls the following OCI Python SDK classes:

• Resource Principals Signer to authenticate
• Object Storage Client to interact with Object Storage

As you make your way through this tutorial, look out for this icon . Whenever you see it, it's time for you to perform an action.

Pre-requisites

1. Before you deploy this sample function, make sure you have run steps A, B and C of the Oracle Functions Quick Start Guide for Cloud Shell

   • A - Set up your tenancy
   • B - Create application
   • C - Set up your Cloud Shell dev environment

2. Have your Oracle Object Storage Namespace available. This can be found by logging into your cloud account, under your user profile, click on your Tenancy. Your Object Storage Namespace is shown there.

List Applications

Assuming you have successfully completed the prerequisites, you should see your application in the list of applications.

fn ls apps

Create or Update your Dynamic Group

In order to use other OCI Services, your function must be part of a dynamic group. For information on how to create a dynamic group, refer to the documentation.

When specifying the Matching Rules, we suggest matching all functions in a compartment with:

ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaxxxxx'}

Create or Update IAM Policies

Create a new policy that allows the dynamic group to read objects in the functions related compartment.

Your policy should look something like this:

Allow dynamic-group <dynamic-group name> to read objects in compartment <compartment-name>

e.g.

Allow dynamic-group demo-func-dyn-group to read objects in compartment demo-func-compartment

For more information on how to create policies, go here.

Review and customize the function

Review the following files in the current folder:

• requirements.txt specifies all the dependencies for your function
• func.yaml that contains metadata about your function and declares properties
• func.py which is your actual Python function

The name of your function oci-objectstorage-get-object-python is specified in func.yaml.

Deploy the function

In Cloud Shell, run the fn deploy 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 in the application created earlier:

fn -v deploy --app <app-name>

e.g.

fn -v deploy --app myapp

Test

echo -n <JSON-object> | fn invoke <app-name> <function-name>

e.g.

echo -n '{"objectName": "<object-name>", "bucketName": "<bucket-name>"}' | fn invoke myapp oci-objectstorage-get-object-python

You should see the contents of the object appear in the terminal.

Monitoring Functions

Learn how to configure basic observability for your function using metrics, alarms and email alerts:

• Basic Guidance for Monitoring your Functions