Skip to content

Commit 741feb6

Browse files
committed
oci_config docs
1 parent 1943ae2 commit 741feb6

File tree

3 files changed

+47
-3
lines changed

3 files changed

+47
-3
lines changed
14 KB
Loading
53.2 KB
Loading

docs/content/sandbox/configuration/oci_config.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,51 @@ Copyright (c) 2023, 2024, Oracle and/or its affiliates.
88
Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
99
-->
1010

11-
{{% notice style="default" title="10-Sept-2024: Documentation In-Progress..." icon="pen" %}}
12-
Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.
13-
{{% /notice %}}
11+
When using the split/embed functionality of the Sandbox, you have 3 source options to for uploading the documents to be vectorized:
1412

13+
![Load and Split Options](images/load-and-split-options.png)
14+
15+
## Configuration
16+
17+
The OCI credentials can either be configured using an /.oci/config file or through the **Sandbox** interface.
18+
19+
### Sandbox Interface
20+
21+
To configure the OCI credentials from the Sandbox, navigate to `Configuration -> OCI`:
22+
23+
![OCI config](images/oci-config.png)
24+
25+
Provide the following input:
26+
27+
- **User OCID**: Your personal User OCID [User OCID](#OCI-credentials) that can be retrieved on your OCI tenancy interface
28+
- **Fingerprint**: The **Fingerprint** associated to your OCI private API key
29+
- **Tenancy OCID**: The OCID associated to the tenancy you want to connect to, that can be retrieved on your OCI interface
30+
- **Region**: The tenancy region you want to connect to
31+
- **Key File**: The file path to your OCI private API key
32+
33+
Once all fields are set, click the `Save` button.
34+
35+
### /.oci/config file
36+
37+
If you have the related /.oci/config file configured, the Sandbox will read from the **DEFAULT** profile at startup and load the credentials as follows:
38+
39+
- **User OCID**: Your personal User OCID [User OCID](#OCI-credentials) that can be retrieved on your OCI tenancy interface
40+
- **Fingerprint**: The **Fingerprint** associated to your OCI private API key
41+
- **Tenancy OCID**: The OCID associated to the tenancy you want to connect to, that can be retrieved on your OCI interface
42+
- **Region**: The tenancy region you want to connect to
43+
- **Key File**: The file path to your OCI private API key
44+
45+
Once all fields are set, click the `Save` button.
46+
47+
### OCI credentials
48+
49+
Here's a summary of all the OCI credentials and where to find them:
50+
51+
| Entry | Description and Where to Get the Value | Required? |
52+
| -------------------- | ---------------------------------------- | ----------|
53+
| user | OCID of the user calling the API. To get the value, see [Required Keys and OCIDs](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs) <br> <br> Example: ocid1.user.oc1..<unique_ID>(shortened for brevity) | Yes |
54+
| fingerprint | Fingerprint for the public key that was added to this user. To get the value, see [Required Keys and OCIDs](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs) | Yes |
55+
| key_file | Full path and filename of the private key. <br><br> **Important:** The key pair must be in PEM format. For instructions on generating a key pair in PEM format, see [Required Keys and OCIDs](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs). <br><br>Example (Linux/Mac OS): ~/.oci/oci_api_key.pem. <br><br> Example (Windows): ~/.oci/oci_api_key.pem. <br><br> This corresponds to the file %HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem. | Yes |
56+
| tenancy | OCID of your tenancy. To get the value, see [Required Keys and OCIDs](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs) <br><br> Example: ocid1.tenancy.oc1..<unique_ID> | Yes |
57+
| region | An Oracle Cloud Infrastructure region. See [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm) <br><br> Example: us-ashburn-1 | Yes |
58+
| security_token_file | If session token authentication is being used, then this parameter is required. <br><br> Using this authentication method makes fingerprint, user, and pass_phrase not required. Starting a session with the OCI CLI will populate all of the required parameters for this authentication method. | Conditional |

0 commit comments

Comments
 (0)