Merge pull request #21 from oracle/topic_syncdocs

incorporate document reviews

Author: jitendrazkumar

THIRD_PARTY_LICENSES.txt

@@ -4,19 +4,19 @@
 |===
 |Name | Default | Description
 
-|spring.cloud.oci.config.profile | `DEFAULT` |  
-|spring.cloud.oci.config.file |  |  
-|spring.cloud.oci.config.type |  |
-|spring.cloud.oci.config.userId |  |  
-|spring.cloud.oci.config.tenantId |  |  
-|spring.cloud.oci.config.fingerprint |  |  
-|spring.cloud.oci.config.privateKey |  |  
-|spring.cloud.oci.config.passPhrase |  |
-|spring.cloud.oci.config.region |  |
-|spring.cloud.oci.region.static |  |
-|spring.cloud.oci.compartment.static |  |
-|spring.cloud.oci.storage.enabled | `true` |
-|spring.cloud.oci.notification.enabled | `true` |
-|spring.cloud.oci.logging.enabled | `true` |
+|spring.cloud.oci.config.profile | `DEFAULT` | Name of the profile in OCI Auth config file
+|spring.cloud.oci.config.file | NA | Location of the OCI Auth config file
+|spring.cloud.oci.config.type | FILE | Config/Auth type to be used. Allowed values are FILE, SIMPLE, INSTANCE_PRINCIPAL and RESOURCE_PRINCIPAL
+|spring.cloud.oci.config.userId | NA | OCID of the user used for creating the API key. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.config.tenantId | NA | Tenancy OCID where the API key is created. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.config.fingerprint | NA | Fingerprint for the public key that was added to the user mentioned in `spring.cloud.oci.config.userId`. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.config.privateKey | NA | Full path and filename of the private key used for generating the `spring.cloud.oci.config.fingerprint`. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.config.passPhrase | NA | Passphrase used for `spring.cloud.oci.config.privateKey`, if it is encrypted. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.config.region | NA | An OCI region which will be used for Authentication. This is needed only if spring.cloud.oci.config.type is `SIMPLE`
+|spring.cloud.oci.region.static | NA | An OCI region which will be used for making API calls. This will take precedence over `spring.cloud.oci.config.region`
+|spring.cloud.oci.compartment.static | NA | Default OCI Compartment OCID
+|spring.cloud.oci.storage.enabled | `true` | Flag to enable the OCI Spring Cloud Storage module
+|spring.cloud.oci.notification.enabled | `true` | Flag to enable the OCI Spring Cloud Notification module
+|spring.cloud.oci.logging.enabled | `true` | Flag to enable the OCI Spring Cloud Logging module
 
 |===

docs/src/main/asciidoc/_configprops.adoc

@@ -31,27 +31,29 @@ Spring Cloud OCI allows you to authenticate with OCI with various following avai
 
 ==== Config File Based Authentication
 
-By default config file based authentication is enabled. There are below optional configuration to choose custom config profile name and config file name.
+By default config file based authentication is enabled, to set it explicitly set the property spring.cloud.oci.config.type to `FILE`. There are below optional configuration to choose custom config profile name and config file name.
 
 ----
 spring.cloud.oci.config.profile = DEFAULT
 spring.cloud.oci.config.file = <FILE_PATH>
 ----
 
+For further details about the Authentication config file refer https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm[SDK and CLI Configuration File]
+
 ==== Simple Authentication
 
-Set the config.type to `SIMPLE` and set related required properties as below. All the below properties are mandatory.
+Set the property spring.cloud.oci.config.type to `SIMPLE` and add below properties:
 
 ----
 spring.cloud.oci.config.type = SIMPLE
-spring.cloud.oci.config.userId = <USER_ID>
-spring.cloud.oci.config.tenantId = <TENANT_ID>
+spring.cloud.oci.config.userId = ocid1.user.oc1..<unique_ID>
+spring.cloud.oci.config.tenantId = ocid1.tenancy.oc1..<unique_ID>
 spring.cloud.oci.config.fingerprint = <FINGERPRINT>
 spring.cloud.oci.config.privateKey = <PRIVATE_KEY_FILE_PATH>
 spring.cloud.oci.config.passPhrase = <PASS_PHRASE>
 spring.cloud.oci.config.region = <REGION>
 ----
-Note: spring.cloud.oci.config.passPhrase is optional
+Note: All the above properties are mandatory except spring.cloud.oci.config.passPhrase
 
 ==== Instance Principal Configuration
 
@@ -60,6 +62,7 @@ Set the config.type to `INSTANCE_PRINCIPAL` as below.
 ----
 spring.cloud.oci.config.type = INSTANCE_PRINCIPAL
 ----
+For further details refer https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[OCI Instance Principal Authentication]
 
 ==== Resource Principal Configuration
 
@@ -69,6 +72,8 @@ Set the config.type to `RESOURCE_PRINCIPAL` as below.
 spring.cloud.oci.config.type = RESOURCE_PRINCIPAL
 ----
 
+For further details refer https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal[OCI Resource Principal Authentication]
+
 === Region Configuration
 
 OCI services are available in different regions. Based on the custom requirements, the user can host the application on different OCI regions. The below configuration allows to set specific region for the entire application.
@@ -77,6 +82,8 @@ OCI services are available in different regions. Based on the custom requirement
 spring.cloud.oci.region.static = us-ashburn-1
 ----
 
+Region value set in the above property takes precedence over the property `spring.cloud.oci.config.region` and `region` from the Authentication config file
+
 === Compartment Configuration
 
 A compartment is a logical container, to organize and control access to the Oracle Cloud Infrastructure (OCI) Resources (Compute, Storage, Network, Load Balancer, etc) created within that compartment. Below configuration allows you to set default compartment for your application.

docs/src/main/asciidoc/core.adoc

@@ -29,7 +29,7 @@ dependencies {
 === Using Cloud Logging
 
 The starter automatically configures and registers a `Logging` bean in the Spring application context.
-The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId.
+The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId set in the property `spring.cloud.oci.logging.logId` in the application configuration file
 
 [source,java]
 ----

docs/src/main/asciidoc/logging.adoc

@@ -4,7 +4,7 @@
 [#cloud-storage]
 == Cloud Storage
 
-https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows storing any types of files in single or multiple regions.
+https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows storing any types of files.
 A Spring Boot starter is provided to auto-configure the various Storage components.
 
 Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -36,7 +36,7 @@ The `Storage` bean (link[Javadoc]) can be used to list/create/update/delete buck
 @Autowired
 private Storage storage;
 
-public void createFile() {
+public void createBucketAndUploadFile() {
     Bucket bucket = storage.createBucket("my-bucket")
 
     storage.upload("my-bucket", "my-file.txt", inputStream, StorageObjectMetadata.builder().contentType("text/plain").build());

docs/src/main/asciidoc/storage.adoc

@@ -56,10 +56,6 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
             <artifactId>spring-boot-autoconfigure-processor</artifactId>
             <optional>true</optional>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
@@ -69,10 +65,6 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
             <artifactId>spring-boot-actuator-autoconfigure</artifactId>
             <optional>true</optional>
         </dependency>
-        <dependency>
-            <groupId>com.oracle.oci.sdk</groupId>
-            <artifactId>oci-java-sdk-common</artifactId>
-        </dependency>
         <dependency>
             <groupId>com.oracle.cloud.spring</groupId>
             <artifactId>spring-cloud-oci-core</artifactId>
@@ -92,30 +84,9 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
             <artifactId>spring-cloud-oci-logging</artifactId>
             <optional>true</optional>
         </dependency>
-        <dependency>
-            <groupId>com.oracle.oci.sdk</groupId>
-            <artifactId>oci-java-sdk-ons</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>com.oracle.oci.sdk</groupId>
-            <artifactId>oci-java-sdk-objectstorage</artifactId>
-        </dependency>
         <dependency>
             <groupId>com.oracle.oci.sdk</groupId>
             <artifactId>oci-java-sdk-common-httpclient-jersey3</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-            <optional>true</optional>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-webmvc</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>javax.servlet</groupId>
-            <artifactId>javax.servlet-api</artifactId>
-        </dependency>
     </dependencies>
-</project>
+</project>