Merge pull request #1405 from oracle-devrel/review-and-fixes-5

reviewed

Author: martatolosa

app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/README.md

@@ -36,13 +36,18 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 -->
 
-## Functions overview
-[Document functions-overview](files/Fn.pdf)
+# API Gateway authorizer function context var example
 
-### Author
+Reviewed: 31.10.2024
+ 
+# When to use this asset?
+ 
+Anyone who wants to test OCI Queue service using OCI SDK in JavaScript and do this from GitHub Actions.
+
+# Author
 <a href="https://github.com/mikarinneoracle">mikarinneoracle</a>
 
-# API Gateway authorizer function context var example
+# How to use this asset?
 
 ## Build and deploy the functions
 
@@ -59,23 +64,23 @@ fdk.handle(function(input){
         "principal": "myprincipal",
         "scope": ["fnsimplejs"],
         "clientId": "clientIdFromHeader",
-        "expiresAt": "2023-12-31T00:00:00+00:00",
+        "expiresAt": "2025-12-31T00:00:00+00:00",
         "context": {
             "username": input.token
         }
       }
   } else {
       json = {
         "active": false,
-        "expiresAt": "2023-12-31T00:00:00+00:00",
+        "expiresAt": "2025-12-31T00:00:00+00:00",
         "wwwAuthenticate": "Bearer realm=\"www.com\""
       }
   }
   return json;
 })
 </pre>
 
-The authorizer function will pass on the <code>username</code> in <code>auth context</code> as a custom variable. The value for it is set from REST call input as <code>token</code> on the <a href="fnauthjs/func.js#L52">line 52</a>.
+The authorizer function will pass on the <code>username</code> in <code>auth context</code> as a custom variable. The value for it is set from REST call input as <code>token</code> on the <a href="files/fnauthjs/func.js#L52">line 52</a>.
 <br>
 Here's the call using API Gateway:
 <pre>
@@ -94,7 +99,7 @@ fdk.handle(function(input, ctx){
 
 The secondary / backend function will get the authorizer passed variable <code>username</code>
 as a transformed header variable <code>Fn-Http-H-Username</code> and will print it out as the
-function REST call result on the <a href="fnsimplejs/func.js#L42">line 42</a>.
+function REST call result on the <a href="files/fnsimplejs/func.js#L42">line 42</a>.
 <br>
 Here's the call using API Gateway:
 <pre>
@@ -144,4 +149,17 @@ curl https://drp....56kvgu.apigateway.eu-amsterdam-1.oci.customer-oci.com/
 {"code":401,"message":"Unauthorized"}
 </pre>
 
+# Useful Links
+
+- [OCI Functions](https://docs.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm)
+    - Learn how the Functions service lets you create, run, and scale business logic without managing any infrastructure
+- [Oracle](https://www.oracle.com/)
+    - Oracle Website
+
+### License
+
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+Licensed under the Universal Permissive License (UPL), Version 1.0.
 
+See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.

app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/files/Fn.pdf

@@ -1,5 +1,5 @@
 {
-	"name": "hellofn",
+	"name": "fnsimplejs",
     "version": "1.0.0",
 	"description": "example function",
 	"main": "func.js",

app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/fnauthjs/func.js renamed to app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/files/fnauthjs/func.js

@@ -0,0 +1,36 @@
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/fnauthjs/func.yaml renamed to app-dev/devops-and-containers/functions/js-authorizer-oci-fn-example/files/fnauthjs/func.yaml

@@ -36,30 +36,46 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 -->
 
-## Functions overview
-[Document functions-overview](files/Fn.pdf)
+# Example function to copy a file from an Object Storage bucket to multiple other buckets when uploaded
 
-### Author
-<a href="https://github.com/mikarinneoracle">mikarinneoracle</a>
+Reviewed: 31.10.2024
+ 
+# When to use this asset?
+ 
+Anyone who wants to implement content distribution in Object Storage buckets across multiple regions. This function is triggered by the upload CloudEvent of the source bucket and then copies the received file to multiple (1-n) other buckets that are replicated to other regions using the Object Storage buckets automatic replication feature. This way we can implement content distribution in  Object Storage buckets across multiple regions.
 
-# Example function to copy a file from an Object Storage bucket to multiple other buckets when uploaded
+# Author
+<a href="https://github.com/mikarinneoracle">mikarinneoracle</a>
 
-### The Use case
+# How to use this asset?
 
-The use case is that this function will be triggered by the upload CloudEvent of the source bucket
-and then it copies the received file to multiple (1-n) other buckets that are replicated to other regions
-using the Object Storage buckets automatic replication feature. This way we can implement content distribution
-in  Object Storage buckets across multiple regions.
+## Function configuration
 
-<p>
-<h3>Function configuration</h3>  
-<img src="images/config.png" width="800">
+<img src="files/config.png" width="800">
 <ul>
 <li><code>TENANCY</code> is the tenancy os namespace name e.g. what you get when running <code>oci os ns get</code></li>
 <li><code>SOURCE_BUCKET</code> is the bucket where the file is uploaded and triggers this function using a CloudEvent</li>
 <li><code>TARGET_BUCKETS</code> are the comma delimited buckets to where the file is copied from the source bucket are replicatyed to other regions using the Object Storage replication feature</li>
 </ul>
 
 <h3>Function example log when triggered by the Object Storage file upload (create/update) CloudEvent</h3>
-<img src="images/log.png" width="800">
+<img src="files/log.png" width="800">
+
+
+# Useful Links
+ 
+- [OCI Functions](https://docs.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm)
+    - Learn how the Functions service lets you create, run, and scale business logic without managing any infrastructure
+- [OCI SDK for JavaScript](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/typescriptsdk.htm)
+    - The Oracle Cloud Infrastructure SDK for TypeScript and JavaScript enables you to write code to manage Oracle Cloud Infrastructure resources
+- [Oracle](https://www.oracle.com/)
+    - Oracle Website
+
+### License
+
+Copyright (c) 2024 Oracle and/or its affiliates.
+
+Licensed under the Universal Permissive License (UPL), Version 1.0.
+
+See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.