You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,9 @@ For a deep dive into the project, refer to the Spring Cloud OCI documentation:
26
26
27
27
This project has dependency and transitive dependencies on Spring Projects. The table below outlines the versions of Spring Cloud, Spring Boot and Spring Framework versions that are compatible with certain Spring Cloud OCI version.
28
28
29
-
| Spring Cloud OCI | Spring Cloud | Spring Boot | OCI Java SDK |
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/core.adoc
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,22 +27,22 @@ dependencies {
27
27
28
28
=== Authentication Configuration
29
29
30
-
Spring Cloud OCI allows you to authenticate with OCI with various following available options.
30
+
Spring Cloud OCI allows you to authenticate with OCI using various available options.
31
31
32
-
==== Config File Based Authentication
32
+
==== Configuration File Based Authentication
33
33
34
-
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.
34
+
By default, configuration file based authentication is enabled. To set it explicitly, set the property `spring.cloud.oci.config.type` to `FILE`. The following are optional configurations to set a custom configuration profile name and file name.
35
35
36
36
----
37
37
spring.cloud.oci.config.profile = DEFAULT
38
38
spring.cloud.oci.config.file = <FILE_PATH>
39
39
----
40
40
41
-
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]
41
+
For further details about the Authentication configuration file, refer https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm[SDK and CLI Configuration File]
42
42
43
43
==== Simple Authentication
44
44
45
-
Set the property spring.cloud.oci.config.type to `SIMPLE` and add below properties:
45
+
Set the property `spring.cloud.oci.config.type` to `SIMPLE` and add the following properties:
Note: All the above properties are mandatory except spring.cloud.oci.config.passPhrase
56
+
Note: All the preceding properties are mandatory except `spring.cloud.oci.config.passPhrase`
57
57
58
58
==== Instance Principal Configuration
59
59
60
-
Set the config.type to `INSTANCE_PRINCIPAL` as below.
60
+
Set the config.type to `INSTANCE_PRINCIPAL` as shown here.
61
61
62
62
----
63
63
spring.cloud.oci.config.type = INSTANCE_PRINCIPAL
64
64
----
65
-
For further details refer https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[OCI Instance Principal Authentication]
65
+
For further details, refer to https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[OCI Instance Principal Authentication]
66
66
67
67
==== Resource Principal Configuration
68
68
69
-
Set the config.type to `RESOURCE_PRINCIPAL` as below.
69
+
Set the config.type to `RESOURCE_PRINCIPAL` as shown here.
70
70
71
71
----
72
72
spring.cloud.oci.config.type = RESOURCE_PRINCIPAL
73
73
----
74
74
75
-
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]
75
+
For further details, refer to 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]
76
76
77
77
=== Region Configuration
78
78
79
-
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.
79
+
OCI services are available in different regions. Based on the custom requirements, you can host the application on different OCI regions. The following configuration allows you to set a specific region for the entire application.
80
80
81
81
----
82
82
spring.cloud.oci.region.static = us-ashburn-1
83
83
----
84
84
85
-
Region value set in the above property takes precedence over the property `spring.cloud.oci.config.region` and `region` from the Authentication config file
85
+
Region value set in the preceding property takes precedence over the property `spring.cloud.oci.config.region` and `region` from the Authentication configuration file
86
86
87
87
=== Compartment Configuration
88
88
89
-
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.
89
+
A compartment is a logical container, used to organize and control access to the OCI Resources (Compute, Storage, Network, Load Balancer, etc.) created within that compartment. The following configuration allows you to set the default compartment for your application.
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/getting-started.adoc
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,11 @@
3
3
4
4
== Getting Started
5
5
6
-
This section describes how to get up to speed with Spring Cloud OCI libraries.
6
+
This section describes how to get started using Spring Cloud OCI libraries.
7
7
8
-
=== Spring Cloud OCI maven dependency management
8
+
=== Spring Cloud OCI
9
9
10
-
Spring Cloud OCI module dependencies can be used directly in Maven with a direct configuration of the particular module. The Spring Cloud OCI module includes all transitive dependencies for the Spring modules and also the OCI SDK that are needed to operate the modules. The general dependency configuration will look like this:
10
+
Spring Cloud OCI module dependencies can be used directly in Maven with a direct configuration of the module. The Spring Cloud OCI module includes all transitive dependencies for the Spring modules, and the OCI SDK that are needed to operate the modules. The general dependency configuration will look like this:
11
11
12
12
----
13
13
<dependencies>
@@ -19,20 +19,20 @@ Spring Cloud OCI module dependencies can be used directly in Maven with a direct
19
19
</dependencies>
20
20
----
21
21
22
-
Different modules can be included by replacing the module name with the respective one (e.g. `spring-cloud-oci-starter-storage` instead of `spring-cloud-oci-starter`)
22
+
Different modules can be included by replacing the module name with the respective one (for example, `spring-cloud-oci-starter-storage` instead of `spring-cloud-oci-starter`)
23
23
24
24
==== Starter Dependencies
25
25
26
26
Spring Cloud OCI offers https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-starters[starter dependencies] through Maven to easily depend on different modules of the library.
27
27
Each starter contains all the dependencies and transitive dependencies needed to begin using their corresponding Spring Cloud OCI module.
28
28
29
-
For example, if you wish to write a Spring application with Cloud Storage, you would include the `spring-cloud-oci-starter-storage` dependency in your project.
29
+
For example, to write a Spring application with Cloud Storage, you include the `spring-cloud-oci-starter-storage` dependency in your project.
30
30
You do *not* need to include the underlying `spring-cloud-oci-storage` dependency, because the `starter` dependency includes it.
31
31
32
-
A summary of these artifacts are provided below.
32
+
A summary of these artifacts is provided here.
33
33
34
34
|===
35
-
| Spring Cloud OCI Starter | Description | Maven Artifact Name
35
+
^| Spring Cloud OCI Starter ^| Description ^| Maven Artifact Name
36
36
37
37
| Core
38
38
| Automatically configure authentication
@@ -53,10 +53,10 @@ There are a variety of resources to help you learn how to use Spring Cloud OCI l
53
53
54
54
The easiest way to learn how to use Spring Cloud OCI is to consult the https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples[sample applications on Github].
55
55
Spring Cloud OCI provides sample applications which demonstrate how to use every integration in the library.
56
-
The table below highlights several samples of the most commonly used integrations in Spring Cloud OCI.
56
+
The following table highlights several samples of the most used integrations in Spring Cloud OCI.
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/index.adoc
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,9 @@ include::_attributes.adoc[]
10
10
11
11
== Introduction
12
12
13
-
Spring Cloud for OCI, part of the Spring Cloud umbrella project, eases the integration with hosted OCI Services. It offers a convenient way to interact with OCI provided services using well-known Spring idioms and APIs, such as storage resources. Developers can build their application around the hosted services without having to care about infrastructure or maintenance.
13
+
Spring Cloud for OCI, part of the Spring Cloud umbrella project, eases the integration with hosted OCI Services. It offers a convenient way to interact with OCI provided services using well-known Spring idioms and APIs, such as storage resources. Developers can build their application around the hosted services without having to worry about infrastructure or maintenance.
14
14
15
-
Spring Cloud OCI lets you leverage the power and simplicity of the Spring Framework to:
16
-
17
-
- Read and write from Spring Resources backed up by Oracle Cloud Storage
15
+
Spring Cloud OCI lets you leverage the power and simplicity of the Spring Framework to read and write from Spring Resources backed up by Oracle Cloud Storage
18
16
19
17
include::getting-started.adoc[]
20
18
@@ -28,14 +26,14 @@ include::logging.adoc[]
28
26
29
27
== Configuration properties
30
28
31
-
To see the list of all OCIrelated configuration properties please check link:appendix.html[the Appendix page].
29
+
To see the list of all OCI-related configuration properties see the link:appendix.html[Appendix page].
32
30
33
31
=== Configuration Refresh
34
32
35
33
The following properties are supported for Configuration auto-refresh at runtime without the need to restart applications
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/logging.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[#cloud-logging]
5
5
== Cloud Logging
6
6
7
-
https://docs.oracle.com/en-us/iaas/Content/Logging/home.htm/[Oracle Cloud Infrastructure (OCI) Logging] service is a highly scalable and fully managed single pane of glass for all the logs in your tenancy. Logging provides access to logs from Oracle Cloud Infrastructure resources. These logs include critical diagnostic information that describes how resources are performing and being accessed. Use Logging to enable, manage, and search Audit, Service and Custom logs. The Spring Cloud module for OCI Logging allows ingesting logs associated with a logId.
7
+
https://docs.oracle.com/en-us/iaas/Content/Logging/home.htm/[OCI Logging] service is a highly scalable and fully managed single pane of glass for all the logs in your tenancy. Logging provides access to logs from OCI resources. These logs include critical diagnostic information that describes how resources are performing and being accessed. Use Logging to enable, manage, and search Audit, Service, and Custom logs. The Spring Cloud module for OCI Logging allows ingesting logs associated with a logId.
8
8
A Spring Boot starter is provided to auto-configure the Logging component.
9
9
10
10
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
29
29
=== Using Cloud Logging
30
30
31
31
The starter automatically configures and registers a `Logging` bean in the Spring application context.
32
-
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
32
+
The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a logId specified in the property `spring.cloud.oci.logging.logId` within the application configuration file
33
33
34
34
[source,java]
35
35
----
@@ -48,11 +48,11 @@ public void putLog() {
48
48
The Spring Boot Starter for Oracle Cloud Logging provides the following configuration options:
49
49
50
50
|===
51
-
| Name | Description | Required | Default value
51
+
^| Name ^| Description ^| Required ^| Default value
52
52
| `spring.cloud.oci.logging.enabled` | Enables the OCI Logging APIs. | No | `true`
53
53
|===
54
54
55
55
56
56
=== Sample
57
57
58
-
A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-logging-sample[sample application] is available.
58
+
A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-logging-sample[here] contains the examples to demonstrates the usage of OCI Spring Cloud Logging module.
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/notifications.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[#cloud-notifications]
5
5
== Cloud Notifications
6
6
7
-
https://www.oracle.com/in/devops/notifications/[Oracle Cloud Infrastructure (OCI) Notifications] is a highly available, low-latency publish/subscribe (pub/sub) service that sends alerts and messages to Oracle Cloud Functions, email, SMS, and message delivery partners, including Slack, PagerDuty and custom HTTPS endpoint. Spring Cloud module for Oracle Cloud Notifications allows to create a Topic and create and publish messages to multiple subsctiption types like Oracle Cloud Functions, email, SMS, Slack, PagerDuty and custom HTTPS endpoint.
7
+
https://www.oracle.com/in/devops/notifications/[OCI Notifications] is a highly available, lowlatency publish/subscribe (pub/sub) service that sends alerts and messages to Oracle Cloud Functions, email, SMS, and message delivery partners, including Slack, PagerDuty and custom HTTPS endpoint. Spring Cloud module for Oracle Cloud Notifications allows you to create a Topic, then create and publish messages to multiple subscription types such as Oracle Cloud Functions, email, SMS, Slack, PagerDuty and custom HTTPS endpoint.
8
8
A Spring Boot starter is provided to auto-configure the various Notification components.
9
9
10
10
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
29
29
=== Using Cloud Notifications
30
30
31
31
The starter automatically configures and registers a `Notification` bean in the Spring application context.
32
-
The `Notification` bean (link[Javadoc]) can be used to create Topic, create/list/get Subscription and publish message to the Subscriptions in a Topic.
32
+
The `Notification` bean (link[Javadoc]) can be used to create a Topic, create, list, get a Subscription, and publish messages to the Subscriptions in a Topic.
33
33
34
34
[source,java]
35
35
----
@@ -48,11 +48,11 @@ public void createTopic() {
48
48
The Spring Boot Starter for Oracle Cloud Notifications provides the following configuration options:
49
49
50
50
|===
51
-
| Name | Description | Required | Default value
51
+
^| Name ^| Description ^| Required ^| Default value
52
52
| `spring.cloud.oci.notification.enabled` | Enables the OCI Notifications APIs. | No | `true`
53
53
|===
54
54
55
55
56
56
=== Sample
57
57
58
-
A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-notification-sample[sample application] is available.
58
+
A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-notification-sample[here] contains the examples to demonstrates the usage of OCI Spring Cloud Notification module.
Copy file name to clipboardExpand all lines: docs/src/main/asciidoc/storage.adoc
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[#cloud-storage]
5
5
== Cloud Storage
6
6
7
-
https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows storing any types of files.
7
+
https://www.oracle.com/in/cloud/storage/[Oracle Cloud Storage] allows you to store any types of file.
8
8
A Spring Boot starter is provided to auto-configure the various Storage components.
9
9
10
10
Maven coordinates, using <<getting-started.adoc#bill-of-materials, Spring Cloud OCI BOM>>:
@@ -29,7 +29,7 @@ dependencies {
29
29
=== Using Cloud Storage
30
30
31
31
The starter automatically configures and registers a `Storage` bean in the Spring application context.
32
-
The `Storage` bean (link[Javadoc]) can be used to list/create/update/delete buckets and objects.
32
+
The `Storage` bean (link[Javadoc]) can be used to list, create, update or delete buckets and objects.
33
33
34
34
[source,java]
35
35
----
@@ -43,27 +43,24 @@ public void createBucketAndUploadFile() {
43
43
}
44
44
----
45
45
46
-
=== Cloud Storage Objects As Spring Resources
46
+
=== Cloud Storage Objects Spring Resources
47
47
48
-
https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html[Spring Resources] are an abstraction for a number of low-level resources, such as file system files, classpath files, servlet context-relative files, etc.
49
-
Spring Cloud OCI adds a new resource type: a Oracle Cloud Storage (OCS) object.
48
+
https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html[Spring Resources] are an abstraction for several low-level resources, such as file system files, classpath files, servlet context-relative files, etc.
49
+
Spring Cloud OCI adds a new resource type: an Oracle Cloud Storage (OCS) object.
50
50
51
-
The Spring Resource Abstraction for Oracle Cloud Storage allows OCS objects to be accessed by their OCS URL using the `@Value` annotation:
51
+
The Spring Resource Abstraction for Oracle Cloud Storage allows OCS objects to be accessed by their OCS URL using the `@Value` annotation or the Spring application context:
This creates a `Resource` object that can be used to read the object, among https://docs.spring.io/spring/docs/current/spring-framework-reference/html/resources.html#resources-resource[other possible operations].
68
65
69
66
Currently this resource is only readable.
@@ -73,11 +70,11 @@ Currently this resource is only readable.
73
70
The Spring Boot Starter for Oracle Cloud Storage provides the following configuration options:
74
71
75
72
|===
76
-
| Name | Description | Required | Default value
73
+
^| Name ^| Description ^| Required ^| Default value
77
74
| `spring.cloud.oci.storage.enabled` | Enables the OCI storage APIs. | No | `true`
78
75
|===
79
76
80
77
81
78
=== Sample
82
79
83
-
A https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-storage-sample[sample application] is available.
80
+
A sample application provided https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-storage-sample[here] contains the examples to demonstrate the usage of OCI Spring Cloud Storage module.
0 commit comments