https://github.com/abhirockzz/fn-img2pdf
Serverless function for converting image to PDF
https://github.com/abhirockzz/fn-img2pdf
faas fnproject object-storage oci-events oracle-cloud-infrastructure oracle-functions orafunc-events orafunc-la serverless
Last synced: 6 months ago
JSON representation
Serverless function for converting image to PDF
- Host: GitHub
- URL: https://github.com/abhirockzz/fn-img2pdf
- Owner: abhirockzz
- Created: 2019-04-03T06:22:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-03T06:29:16.000Z (over 6 years ago)
- Last Synced: 2025-02-13T16:32:52.148Z (8 months ago)
- Topics: faas, fnproject, object-storage, oci-events, oracle-cloud-infrastructure, oracle-functions, orafunc-events, orafunc-la, serverless
- Language: Java
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Event driven function for converting images to PDF
This event driven function converts images files (jpeg, png etc.) to PDF. Once you drop the image into an Oracle Cloud Infrastructure Object Storage Bucket and configure the appropriate trigger rule, the function will convert it into PDF and store the converted file (with a `.pdf` extension) in an output bucket specified by the user
- The function written in Java and uses [Apache PDFBox](https://pdfbox.apache.org/) for file conversion.
- Uses the [OCI Java SDK](https://github.com/oracle/oci-java-sdk) to execute Object Storage read and write operations
- A custom `Dockerfile` is used to build the function
## Pre-requisites
- [Create input and output buckets in Oracle Cloud Infrastructure Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Tasks/managingbuckets.htm#usingconsole)
- Collect the following information for you OCI tenancy (you'll need these in subsequent steps) - Tenancy OCID, User OCID of a user in the tenancy, OCI private key, OCI public key passphrase, OCI region
- Clone this repository
- Change into the correct directory - `cd fn-img2pdf`
- Copy your OCI private key to folder. If you don't already have one, [please follow the documentation](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How)
### Switch to correct context
- `fn use context `
- Check using `fn ls apps`
## Create application
`fn create app img2pdf --annotation oracle.com/oci/subnetIds='SUBNET_OCIDs' --config TENANT= --config USER= --config FINGERPRINT= --config PASSPHRASE= --config REGION= --config OUTPUT_BUCKET=`
> The OCI user credentials you provide should have read and write access to the specified Object Storage bucket)
The function logic uses the following image file types/extensions by default - `jpeg`,`jpg`, `png`. If you want override it (e.g. you only want to support `gif` and `jpg` types), please add `VALID_FILE_TYPES` configuration to the `fn create` e.g. `--config VALID_FILE_TYPES=jpg,gif`.
e.g.
`fn create app img2pdf --annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx.aaaaaaaaghmsma7mpqhqdhbgnby25u2zo4wqlrrcskvu7jg56dryxtfoobar"]' --config TENANT=ocid1.tenancy.oc1..aaaaaaaaydrjm77otncda2xn7qtv7l3hqnd3zxn2u6siwdhniibwfvfoobar --config USER=ocid1.user.oc1..aaaaaaaavz5efq7jwjjipbvm536plgylg7rfr53obvtghpi2vbg3qyfoobar --config FINGERPRINT=41:82:5f:44:ca:a1:2e:58:d2:63:6a:af:52:42:42:42 --config PASSPHRASE=4242 --config REGION=us-phoenix-1 --config OUTPUT_BUCKET=pdf-output-bucket`
### Check deployed application
`fn inspect app img2pdf`
## Deploy the application
`fn -v deploy --app img2pdf --build-arg PRIVATE_KEY_NAME=`
e.g.
`fn -v deploy --app img2pdf --build-arg PRIVATE_KEY_NAME=oci_private_key.pem`
## Create Events rule
### Before you proceed...
Find the function OCID (use the command below) and replace it in `actions.json` file
`fn inspect fn img2pdf convertimg2pdf | jq '.id' | sed -e 's/^"//' -e 's/"$//'`
{
"actions": [
{
"actionType": "FAAS",
"description": "Invoke function on object store event",
"isEnabled": true,
"functionId": "enter function OCID here"
}
]
}
Go ahead and create the rule using OCI CLI
`oci --profile cloud-events rule create --display-name --is-enabled true --condition '{"eventType": ["com.oraclecloud.objectstorage.object.create"],"data": {"bucketName": [""]}}' --compartment-id --actions file://`
Replace `` with the (input) Object Storage bucket name where you will upload the image
e.g.
`oci --profile devrel-abhishek cloud-events rule create --display-name invoke-img2pdf-function --is-enabled true --condition '{"eventType": ["com.oraclecloud.objectstorage.object.create"],"data": {"bucketName": ["image-input-bucket"]}}' --compartment-id ocid1.compartment.oc1..aaaaaaaaokbzj2jn3hf5kwdwqoxl2dq7u54p3tsmxrjd7s3uu7x23tfoobar --actions file://actions.json`
## Test
Upload an image file to the Object Storage bucket which you configured as the input bucket (in the above rule). Wait for a bit and check the bucket which you configured as the output - you should see the converted PDF file there.