This function creates a PAR (Pre-Authenticated Request) for a bucket in 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.
Before you deploy this sample function, make sure you have run step 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
Assuming your have successfully completed the prerequisites, you should see your application in the list of applications.
fn ls apps
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'}
Please check the Accessing Other Oracle Cloud Infrastructure Resources from Running Functions for other Matching Rules options.
Create a new policy that allows the dynamic group to manage compute instances. We will grant manage
access to a specific bucket
and objects
in that bucket for a given compartment.
Your policy should look something like this:
Allow dynamic-group <dynamic-group-name> to manage buckets in compartment <compartment-name> where target.bucket.name=<bucket-name>
Allow dynamic-group <dynamic-group-name> to manage objects in compartment <compartment-name> where target.bucket.name=<bucket-name>
For more information on how to create policies, go here.
Review the following files in the current folder:
- the code of the function, func.py
- its dependencies, requirements.txt
- the function metadata, func.yaml
In Cloud Shell, run the fn deploy command to build the function and its dependencies as a Docker image, push the image to OCIR, and deploy the function to Oracle Functions in your application.
fn -v deploy --app <app-name>
The function requires the config value bucket-name and lifetime to be set.
Use the fn CLI to set the config value:
fn config function <app-name> <function-name> bucket-name <bucket-name>
fn config function <app-name> <function-name> lifetime <PAR-lifetime-in-minutes>
e.g.
fn config function myapp oci-objectstorage-create-par-python bucket-name 'my-bucket'
fn config function myapp oci-objectstorage-create-par-python lifetime '1'
The function requires the name of the PAR in the payload to be invoked.
echo '{"PAR name": <PAR name> }' | fn invoke <app-name> oci-objectstorage-create-par-python
e.g.:
echo '{"PAR name": "myPAR" }' | fn invoke myapp oci-objectstorage-create-par-python
Upon success, the function returns the PAR URL.
Learn how to configure basic observability for your function using metrics, alarms and email alerts: