Skip to content

Commit 07fc463

Browse files
authored
Merge pull request #45 from gopalsanjith/oci-tools
Install script and README.md file updates
2 parents 0079478 + 7358a14 commit 07fc463

File tree

3 files changed

+830
-610
lines changed

3 files changed

+830
-610
lines changed

autonomous_ai_agents/README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Autonomous AI Agents — Quick Install Guide (OCI Object Storage + OCI Vault)
2+
3+
This guide shows how to install and use the two SQL installer scripts:
4+
- oci_object_storage_agent_install.sql
5+
- oci_vault_agent_install.sql
6+
7+
What gets installed
8+
- A config table in your target schema: OCI_AGENT_CONFIG
9+
- A PL/SQL package with ready-to-use functions
10+
- AI Agent tools (DBMS_CLOUD_AI_AGENT) mapped to those functions
11+
12+
Important
13+
- INSTALL_SCHEMA is mandatory. Always set it.
14+
15+
Prerequisites
16+
- A DBMS_CLOUD credential with OCI permissions for the target compartment(s)
17+
- The target schema name (INSTALL_SCHEMA) where packages/tools/config will live
18+
19+
1) Create or identify a DBMS_CLOUD credential
20+
Example (if needed):
21+
```
22+
BEGIN
23+
DBMS_CLOUD.CREATE_CREDENTIAL(
24+
credential_name => 'MY_CRED',
25+
username => '<oci_user_or_principal>',
26+
password => '<oci_auth_token_or_secret>'
27+
);
28+
END;
29+
/
30+
```
31+
32+
2) Install — set variables and run the scripts
33+
Use SQL*Plus q'(...)' quoting for JSON so you don't need to escape quotes.
34+
35+
Connect:
36+
```
37+
sqlplus admin@<tns_alias>
38+
```
39+
40+
Set variables (mandatory INSTALL_SCHEMA, optional INSTALL_CONFIG_JSON):
41+
```
42+
DEFINE INSTALL_SCHEMA = 'YOUR_APP_SCHEMA';
43+
DEFINE INSTALL_CONFIG_JSON = q'({"credential_name": "MY_CRED", "compartment_name": "MY_COMP"})';
44+
```
45+
46+
Run one or both installers:
47+
```
48+
@autonomous_ai_agents/oci_object_storage_agent_install.sql
49+
@autonomous_ai_agents/oci_vault_agent_install.sql
50+
```
51+
52+
Notes
53+
- INSTALL_CONFIG_JSON is optional (defaults to NULL).
54+
- Recommended keys to include if you pass JSON:
55+
- credential_name: your DBMS_CLOUD credential name
56+
- compartment_name: name of the compartment
57+
58+
3) If you didn’t pass INSTALL_CONFIG_JSON, you can still configure the
59+
agent after installation by adding rows to YOUR_APP_SCHEMA.OCI_AGENT_CONFIG.
60+
Each agent has its own AGENT value
61+
- For object storage use OCI_OBJECT_STORAGE
62+
- For vault use OCI_VAULT
63+
64+
Examples (Object Storage)
65+
66+
Set credential name for Object Storage operations:
67+
```
68+
INSERT INTO YOUR_APP_SCHEMA.OCI_AGENT_CONFIG ("KEY","VALUE","AGENT")
69+
VALUES ('CREDENTIAL_NAME', 'MY_CRED', 'OCI_OBJECT_STORAGE');
70+
```
71+
72+
Set compartment name for Vault
73+
```
74+
INSERT INTO YOUR_APP_SCHEMA.OCI_AGENT_CONFIG ("KEY","VALUE","AGENT")
75+
VALUES ('COMPARTMENT_NAME', 'MY_COMP', 'OCI_VAULT');
76+
```
77+

0 commit comments

Comments
 (0)