Skip to content

Commit 3c32cea

Browse files
[Phase Four] Refactor Documentation for Corrino -> OCI AI Blueprints Change (#35)
* phase 4 * Update README to reflect change from OKE Starter Kit to OCI AI Blueprints in cleanup section * Separated out Portal and API under Application Information
1 parent 38a9243 commit 3c32cea

File tree

3 files changed

+26
-16
lines changed

3 files changed

+26
-16
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ You can accomplish this by using shared node pools. Documentation is [here](docs
199199

200200
### Cleanup
201201

202-
With the use of Terraform, the [Resource Manager][orm] stack is also responsible for terminating the OKE Starter Kit application.
202+
With the use of Terraform, the [Resource Manager][orm] stack is also responsible for terminating the OCI AI Blueprints application.
203203

204204
Follow these steps to completely remove all provisioned resources:
205205

docs/api_documentation/accessing_oci_ai_blueprints/README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,35 @@
22

33
Once OCI AI Blueprints has been deployed into your tenancy via Resource Manager, you can work with OCI AI Blueprints three ways:
44

5-
## **Option #1: OCI AI Blueprints APIs via Web:**
6-
7-
Corrino's APIs are accessible via web interface. The APIs are shown as human-friendly HTML output for each OCI AI Blueprints API resource . These pages allow for easy browsing of resources, as well as forms for submitting data to the resources using `POST`, `PUT`, and `DELETE`.
5+
## **Option #1: OCI AI Blueprints UI Portal:**
86

97
1. Inside the OCI Console > Resource Manager, select the stack you created for OCI AI Blueprints
108

11-
2. Go to "Variables" on the left-hand side under Resources section and copy the values for "corrino_admin_username" and "corrino_admin_nonce"
9+
2. Go to the "Application Information" tab under Stack Details.
10+
11+
3. Copy the "Portal URL" into your browser
12+
13+
4. Upon first access, you must login - providing the "Admin Username" and "Admin Password" from the "Application Information" tab under Stack Details
1214

13-
3. Go to the "Application Information" tab under Stack Details
15+
## **Option #2: OCI AI Blueprints APIs via Web:**
1416

15-
4. Copy the "OCI AI Blueprints API URL" into your browser
17+
OCI AI Blueprint's APIs are accessible via web interface. The APIs are shown as human-friendly HTML output for each OCI AI Blueprints API resource . These pages allow for easy browsing of resources, as well as forms for submitting data to the resources using `POST`, `PUT`, and `DELETE`.
18+
19+
1. Inside the OCI Console > Resource Manager, select the stack you created for OCI AI Blueprints
1620

17-
5. Upon first access, you must login - providing the "corrino_admin_username" for username and "corrino_admin_nonce" for password
21+
2. Go to the "Application Information" tab under Stack Details.
1822

19-
6. Now, you can view and access all API endpoints for your instance of OCI AI Blueprints
23+
3. Copy the "OCI AI Blueprints API URL" into your browser
2024

21-
## **Option #2: OCI AI Blueprints APIs via Curl/Postman**
25+
4. Upon first access, you must login - providing the "Admin Username" and "Admin Password" from the "Application Information" tab under Stack Details
26+
27+
5. Now, you can view and access all API endpoints for your instance of OCI AI Blueprints
28+
29+
## **Option #3: OCI AI Blueprints APIs via Curl/Postman**
2230

2331
You can interact with the APIs locally using Postman, curl or any API platform by doing the following:
2432

25-
1. Get your `OCI AI Blueprints API URL` (will reference this as **API URL** going forward), `corrino_admin_username` (will reference this as **username** going forward) and `corrino_admin_nonce` (will reference this as **password** going forward) by following steps 1 - 3 above in Option #1
33+
1. Get your `OCI AI Blueprints API URL` (will reference this as **API URL** going forward), `Admin Usernmae` (will reference this as **username** going forward) and `Admin Password` (will reference this as **password** going forward) by following steps 1 - 3 above in Option #1
2634
2. Once you have your username, password and API URL make a POST request to`<your-oci-ai-blueprints-api-url>/login` API to get your auth token:
2735

2836
```
@@ -60,7 +68,3 @@ curl --location --request GET '<your_api_url_here>/oci_shapes/' \
6068
2. Select Auth Type = OAuth 2.0
6169
3. Paste your token value
6270
4. Leave Header Prefix as "Token"
63-
64-
## **Option #3: OCI AI Blueprints UI Portal (Under Construction):**
65-
66-
For now, we recommend working with OCI AI Blueprints via the API server. An updated UI experience is being developed currently.

terraform/schema.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,15 @@ source:
1919
type: quickstart
2020

2121
outputGroups:
22-
- title: "OCI AI Blueprints API"
22+
23+
- title: "OCI AI Blueprints Portal"
2324
outputs:
2425
- blueprints_portal_url
26+
- corrino_admin_username_output
27+
- corrino_admin_nonce_output
28+
29+
- title: "OCI AI Blueprints API"
30+
outputs:
2531
- corrino_api_url
2632
- corrino_admin_username_output
2733
- corrino_admin_nonce_output

0 commit comments

Comments
 (0)