Skip to content

Commit c573416

Browse files
andytaelandytael
committed
110refdoc
1 parent b527838 commit c573416

35 files changed

+9789
-0
lines changed

‎1.1.0/reference/html/Guardfile

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Copyright (c) 2023, Oracle and/or its affiliates.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
3+
4+
require 'asciidoctor'
5+
require 'erb'
6+
7+
guard 'shell' do
8+
watch(/.*\.adoc$/) {|m|
9+
Asciidoctor.render_file('index.adoc', \
10+
:in_place => true, \
11+
:safe => Asciidoctor::SafeMode::UNSAFE, \
12+
:attributes=> { \
13+
'source-highlighter' => 'prettify', \
14+
'icons' => 'font', \
15+
'linkcss'=> 'true', \
16+
'copycss' => 'true', \
17+
'doctype' => 'book'})
18+
}
19+
end
20+
21+
guard 'livereload' do
22+
watch(%r{^.+\.(css|js|html)$})
23+
end

‎1.1.0/reference/html/adb.html

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="generator" content="Asciidoctor 2.0.23">
8+
<title>Autonomous Database</title>
9+
<link rel="stylesheet" href="css/site.css">
10+
<script src="js/setup.js"></script><script defer src="js/site.js"></script>
11+
12+
</head>
13+
<body class="article toc2 toc-left"><div id="banner-container" class="container" role="banner">
14+
<div id="banner" class="contained" role="banner">
15+
<div id="switch-theme">
16+
<input type="checkbox" id="switch-theme-checkbox" />
17+
<label for="switch-theme-checkbox">Dark Theme</label>
18+
</div>
19+
</div>
20+
</div>
21+
<div id="tocbar-container" class="container" role="navigation">
22+
<div id="tocbar" class="contained" role="navigation">
23+
<button id="toggle-toc"></button>
24+
</div>
25+
</div>
26+
<div id="main-container" class="container">
27+
<div id="main" class="contained">
28+
<div id="doc" class="doc">
29+
<div id="header">
30+
<div id="toc" class="toc2">
31+
<div id="toctitle">Table of Contents</div>
32+
<span id="back-to-index"><a href="index.html">Back to index</a></span><ul class="sectlevel1">
33+
<li><a href="#autonomous-database">Autonomous Database</a>
34+
<ul class="sectlevel2">
35+
<li><a href="#using-autonomous-database">Using Autonomous Database</a></li>
36+
<li><a href="#configuration">Configuration</a></li>
37+
<li><a href="#sample">Sample</a></li>
38+
</ul>
39+
</li>
40+
</ul>
41+
</div>
42+
</div>
43+
<div id="content">
44+
<div class="sect1">
45+
<h2 id="autonomous-database"><a class="anchor" href="#autonomous-database"></a>Autonomous Database</h2>
46+
<div class="sectionbody">
47+
<div class="paragraph">
48+
<p><a href="https://docs.oracle.com/en/cloud/paas/atp-cloud/index.html">Autonomous Database</a> is a data management service built
49+
on self-driving Oracle Autonomous Database technology to deliver automated patching, upgrades, and tuning, including
50+
performing all routine database maintenance tasks while the system is running, without human intervention.</p>
51+
</div>
52+
<div class="paragraph">
53+
<p>Maven coordinates, using <a href="getting-started.html#bill-of-materials">Spring Cloud OCI BOM</a>:</p>
54+
</div>
55+
<div class="listingblock">
56+
<div class="content">
57+
<pre class="highlight"><code class="language-xml" data-lang="xml"><span class="nt">&lt;dependency&gt;</span>
58+
<span class="nt">&lt;groupId&gt;</span>com.oracle.cloud.spring<span class="nt">&lt;/groupId&gt;</span>
59+
<span class="nt">&lt;artifactId&gt;</span>spring-cloud-oci-starter-adb<span class="nt">&lt;/artifactId&gt;</span>
60+
<span class="nt">&lt;/dependency&gt;</span></code></pre>
61+
</div>
62+
</div>
63+
<div class="paragraph">
64+
<p>Gradle coordinates:</p>
65+
</div>
66+
<div class="listingblock">
67+
<div class="content">
68+
<pre class="highlight"><code>dependencies {
69+
implementation("com.oracle.cloud.spring:spring-cloud-oci-starter-adb")
70+
}</code></pre>
71+
</div>
72+
</div>
73+
<div class="sect2">
74+
<h3 id="using-autonomous-database"><a class="anchor" href="#using-autonomous-database"></a>Using Autonomous Database</h3>
75+
<div class="paragraph">
76+
<p>The starter automatically configures and registers an <code>AutonomousDb</code> bean in the Spring application context.
77+
The <code>AutonomousDb</code> bean (link[Javadoc]) can be used to create an Autonomous Database, get details of an Autonomous Database,
78+
delete an Autonomous Database and generate a wallet for an Autonomous Database.</p>
79+
</div>
80+
<div class="listingblock">
81+
<div class="content">
82+
<pre class="highlight"><code class="language-java" data-lang="java"><span class="nd">@Autowired</span>
83+
<span class="kd">private</span> <span class="nc">Queue</span> <span class="n">queue</span><span class="o">;</span>
84+
85+
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">createQueue</span><span class="o">()</span> <span class="o">{</span>
86+
87+
<span class="nc">String</span> <span class="n">queueId</span> <span class="o">=</span> <span class="n">queue</span><span class="o">.</span><span class="na">createQueue</span><span class="o">(</span><span class="s">"my-queue"</span><span class="o">,</span> <span class="o">&lt;&lt;</span><span class="n">compartmentId</span><span class="o">&gt;&gt;,</span> <span class="o">&lt;&lt;</span><span class="n">deadLetterQueueDeliveryCount</span><span class="o">&gt;&gt;,</span> <span class="o">&lt;&lt;</span><span class="n">retentionInSeconds</span><span class="o">&gt;&gt;);</span>
88+
<span class="o">}</span>
89+
<span class="nd">@Autowired</span>
90+
<span class="nc">AutonomousDb</span> <span class="n">autonomousDatabase</span><span class="o">;</span>
91+
92+
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">createAutonomousDatabase</span><span class="o">()</span> <span class="o">{</span>
93+
<span class="n">autonomousDatabase</span><span class="o">.</span><span class="na">createAutonomousDatabase</span><span class="o">(</span>
94+
<span class="n">databaseName</span><span class="o">,</span> <span class="n">compartmentId</span><span class="o">,</span> <span class="n">adminPassword</span><span class="o">,</span> <span class="n">dataStorageSizeInGBs</span><span class="o">,</span> <span class="n">computeCount</span><span class="o">);</span>
95+
<span class="o">}</span>
96+
97+
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">getAutonomousDatabase</span><span class="o">()</span> <span class="o">{</span>
98+
<span class="nc">AutonomousDbDetails</span> <span class="n">response</span> <span class="o">=</span> <span class="n">autonomousDatabase</span><span class="o">.</span><span class="na">getAutonomousDatabase</span><span class="o">(</span><span class="n">databaseId</span><span class="o">);</span>
99+
<span class="o">}</span>
100+
101+
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">getAutonomousDatabaseWallet</span><span class="o">()</span> <span class="o">{</span>
102+
<span class="nc">GenerateAutonomousDatabaseWalletResponse</span> <span class="n">response</span> <span class="o">=</span> <span class="n">autonomousDatabase</span><span class="o">.</span><span class="na">generateAutonomousDatabaseWallet</span><span class="o">(</span><span class="n">databaseId</span><span class="o">,</span> <span class="n">password</span><span class="o">);</span>
103+
<span class="nc">InputStream</span> <span class="n">is</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">();</span>
104+
<span class="kt">int</span> <span class="nc">ContentLength</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="na">getContentLength</span><span class="o">();</span>
105+
<span class="c1">// read the InputStream to get the wallet</span>
106+
<span class="o">}</span>
107+
108+
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">deleteAutonomousDatabase</span><span class="o">()</span> <span class="o">{</span>
109+
<span class="nc">DeleteAutonomousDatabaseResponse</span> <span class="n">response</span> <span class="o">=</span> <span class="n">autonomousDatabase</span><span class="o">.</span><span class="na">deleteAutonomousDatabase</span><span class="o">(</span><span class="n">databaseId</span><span class="o">);</span>
110+
<span class="o">}</span>
111+
</code></pre>
112+
</div>
113+
</div>
114+
</div>
115+
<div class="sect2">
116+
<h3 id="configuration"><a class="anchor" href="#configuration"></a>Configuration</h3>
117+
<div class="paragraph">
118+
<p>The Spring Boot Starter for Oracle Autonomous Database provides the following configuration options:</p>
119+
</div>
120+
<table class="tableblock frame-all grid-all stretch">
121+
<colgroup>
122+
<col style="width: 25%;">
123+
<col style="width: 25%;">
124+
<col style="width: 25%;">
125+
<col style="width: 25%;">
126+
</colgroup>
127+
<tbody>
128+
<tr>
129+
<td class="tableblock halign-center valign-top"><p class="tableblock">Name</p></td>
130+
<td class="tableblock halign-center valign-top"><p class="tableblock">Description</p></td>
131+
<td class="tableblock halign-center valign-top"><p class="tableblock">Required</p></td>
132+
<td class="tableblock halign-center valign-top"><p class="tableblock">Default value</p></td>
133+
</tr>
134+
<tr>
135+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spring.cloud.oci.adb.enabled</code></p></td>
136+
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables the OCI Autonomous Database APIs.</p></td>
137+
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
138+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
139+
</tr>
140+
</tbody>
141+
</table>
142+
</div>
143+
<div class="sect2">
144+
<h3 id="sample"><a class="anchor" href="#sample"></a>Sample</h3>
145+
<div class="paragraph">
146+
<p>A sample application provided <a href="https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-adb-sample">here</a> contains the examples to demonstrates the usage of OCI Spring Cloud Autonomous Database module.</p>
147+
</div>
148+
</div>
149+
</div>
150+
</div>
151+
</div>
152+
<div id="footer">
153+
<div id="footer-text">
154+
Last updated 2024-07-15 10:41:20 -0500
155+
</div>
156+
</div>
157+
</div>
158+
</div>
159+
</div>
160+
</body>
161+
</html>

‎1.1.0/reference/html/appendix.html

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="generator" content="Asciidoctor 2.0.23">
8+
<title>Common application properties</title>
9+
<link rel="stylesheet" href="css/site.css">
10+
<script src="js/setup.js"></script><script defer src="js/site.js"></script>
11+
12+
</head>
13+
<body class="article toc2 toc-left"><div id="banner-container" class="container" role="banner">
14+
<div id="banner" class="contained" role="banner">
15+
<div id="switch-theme">
16+
<input type="checkbox" id="switch-theme-checkbox" />
17+
<label for="switch-theme-checkbox">Dark Theme</label>
18+
</div>
19+
</div>
20+
</div>
21+
<div id="tocbar-container" class="container" role="navigation">
22+
<div id="tocbar" class="contained" role="navigation">
23+
<button id="toggle-toc"></button>
24+
</div>
25+
</div>
26+
<div id="main-container" class="container">
27+
<div id="main" class="contained">
28+
<div id="doc" class="doc">
29+
<div id="header">
30+
<div id="toc" class="toc2">
31+
<div id="toctitle">Table of Contents</div>
32+
<span id="back-to-index"><a href="index.html">Back to index</a></span><ul class="sectlevel1">
33+
<li><a href="#common-application-properties">Appendix A: Common application properties</a></li>
34+
</ul>
35+
</div>
36+
</div>
37+
<div id="content">
38+
<div class="sect1">
39+
<h2 id="common-application-properties"><a class="anchor" href="#common-application-properties"></a>Appendix A: Common application properties</h2>
40+
<div class="sectionbody">
41+
<div class="paragraph">
42+
<p>Various properties can be specified inside your <code>application.properties</code> file, inside your <code>application.yml</code> file, or as command line switches.
43+
This appendix provides a list of common Spring Cloud OCI properties and references to the underlying classes that consume them.</p>
44+
</div>
45+
<div class="admonitionblock note">
46+
<table>
47+
<tr>
48+
<td class="icon">
49+
<i class="fa icon-note" title="Note"></i>
50+
</td>
51+
<td class="content">
52+
Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list.
53+
Also, you can define your own properties.
54+
</td>
55+
</tr>
56+
</table>
57+
</div>
58+
<table class="tableblock frame-all grid-all stretch">
59+
<colgroup>
60+
<col style="width: 33.3333%;">
61+
<col style="width: 33.3333%;">
62+
<col style="width: 33.3334%;">
63+
</colgroup>
64+
<thead>
65+
<tr>
66+
<th class="tableblock halign-left valign-top">Name</th>
67+
<th class="tableblock halign-left valign-top">Default</th>
68+
<th class="tableblock halign-left valign-top">Description</th>
69+
</tr>
70+
</thead>
71+
<tbody>
72+
<tr>
73+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.profile</p></td>
74+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DEFAULT</code></p></td>
75+
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of the profile in OCI Auth config file</p></td>
76+
</tr>
77+
<tr>
78+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.file</p></td>
79+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
80+
<td class="tableblock halign-left valign-top"><p class="tableblock">Location of the OCI Auth config file</p></td>
81+
</tr>
82+
<tr>
83+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.type</p></td>
84+
<td class="tableblock halign-left valign-top"><p class="tableblock">FILE</p></td>
85+
<td class="tableblock halign-left valign-top"><p class="tableblock">Config/Auth type to be used. Allowed values are FILE, SIMPLE, INSTANCE_PRINCIPAL, RESOURCE_PRINCIPAL, SESSION_TOKEN, and WORKLOAD_IDENTITY</p></td>
86+
</tr>
87+
<tr>
88+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.userId</p></td>
89+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
90+
<td class="tableblock halign-left valign-top"><p class="tableblock">OCID of the user used for creating the API key. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
91+
</tr>
92+
<tr>
93+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.tenantId</p></td>
94+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
95+
<td class="tableblock halign-left valign-top"><p class="tableblock">Tenancy OCID where the API key is created. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
96+
</tr>
97+
<tr>
98+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.fingerprint</p></td>
99+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
100+
<td class="tableblock halign-left valign-top"><p class="tableblock">Fingerprint for the public key that was added to the user mentioned in <code>spring.cloud.oci.config.userId</code>. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
101+
</tr>
102+
<tr>
103+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.privateKey</p></td>
104+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
105+
<td class="tableblock halign-left valign-top"><p class="tableblock">Full path and filename of the private key used for generating the <code>spring.cloud.oci.config.fingerprint</code>. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
106+
</tr>
107+
<tr>
108+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.passPhrase</p></td>
109+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
110+
<td class="tableblock halign-left valign-top"><p class="tableblock">Passphrase used for <code>spring.cloud.oci.config.privateKey</code>, if it is encrypted. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
111+
</tr>
112+
<tr>
113+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.config.region</p></td>
114+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
115+
<td class="tableblock halign-left valign-top"><p class="tableblock">An OCI region which will be used for Authentication. This is needed only if spring.cloud.oci.config.type is <code>SIMPLE</code></p></td>
116+
</tr>
117+
<tr>
118+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.region.static</p></td>
119+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
120+
<td class="tableblock halign-left valign-top"><p class="tableblock">An OCI region which will be used for making API calls. This will take precedence over <code>spring.cloud.oci.config.region</code></p></td>
121+
</tr>
122+
<tr>
123+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.compartment.static</p></td>
124+
<td class="tableblock halign-left valign-top"><p class="tableblock">NA</p></td>
125+
<td class="tableblock halign-left valign-top"><p class="tableblock">Default OCI Compartment OCID</p></td>
126+
</tr>
127+
<tr>
128+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.storage.enabled</p></td>
129+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
130+
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to enable the OCI Spring Cloud Storage module</p></td>
131+
</tr>
132+
<tr>
133+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.notification.enabled</p></td>
134+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
135+
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to enable the OCI Spring Cloud Notification module</p></td>
136+
</tr>
137+
<tr>
138+
<td class="tableblock halign-left valign-top"><p class="tableblock">spring.cloud.oci.logging.enabled</p></td>
139+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
140+
<td class="tableblock halign-left valign-top"><p class="tableblock">Flag to enable the OCI Spring Cloud Logging module</p></td>
141+
</tr>
142+
</tbody>
143+
</table>
144+
</div>
145+
</div>
146+
</div>
147+
<div id="footer">
148+
<div id="footer-text">
149+
Last updated 2024-07-15 10:41:20 -0500
150+
</div>
151+
</div>
152+
</div>
153+
</div>
154+
</div>
155+
</body>
156+
</html>

0 commit comments

Comments
 (0)