Skip to content

Commit 9731c3a

Browse files
Update version files and documentation to v1.0.2 (#71)
* Update version files and documentation to v1.0.2 Updated files: - cluster_creation_terraform/CLUSTER_CREATION_STACK_VERSION - cluster_creation_terraform/OCI_AI_BLUEPRINTS_LINK - oci_ai_blueprints_terraform/OCI_AI_BLUEPRINTS_STACK_VERSION - oci_ai_blueprints_terraform/schema.yaml (stack_version enum) - GETTING_STARTED_README.md (Deploy to Oracle Cloud links) - docs/versions/ControlPlaneVersions.md - docs/versions/PortalVersions.md - docs/versions/QuickStartVersions.md * minor updates * Enhance upgrade instructions for OCI AI Blueprints documentation. Updated steps for applying new releases, clarified technical background, and improved error handling guidance. * Update troubleshooting guidance in installation documentation to request full logs for faster assistance. * Update deployment links in documentation to remove region parameter for Oracle Cloud Resource Manager. Adjusted the link in both the GETTING_STARTED_README.md and OCI_AI_BLUEPRINTS_LINK file for consistency. * Fix link formatting in OCI_AI_BLUEPRINTS_LINK by removing unnecessary ampersand from the URL.
1 parent 4877ea9 commit 9731c3a

File tree

9 files changed

+243
-20
lines changed

9 files changed

+243
-20
lines changed

GETTING_STARTED_README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This guide helps you install and use **OCI AI Blueprints** for the first time. Y
2424

2525
Instead of creating an OKE cluster manually, you can deploy a **VCN + OKE cluster** in one click. Use the button below to open Oracle Cloud’s Resource Manager:
2626

27-
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.1/v1.0.1_cluster.zip)
27+
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.2/v1.0.2_cluster.zip)
2828

2929
1. Click **Deploy to Oracle Cloud** above.
3030
2. In **Create Stack**:
@@ -42,7 +42,7 @@ Now that your cluster is ready, follow these steps to install OCI AI Blueprints
4242

4343
1. Click the **Deploy to Oracle Cloud** button below to open another Resource Manager stack—this one for OCI AI Blueprints:
4444

45-
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.1/v1.0.1_app.zip)
45+
[![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.2/v1.0.2_app.zip)
4646

4747
2. In the **Create Stack** wizard:
4848
- Provide a **name** (e.g., _oci-ai-blueprints-stack_).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v1.0.1
1+
v1.0.2
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.1/v1.0.1_app.zip"
1+
"https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/v1.0.2/v1.0.2_app.zip"

docs/installing_new_updates.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,49 @@
22

33
## Overview
44

5-
OCI AI Blueprints team will release new versions of it's control-plane and frontend images once new features have been developed and thoroughly tested. In order to use the latest version of OCI AI Blueprints in your environment, apply the following steps.
5+
The OCI AI Blueprints team regularly publishes **full-stack release packages** (control plane, frontend, blueprints, Terraform).
6+
To upgrade your existing deployment, replace your stack’s source zip with the **latest package** from GitHub Releases and re-apply the stack in **OCI Resource Manager**.
67

7-
### Steps:
8+
---
89

9-
1. In OCI Console > Resource Manager > Stacks
10-
2. Choose the stack that was used to deploy OCI AI Blueprints originally
11-
3. Make sure you have chosen the correct stack by clicking on "Variables" in the lower left corner underneath the "Resources" section. Verify the variables correspond to the OCI AI Blueprints instance you are wanting to update.
12-
4. Verify that the API URL matches underneath the "Application Information" tab.
13-
5. After successful verification that this is the correct stack, click "Apply" (in the button group near the top of the page containing Edit / Plan / Destroy / More Actions buttons)
14-
6. A new Job in the stack will be created. Wait for this Job to finish
15-
7. Once the Job is finished and no errors occurred, the Job will show State = "Succeeded"
16-
8. At this point, your OCI AI Blueprints environment has been successfully updated and contains all the latest features
10+
## Upgrade Steps
1711

18-
### Technical Background
12+
1. **Download and unzip the latest release package**
1913

20-
Since the OCI AI Blueprints stack uses the "latest" image tag for all applications, when applying the stack again - Resource Manager pulls the latest image and applies it to your OKE cluster. No restart is needed since the deployments are restarted during the "Apply" phase.
14+
- Go to **GitHub → Releases** for OCI AI Blueprints
15+
<https://github.com/oracle-quickstart/oci-ai-blueprints/releases>
16+
- Download the file that ends with `_app.zip` (for example `vX.Y.Z_app.zip`) and unzip it.
2117

22-
### Error Handling
18+
2. Open **OCI Console → Resource Manager → Stacks**.
2319

24-
If errors occurs during the update process, please reach out to Vishnu Kammari at [[email protected]](mailto:[email protected]) or Grant Neuman at [[email protected]](mailto:[email protected]).
20+
3. Select the stack you originally used to deploy **OCI AI Blueprints**.
21+
22+
4. Click **Edit → Edit Stack**.
23+
24+
5. **Upload** the unzipped package (the `.zip` downloaded in Step 1).
25+
26+
> _Tip: the file name should match the release you just downloaded._
27+
28+
6. Click **Next → Next → Confirm** to save the new source.
29+
30+
7. Press **Apply** (top-right). A new job starts automatically.
31+
32+
8. Wait until the job’s **State** is **Succeeded** — your entire stack is now updated.
33+
34+
---
35+
36+
## Technical Background
37+
38+
Updating the stack zip prompts **Resource Manager** to pull the newest Terraform code and container images.
39+
During _Apply_, OKE deployments roll automatically, so no manual pod restarts are needed.
40+
41+
---
42+
43+
## Error Handling
44+
45+
If a job fails or you see errors in the console, please contact:
46+
47+
- Vishnu Kammari — <[email protected]>
48+
- Grant Neuman — <[email protected]>
49+
50+
Include the full set of logs when reaching out for fastest assistance.

docs/versions/ControlPlaneVersions.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,71 @@
22

33
The following table describes software versions for tagged releases of blueprints control plane software, with most recent tags listed first.
44

5+
<details>
6+
<summary><strong>v1.0.2</strong></summary>
7+
8+
## Software Used in Containers
9+
10+
| Container Name | Provider | Name | Type | Version |
11+
| :-----------------------------: | :--------: | :------------: | :------------------: | :-----: |
12+
| oci-corrino-cp / pod-util-amd64 | Oracle | oraclelinux | Container | 8 |
13+
| oci-corrino-cp / pod-util-amd64 | Python | python311 | Programming Language | 3.11.11 |
14+
| oci-corrino-cp / pod-util-amd64 | Python Pip | python3.11-pip | Package Manager | 22.3.1 |
15+
| pod-util-amd64 | Oracle | oci-cli | Application | 3.12 |
16+
17+
---
18+
19+
---
20+
21+
## Python Packages
22+
23+
### Web Frameworks & Extensions
24+
25+
| Package Name | Version |
26+
| :-----------------: | :-----: |
27+
| Django | 5.1.3 |
28+
| django-extensions | 3.2.3 |
29+
| djangorestframework | 3.14.0 |
30+
| asgiref | 3.8.1 |
31+
32+
### Servers & Runtimes
33+
34+
| Package Name | Version |
35+
| :----------: | :-----: |
36+
| gunicorn | 22.0.0 |
37+
38+
### Database Drivers
39+
40+
| Package Name | Version |
41+
| :-------------: | :-----: |
42+
| psycopg2-binary | 2.9.10 |
43+
| oracledb | 2.5.0 |
44+
| sqlparse | 0.5.0 |
45+
46+
### Cloud & Container SDKs
47+
48+
| Package Name | Version |
49+
| :----------: | :-----: |
50+
| kubernetes | 30.1.0 |
51+
| oci | 2.138.1 |
52+
53+
### Utilities & Validation
54+
55+
| Package Name | Version |
56+
| :----------: | :-----: |
57+
| jsonschema | 4.23.0 |
58+
| packaging | 24.0 |
59+
| pytz | 2024.1 |
60+
| requests | 2.32.3 |
61+
62+
### Monitoring
63+
64+
| Package Name | Version |
65+
| :---------------: | :-----: |
66+
| prometheus_client | 0.21.1 |
67+
68+
</details>
69+
570
<details>
671
<summary><strong>v1.0.1</strong></summary>
772

docs/versions/PortalVersions.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,67 @@
11
# Portal Versions
22

3+
<details>
4+
<summary><strong>v5.0.0</strong></summary>
5+
6+
**React & Framework**
7+
8+
- react: ^19.0.0
9+
- react-dom: ^19.0.0
10+
- next: 15.2.0-canary.74
11+
- next-themes: ^0.4.4
12+
13+
**UI Primitives (@radix-ui)**
14+
15+
- @radix-ui/react-alert-dialog: ^1.1.11
16+
- @radix-ui/react-dialog: ^1.1.6
17+
- @radix-ui/react-label: ^2.1.2
18+
- @radix-ui/react-popover: ^1.1.6
19+
- @radix-ui/react-scroll-area: ^1.2.4
20+
- @radix-ui/react-slot: ^1.2.0
21+
- @radix-ui/react-tabs: ^1.1.3
22+
- @radix-ui/react-tooltip: ^1.1.8
23+
24+
**Components & Utilities**
25+
26+
- class-variance-authority: ^0.7.1
27+
- clsx: ^2.1.1
28+
- js-cookie: ^3.0.5
29+
- lucide-react: ^0.476.0
30+
- react-markdown: ^10.1.0
31+
- sonner: ^2.0.1
32+
- tailwind-merge: ^3.0.2
33+
- tailwindcss-animate: ^1.0.7
34+
35+
**OCI SDK**
36+
37+
- oci-common: ^2.104.0
38+
- oci-core: ^2.104.0
39+
- oci-identity: ^2.104.0
40+
- oci-objectstorage: ^2.104.0
41+
42+
---
43+
44+
**DevDependencies**
45+
46+
**Build & Lint**
47+
48+
- typescript: ^5
49+
- tailwindcss: ^4
50+
- @tailwindcss/postcss: ^4
51+
- @tailwindcss/typography: ^0.5.16
52+
- eslint: ^9
53+
- @eslint/eslintrc: ^3
54+
- eslint-config-next: 15.2.0-canary.74
55+
56+
**Type Definitions**
57+
58+
- @types/node: ^20
59+
- @types/react: ^19
60+
- @types/react-dom: ^19
61+
- @types/js-cookie: ^3.0.6
62+
63+
</details>
64+
365
<details>
466
<summary><strong>v1.0.1</strong></summary>
567

docs/versions/QuickStartVersions.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,75 @@ The following table describes software versions for tagged releases of this quic
44

55
This will be replaced as soon as we start tagging. Wanted framework in place.
66

7+
<details>
8+
<summary><strong>v1.0.2</strong></summary>
9+
10+
## Cluster Creation Terraform
11+
12+
### Terraform / Provider Versions
13+
14+
| Component Type | Component Name | Component Source | Component Version |
15+
| :------------: | :------------: | :------------------: | :---------------: |
16+
| Language | Terraform | hashicorp | >=1.5 |
17+
| Provider | oci | oracle/oci | >=5 |
18+
| Provider | kubernetes | hashicorp/kubernetes | >=2.27 |
19+
| Provider | helm | hashicorp/helm | >=2.12 |
20+
| Provider | tls | hashicorp/tls | >=4 |
21+
| Provider | local | hashicorp/local | >=2.5 |
22+
| Provider | random | hashicorp/random | >=3.6 |
23+
24+
### Oracle Services
25+
26+
| Service | Version |
27+
| :----------------------: | :-----: |
28+
| Oracle Kubernetes Engine | v1.31.1 |
29+
30+
---
31+
32+
---
33+
34+
## OCI AI Blueprints Terraform
35+
36+
### Terraform / Provider Versions
37+
38+
| Component Type | Component Name | Component Source | Component Version |
39+
| :------------: | :------------: | :------------------: | :---------------: |
40+
| Language | Terraform | hashicorp | >=1.1 |
41+
| Provider | oci | oracle/oci | 4 <= version < 5 |
42+
| Provider | kubernetes | hashicorp/kubernetes | >=2 |
43+
| Provider | helm | hashicorp/helm | >=2 |
44+
| Provider | tls | hashicorp/tls | >=4 |
45+
| Provider | local | hashicorp/local | >=2 |
46+
| Provider | random | hashicorp/random | >=3 |
47+
48+
### Helm Chart Versions
49+
50+
| Chart Name | Version | Chart URL |
51+
| :-----------------: | :-----: | :------------------------------------------------: |
52+
| Grafana | 6.47.1 | https://grafana.github.io/helm-charts |
53+
| Prometheus | 19.0.1 | https://prometheus-community.github.io/helm-charts |
54+
| Metrics Server | 3.8.3 | https://kubernetes-sigs.github.io/metrics-server |
55+
| Ingress Nginx | 4.4.0 | https://kubernetes.github.io/ingress-nginx |
56+
| MLFlow | 0.16.5 | https://community-charts.github.io/helm-charts |
57+
| NVIDIA GPU Operator | v25.3.0 | https://helm.ngc.nvidia.com/nvidia |
58+
| Keda | 2.17.0 | https://kedacore.github.io/charts |
59+
| LeaderWorkerSet | 0.1.0 | local |
60+
| Kueue | 0.11.4 | oci://registry.k8s.io/kueue/charts |
61+
62+
### Container Versions
63+
64+
| Container | Version | Repository |
65+
| :----------------------- | :-----: | :------------------------------------------------: |
66+
| oci-corrino-cp | latest | iad.ocir.io/iduyx1qnmway/corrino-devops-repository |
67+
| oci-ai-blueprints-portal | latest | iad.ocir.io/iduyx1qnmway/corrino-devops-repository |
68+
69+
### Oracle Services
70+
71+
| Service | Version |
72+
| :------------------------: | :-----: |
73+
| Oracle Autonomous Database | 19c |
74+
75+
</details>
776
<details>
877
<summary><strong>v1.0.1</strong></summary>
978

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v1.0.1
1+
v1.0.2

oci_ai_blueprints_terraform/schema.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,9 +459,10 @@ variables:
459459
title: "Stack Version"
460460
type: enum
461461
enum:
462+
- "v1.0.2"
462463
- "v1.0.1"
463464
- "v1.0.0"
464-
default: "v1.0.1"
465+
default: "v1.0.2"
465466
required: true
466467
visible: true
467468

0 commit comments

Comments
 (0)