Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 3.68 KB

README.md

File metadata and controls

98 lines (73 loc) · 3.68 KB
Raw

Best Practice Using Functions and NoSQL

Authorizing with Resource Principal

Resource Principal is an IAM service feature that enables the resources to be authorized actors (or principals) to perform actions on service resources. You may use Resource Principal when calling Oracle NoSQL Database Cloud Service from other Oracle Cloud service resource such as Functions

e.g follow the NoSQL Database Node.js SDK recommnedations

Best Practice Using Functions and NoSQL Database Python SDK

It is recommanded to set the main logger level to something lower than debug

logger = logging.getLogger()
logger.setLevel(logging.INFO)

Best Practice Using Functions and NoSQL Database Node.js SDK

The fnproject/node docker images are currently using node v11.15.0. Because the Prerequisites for Node.js for Oracle NoSQL Database is 12.0.0 or higher, We are provining in this demo a Dockerfile. In fact, we want to be sure to use a Node.js version supported by NoSQL.

Currently, We are using node:12-slim in order to reduce the size of the docker image. In a near future, we will test using GraalVM

If you want to know which is the node.js version used, use the following func.js script

const fdk=require('@fnproject/fdk')
const process = require('process');
fdk.handle(async function(input){
 return process.version;
})

Best practices for package.json. Use "oracle-nosqldb": ">=5.2.0" instead of fixing a version "oracle-nosqldb": "^5.2.0"

Be sure that you are not copying local node_modules directory to the docker image. It can generate incompatibilities if you are not using the same version in both side (local machine & docker image).

Delete the package-lock.json files before build your docker image.

Reading the claimTenancyId and claimCompartmentId (Node.js)

  const sessionTokenFilePath = process.env.OCI_RESOURCE_PRINCIPAL_RPST
  const rpst = fs.readFileSync(sessionTokenFilePath, {encoding: 'utf8'})
  const payload = rpst.split('.')[1]
  const buff = Buffer.from(payload, 'base64')
  const payloadDecoded = buff.toString('ascii')
  const claims = JSON.parse(payloadDecoded)
  const claimTenancyId = claims.res_tenant
  const claimCompartmentId = claims.res_compartment;
  const region = claims.res_id.split('.')[3];

Reading the claimTenancyId and claimCompartmentId (python)

claimCompartmentId = provider.get_resource_principal_claim(borneo.ResourcePrincipalClaimKeys.COMPARTMENT_ID_CLAIM_KEY)
claimTenancyId = provider.get_resource_principal_claim(borneo.ResourcePrincipalClaimKeys.TENANT_ID_CLAIM_KEY)

Passing Custom Configuration Parameters to Functions

Use the OCI Console or the fn config function/app to create a variable

fn config app  helloworld-app NOSQL_COMPARTMENT_ID <myocid>

Read the parameter "NOSQL_COMPARTMENT_ID" in node.js as env variables

function createClientResource() {
  return  new NoSQLClient({
    region: Region.EU_FRANKFURT_1,
    compartment:process.env.NOSQL_COMPARTMENT_ID,
    auth: {
        iam: {
            useResourcePrincipal: true
        }
    }
  });
}

Read the parameter "NOSQL_COMPARTMENT_ID" in python as env variables

import os

def get_handle():
     provider = borneo.iam.SignatureProvider.create_with_resource_principal()
     compartment_id = provider.get_resource_principal_claim(borneo.ResourcePrincipalClaimKeys.COMPARTMENT_ID_CLAIM_KEY)
     config = borneo.NoSQLHandleConfig(os.getenv('NOSQL_REGION'), provider).set_logger(None).set_default_compartment(compartment_id)
     return borneo.NoSQLHandle(config)
}