|
| 1 | +# Getting Started with OCI AI Blueprints |
| 2 | + |
| 3 | +This guide helps you install and use **OCI AI Blueprints** for the first time. You will: |
| 4 | + |
| 5 | +1. Ensure you have the correct IAM policies in place. |
| 6 | +2. Deploy a dedicated **VCN and OKE cluster** stack. |
| 7 | +3. Deploy the **OCI AI Blueprints** application onto the new cluster. |
| 8 | +4. Access the OCI AI Blueprints portal to deploy a sample blueprint. |
| 9 | +5. Clean up resources when you’re done. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +## Step 1: Set Up Policies in Your Tenancy |
| 14 | + |
| 15 | +1. If you are **not** a tenancy administrator, ask your admin to set up the required policies in the **root compartment**. These policies are listed [here](docs/iam_policies/README.md). |
| 16 | +2. If you **are** a tenancy administrator, Resource Manager will typically deploy the minimal required policies automatically, but you can reference the same [IAM policies doc](docs/iam_policies/README.md) for advanced or custom configurations if needed. |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## Step 2: Deploy the VCN and OKE Cluster |
| 21 | + |
| 22 | +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: |
| 23 | + |
| 24 | +[](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/cluster_creation_release-2025-03-26/cluster_creation_release-2025-03-26.zip) |
| 25 | + |
| 26 | +1. Click **Deploy to Oracle Cloud** above. |
| 27 | +2. In **Create Stack**: |
| 28 | + - Give your stack a **name** (e.g., _oke-stack_). |
| 29 | + - Select the **compartment** where you want OCI AI Blueprints deployed. |
| 30 | + - Provide any additional parameters (such as node size, node count) according to your preferences. |
| 31 | +3. Click **Next**, then **Create**, and finally choose **Run apply** to provision your cluster. |
| 32 | +4. Monitor the progress in **Resource Manager → Stacks**. Once the status is **Succeeded**, you have a functional VCN and an OKE cluster ready to host OCI AI Blueprints. |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## Step 3: Deploy the OCI AI Blueprints Application |
| 37 | + |
| 38 | +Now that your cluster is ready, follow these steps to install OCI AI Blueprints onto it: |
| 39 | + |
| 40 | +1. Click the **Deploy to Oracle Cloud** button below to open another Resource Manager stack—this one for OCI AI Blueprints: |
| 41 | + |
| 42 | + [](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-quickstart/oci-ai-blueprints/releases/download/oci_ai_blueprints_app_release-2025-03-26/oci_ai_blueprints_release-2025-03-26.zip) |
| 43 | + |
| 44 | +2. In the **Create Stack** wizard: |
| 45 | + - Provide a **name** (e.g., _oci-ai-blueprints-stack_). |
| 46 | + - Choose the **same compartment** where your OKE cluster resides. |
| 47 | + - Make sure you select the **OKE cluster** you just created. Depending on the stack’s parameters, you may need to specify: |
| 48 | + - The OKE cluster OCID. |
| 49 | + - The node pool, if prompted. |
| 50 | + - Your desired admin credentials for logging into the OCI AI Blueprints portal. |
| 51 | +3. Click **Next**, then **Create**, and choose **Run apply** in the **Review** section. |
| 52 | +4. After the job completes, go to **Resource Manager → Stacks → (Your OCI AI Blueprints Stack)**. |
| 53 | +5. Under **Application Information**, you will see the **Portal URL** and **API URL**. You may also see generated admin credentials (if you didn't supply your own). |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## Step 4: Access the Portal & Deploy a Sample Blueprint |
| 58 | + |
| 59 | +1. **Open the Portal**: Go to the **Portal URL** from **Step 3** in your web browser. |
| 60 | +2. **Log In**: Enter the username and password you set during stack creation (or check the Resource Manager output variables if you left the defaults). |
| 61 | +3. **Deploy a Sample Blueprint**: |
| 62 | + - From the OCI AI Blueprints portal home screen, select **Deploy** on one of the blueprints (e.g., an LLM inference blueprint). |
| 63 | + - A list of **pre-filled samples** for that blueprint will appear, select one and you can simply click **Deploy**. (Advanced users can modify parameters like GPU shape or model ID.) |
| 64 | +4. **Monitor Deployment**: The portal will show the status of your deployment. Once it transitions to a **Running** or **Monitoring** state, you can test the endpoint as described in the portal UI. |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## Cleanup |
| 69 | + |
| 70 | +When you are finished, you can remove the resources you created in **two steps**, in this order: |
| 71 | + |
| 72 | +1. **Destroy the OCI AI Blueprints Stack** |
| 73 | + |
| 74 | + - Go to **Resource Manager → Stacks** in the OCI Console. |
| 75 | + - Select the stack you used to install **OCI AI Blueprints** (from Step 3). |
| 76 | + - Choose **Terraform Actions → Destroy**, confirm, and wait until the job succeeds. |
| 77 | + |
| 78 | +2. **Destroy the OKE Cluster & VCN Stack** |
| 79 | + - Return to **Resource Manager → Stacks**. |
| 80 | + - Select the stack you used to create your **cluster & VCN** (from Step 2). |
| 81 | + - Choose **Terraform Actions → Destroy**, confirm, and wait until it finishes. |
| 82 | + |
| 83 | +Following this order ensures you do not have leftover services or dependencies in your tenancy. Once both stacks are destroyed, your tenancy will be free of any OCI AI Blueprints-related resources. |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## Need Help? |
| 88 | + |
| 89 | +- Check out [Known Issues & Solutions](docs/known_issues/README.md) for troubleshooting common problems. |
| 90 | +- For questions or additional support, contact [[email protected]](mailto:[email protected]) or [[email protected]](mailto:[email protected]). |
0 commit comments