Renamed the function and cleaned up the readme

Author: sachin-pikle

oci-objectstorage-get-object-java/README.md

@@ -12,25 +12,27 @@ As you make your way through this tutorial, look out for this icon ![user input
 Whenever you see it, it's time for you to perform an action.
 
 
-## Pre-requisites
-1. Start by making sure all of your policies are correct from this [guide](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionscreatingpolicies.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Tenancy%20for%20Function%20Development%7C_____4)
+## Prerequisites
+![user input icon](./images/userinput.png)
 
-2. Have [Fn CLI setup with Oracle Functions](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionsconfiguringclient.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Client%20Environment%20for%20Function%20Development%7C_____0)
+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](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
+    * A - Set up your tenancy
+    * B - Create application
+    * C - Set up your Cloud Shell dev environment
 
-3. Have your Oracle Object Storage Namespace available. This can be found by
+2. Have your Oracle Object Storage Namespace available. This can be found by
 logging into your [cloud account](https://console.us-ashburn-1.oraclecloud.com/),
 under your user profile, click on your Tenancy. Your Object Storage Namespace
 is shown there.
 
 
-## Context
-Switch to the correct context
-
+## List Applications 
 ![user input icon](../images/userinput.png)
-```
-fn use context <your context name>
-```
-Check using
+
+Assuming your have successfully completed the prerequisites, you should see your 
+application in the list of applications.
+
 ```
 fn ls apps
 ```
@@ -43,25 +45,13 @@ click [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingd
 
 ![user input icon](../images/userinput.png)
 
-When specifying the *Matching Rules*, consider the following examples:
+When specifying the *Matching Rules*, consider the following example:
 * If you want all functions in a compartment to be able to access a resource,
 enter a rule similar to the following that adds all functions in the compartment
 with the specified compartment OCID to the dynamic group:
 ```
 ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}
 ```
-* If you want a specific function to be able to access a resource, enter a rule
-similar to the following that adds the function with the specified OCID to the
-dynamic group:
-```
-resource.id = 'ocid1.fnfunc.oc1.iad.aaaaaaaaacq______dnya'
-```
-* If you want all functions with a specific defined tag (free-form tags are
-not supported) to be able to access a resource, enter a rule similar to the
-following that adds all functions with the defined tag to the dynamic group :
-```
-ALL {resource.type = 'fnfunc', tag.department.operations.value = '45'}
-```
 
 
 ## Create or Update Policies
@@ -83,30 +73,13 @@ Allow dynamic-group demo-func-dyn-group to read object-family in compartment dem
 For more information on how to create policies, go [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
 
 
-## Create an Application to run the function
-You can use an application already created or create a new one as follows:
-
-![user input icon](../images/userinput.png)
-```
-fn create app <app-name> --annotation oracle.com/oci/subnetIds='["<subnet-ocid>"]
-```
-You can find the subnet-ocid by logging on to [cloud.oracle.com](https://cloud.oracle.com/en_US/sign-in),
-navigating to Core Infrastructure > Networking > Virtual Cloud Networks. Make
-sure you are in the correct Region and Compartment, click on your VNC and
-select the subnet you wish to use.
-e.g.
-```
-fn create app object-crud --annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx.aaaaaaaacnh..."]'
-```
-
-
 ## Review the function
 Review the following files in the current folder:
 - [pom.xml](./pom.xml) specifies all the dependencies for your function
 - [func.yaml](./func.yaml) that contains metadata about your function and declares properties
 - [src/main/java/com/example/fn/ObjectStorageGetObjects.java](./src/main/java/com/example/fn/ObjectStorageGetObjects.java) which contains the Java code
 
-The name of your function *oci-objectstorage-get-object* is specified in [func.yaml](./func.yaml).
+The name of your function *oci-objectstorage-get-object-java* is specified in [func.yaml](./func.yaml).
 
 
 ## Deploy the function
@@ -150,10 +123,10 @@ Use the *fn* CLI to invoke your function with your own object name, bucket name
 
 ![user input icon](../images/userinput.png)
 ```
-echo -n '{"name": "<object_name>", "bucketName":"<bucket_name>"}' | fn invoke <app_name> oci-objectstorage-get-object
+echo -n '{"name": "<object_name>", "bucketName":"<bucket_name>"}' | fn invoke <app_name> <function_name>
 ```
 e.g.
 ```
-echo -n '{"name": "file1.txt", "bucketName":"mybucket"}' | fn invoke object-crud oci-objectstorage-get-object
+echo -n '{"name": "file1.txt", "bucketName":"mybucket"}' | fn invoke object-crud oci-objectstorage-get-object-java
 ```
 Upon success, you should see the content of the object appear in your terminal.

oci-objectstorage-get-object-java/func.yaml

@@ -1,5 +1,5 @@
 schema_version: 20180708
-name: oci-objectstorage-get-object
+name: oci-objectstorage-get-object-java
 version: 0.0.1
 runtime: java
 build_image: fnproject/fn-java-fdk-build:jdk11-1.0.105

oci-objectstorage-list-objects-java/README.md

@@ -11,12 +11,16 @@ The function calls the following OCI Java SDK classes:
 As you make your way through this tutorial, look out for this icon ![user input icon](../images/userinput.png).
 Whenever you see it, it's time for you to perform an action.
 
-## Pre-requisites
-1. Start by making sure all of your policies are correct from this [guide](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionscreatingpolicies.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Tenancy%20for%20Function%20Development%7C_____4)
+## Prerequisites
+![user input icon](./images/userinput.png)
 
-2. Have [Fn CLI setup with Oracle Functions](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionsconfiguringclient.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Client%20Environment%20for%20Function%20Development%7C_____0)
+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](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
+    * A - Set up your tenancy
+    * B - Create application
+    * C - Set up your Cloud Shell dev environment
 
-3. Have your Oracle Object Storage Namespace available. This can be found by
+2. Have your Oracle Object Storage Namespace available. This can be found by
 logging into your [cloud account](https://console.us-ashburn-1.oraclecloud.com/),
 under your user profile, click on your Tenancy. Your Object Storage Namespace
 is shown there.
@@ -32,44 +36,32 @@ This folder includes files for both Java 11 and Java 8:
 
 Rename `func-jdkXX.yaml` to `func.yaml` and `pom-jdkXX.xml` to `pom.xml`
 
-## Context
-Switch to the correct context
 
+## List Applications 
 ![user input icon](../images/userinput.png)
-```
-fn use context <your context name>
-```
-Check using
+
+Assuming your 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 and retrieve information about other OCI Services, your function
 must be part of a dynamic group. For information on how to create a dynamic group,
 click [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm#To).
 
 ![user input icon](../images/userinput.png)
 
-When specifying the *Matching Rules*, consider the following examples:
+When specifying the *Matching Rules*, consider the following example:
 * If you want all functions in a compartment to be able to access a resource,
 enter a rule similar to the following that adds all functions in the compartment
 with the specified compartment OCID to the dynamic group:
 ```
 ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}
 ```
-* If you want a specific function to be able to access a resource, enter a rule
-similar to the following that adds the function with the specified OCID to the
-dynamic group:
-```
-resource.id = 'ocid1.fnfunc.oc1.iad.aaaaaaaaacq______dnya'
-```
-* If you want all functions with a specific defined tag (free-form tags are
-not supported) to be able to access a resource, enter a rule similar to the
-following that adds all functions with the defined tag to the dynamic group :
-```
-ALL {resource.type = 'fnfunc', tag.department.operations.value = '45'}
-```
 
 
 ## Create or Update Policies
@@ -91,30 +83,13 @@ Allow dynamic-group demo-func-dyn-group to inspect object-family in compartment
 For more information on how to create policies, go [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
 
 
-## Create an Application to run the function
-You can use an application already created or create a new one as follows:
-
-![user input icon](../images/userinput.png)
-```
-fn create app <app-name> --annotation oracle.com/oci/subnetIds='["<subnet-ocid>"]
-```
-You can find the subnet-ocid by logging on to [cloud.oracle.com](https://cloud.oracle.com/en_US/sign-in),
-navigating to Core Infrastructure > Networking > Virtual Cloud Networks. Make
-sure you are in the correct Region and Compartment, click on your VNC and
-select the subnet you wish to use.
-e.g.
-```
-fn create app object-crud --annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx.aaaaaaaacnh..."]'
-```
-
-
 ## Review the function
 Review the following files in the current folder:
 - `pom.xml` specifies all the dependencies for your function
 - `func.yaml` that contains metadata about your function and declares properties
 - `src/main/java/com/example/fn/ObjectStorageListObjects.java` which contains the Java code
 
-The name of your function *oci-objectstorage-list-objects* is specified in `func.yaml`.
+The name of your function *oci-objectstorage-list-objects-java* is specified in `func.yaml`.
 
 ## Deploy the function
 ![user input icon](../images/userinput.png)
@@ -156,10 +131,10 @@ Use the *fn* CLI to invoke your function with your own bucket name and app name:
 
 ![user input icon](../images/userinput.png)
 ```
-echo -n '<bucket_name>' | fn invoke <app_name> oci-objectstorage-list-objects
+echo -n '<bucket_name>' | fn invoke <app_name> <function_name>
 ```
 e.g.
 ```
-echo -n 'mybucket' | fn invoke object-crud oci-objectstorage-list-objects
+echo -n 'mybucket' | fn invoke object-crud oci-objectstorage-list-objects-java
 ```
 Upon success, you should see either a list of objects on your terminal.

oci-objectstorage-list-objects-java/func-jdk11.yaml

@@ -1,5 +1,5 @@
 schema_version: 20180708
-name: oci-objectstorage-list-objects
+name: oci-objectstorage-list-objects-java
 version: 0.0.1
 runtime: java
 build_image: fnproject/fn-java-fdk-build:jdk11-1.0.105

oci-objectstorage-list-objects-java/func-jdk8.yaml

@@ -1,5 +1,5 @@
 schema_version: 20180708
-name: oci-objectstorage-list-objects
+name: oci-objectstorage-list-objects-java
 version: 0.0.1
 runtime: java8
 build_image: fnproject/fn-java-fdk-build:1.0.98

oci-objectstorage-list-objects-java/func.yaml

@@ -1,5 +1,5 @@
 schema_version: 20180708
-name: oci-objectstorage-list-objects
+name: oci-objectstorage-list-objects-java
 version: 0.0.5
 runtime: java
 build_image: fnproject/fn-java-fdk-build:jdk11-1.0.105

oci-objectstorage-put-object-java/README.md

@@ -12,25 +12,27 @@ As you make your way through this tutorial, look out for this icon ![user input
 Whenever you see it, it's time for you to perform an action.
 
 
-## Pre-requisites
-1. Start by making sure all of your policies are correct from this [guide](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionscreatingpolicies.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Tenancy%20for%20Function%20Development%7C_____4)
+## Prerequisites
+![user input icon](./images/userinput.png)
 
-2. Have [Fn CLI setup with Oracle Functions](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionsconfiguringclient.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Client%20Environment%20for%20Function%20Development%7C_____0)
+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](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
+    * A - Set up your tenancy
+    * B - Create application
+    * C - Set up your Cloud Shell dev environment
 
-3. Have your Oracle Object Storage Namespace available. This can be found by
+2. Have your Oracle Object Storage Namespace available. This can be found by
 logging into your [cloud account](https://console.us-ashburn-1.oraclecloud.com/),
 under your user profile, click on your Tenancy. Your Object Storage Namespace
 is shown there.
 
 
-## Context
-Switch to the correct context
-
+## List Applications 
 ![user input icon](../images/userinput.png)
-```
-fn use context <your context name>
-```
-Check using
+
+Assuming your have successfully completed the prerequisites, you should see your 
+application in the list of applications.
+
 ```
 fn ls apps
 ```
@@ -43,25 +45,13 @@ click [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingd
 
 ![user input icon](../images/userinput.png)
 
-When specifying the *Matching Rules*, consider the following examples:
+When specifying the *Matching Rules*, consider the following example:
 * If you want all functions in a compartment to be able to access a resource,
 enter a rule similar to the following that adds all functions in the compartment
 with the specified compartment OCID to the dynamic group:
 ```
 ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}
 ```
-* If you want a specific function to be able to access a resource, enter a rule
-similar to the following that adds the function with the specified OCID to the
-dynamic group:
-```
-resource.id = 'ocid1.fnfunc.oc1.iad.aaaaaaaaacq______dnya'
-```
-* If you want all functions with a specific defined tag (free-form tags are
-not supported) to be able to access a resource, enter a rule similar to the
-following that adds all functions with the defined tag to the dynamic group :
-```
-ALL {resource.type = 'fnfunc', tag.department.operations.value = '45'}
-```
 
 
 ## Create or Update Policies
@@ -82,30 +72,13 @@ Allow dynamic-group demo-func-dyn-group to manage object-family in compartment d
 For more information on how to create policies, go [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
 
 
-## Create an Application to run the function
-You can use an application already created or create a new one as follows:
-
-![user input icon](../images/userinput.png)
-```
-fn create app <app-name> --annotation oracle.com/oci/subnetIds='["<subnet-ocid>"]
-```
-You can find the subnet-ocid by logging on to [cloud.oracle.com](https://cloud.oracle.com/en_US/sign-in),
-navigating to Core Infrastructure > Networking > Virtual Cloud Networks. Make
-sure you are in the correct Region and Compartment, click on your VNC and
-select the subnet you wish to use.
-e.g.
-```
-fn create app object-crud --annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx.aaaaaaaacnh..."]'
-```
-
-
 ## Review the function
 Review the following files in the current folder:
 - [pom.xml](./pom.xml) specifies all the dependencies for your function
 - [func.yaml](./func.yaml) that contains metadata about your function and declares properties
 - [src/main/java/com/example/fn/ObjectStoragePutObject.java](./src/main/java/com/example/fn/ObjectStoragePutObject.java) which contains the Java code
 
-The name of your function *oci-objectstorage-put-object* is specified in [func.yaml](./func.yaml).
+The name of your function *oci-objectstorage-put-object-java* is specified in [func.yaml](./func.yaml).
 
 
 ## Deploy the function
@@ -148,10 +121,10 @@ Use the *fn* CLI to invoke your function with your own bucket name and app name:
 
 ![user input icon](../images/userinput.png)
 ```
-echo -n '{"name": "<object_name>", "bucketName":"<bucket_name>", "content": "<text_content>"}' | fn invoke <your app> oci-objectstorage-put-object
+echo -n '{"name": "<object_name>", "bucketName":"<bucket_name>", "content": "<text_content>"}' | fn invoke <app_name> <function_name>
 ```
 e.g.
 ```
-echo -n '{"name": "file1.txt", "bucketName":"test", "content": "This file was created in OCI object storage bucket using Oracle Functions"}' | fn invoke object-crud oci-objectstorage-put-object
+echo -n '{"name": "file1.txt", "bucketName":"test", "content": "This file was created in OCI object storage bucket using Oracle Functions"}' | fn invoke object-crud oci-objectstorage-put-object-java
 ```
 Upon success, you should see a success message appear in your terminal.

oci-objectstorage-put-object-java/func.yaml

@@ -1,5 +1,5 @@
 schema_version: 20180708
-name: oci-objectstorage-put-object
+name: oci-objectstorage-put-object-java
 version: 0.0.1
 runtime: java
 build_image: fnproject/fn-java-fdk-build:jdk11-1.0.105