Skip to content

Commit 91396e7

Browse files
authored
Enhances the policies readme doc. (#603)
1 parent 69b4779 commit 91396e7

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

ai-quick-actions/policies/README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# Policies
22

3+
34
- [Home](../README.md)
4-
- [CLI](../cli-tips.md)
5-
- [Model Deployment](../model-deployment-tips.md)
6-
- [Model Evaluation](../evaluation-tips.md)
7-
- [Model Fine Tuning](../fine-tuning-tips.md)
5+
- [Policies](#policies)
6+
- [Setting Up Policies Using (ORM) stack](#setting-up-policies-using-orm-stack)
7+
- [Setting Up Policies Manually](#setting-up-policies-manually)
8+
- [Dynamic Groups](#dynamic-groups)
9+
- [Policies](#policies-1)
810

9-
> **Note:** To get started using AI quick actions, an admin in the tenancy needs to install the required policies for AI Quick Actions. You can use [Oracle Resource Manager](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) (ORM) stack or configure them manually.
1011

11-
- [Policies](#policies)
12-
- [Setting Up Policies Using (ORM) stack](#setting-up-policies-using-orm-stack)
13-
- [Setting Up Policies Manually](#setting-up-policies-manually)
14-
- [Dynamic Groups](#dynamic-groups)
15-
- [Policies](#policies-1)
12+
---
13+
To get started with AI Quick Actions, a tenancy administrator must first install the required policies. These can be configured manually or deployed using an [Oracle Resource Manager (ORM)](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) stack.
14+
1615

1716
## Setting Up Policies Using (ORM) stack
1817

19-
> **Note:** Even if you already have the policies to use Data Science service, you still need to use the terraform configuration file to set up the policies to use AI Quick Actions. To successfully execute the Terraform script, you must have administrative rights.
18+
Even if you already have policies in place for using the Data Science service, you still need to use the provided Terraform configuration to set up the additional policies required for AI Quick Actions.
19+
20+
>>[!IMPORTANT] To run the Terraform script successfully, you must have administrator privileges. Policies can only be applied using an Oracle Resource Manager (ORM) stack if they are being created in the home region.
2021
21-
> **Note:** Policies can only be applied via (ORM) stack, if they are being applied from the home region.
22+
Before running the script, make sure you have the following permissions granted:
2223

23-
Before running the Terraform script, ensure you have the following permissions granted:
2424

2525
```bash
2626
allow group <your_admin_group> to manage orm-stacks in TENANCY
@@ -30,9 +30,13 @@ allow group <your_admin_group> to manage policies in TENANCY
3030
allow group <your_admin_group> to read compartments in TENANCY
3131
```
3232

33-
Click to deploy the stack [![Deploy to Oracle Cloud][magic_button]][magic_stack] or download terraform configuration file [oci-ods-aqua-orm.zip](https://github.com/oracle-samples/oci-data-science-ai-samples/releases/latest/download/oci-ods-aqua.zip) with the infrastructure instructions for the dynamic groups and polices.
33+
**To deploy the stack, click the button below:**
3434

35-
> **Note:** For steps on creating stacks from the configuration file, see [Creating a Stack from a Zip File](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Tasks/create-stack-local.htm#top).
35+
[![Deploy to Oracle Cloud][magic_button]][magic_stack]
36+
37+
Alternatively, you can [**download the Terraform configuration file** (oci-ods-aqua-orm.zip)](https://github.com/oracle-samples/oci-data-science-ai-samples/releases/latest/download/oci-ods-aqua.zip), which includes setup instructions for dynamic groups and policies.
38+
39+
For steps on creating stacks from the configuration file, see [Creating a Stack from a Zip File](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Tasks/create-stack-local.htm#top).
3640

3741
While deploying the stack you can select the kind of policies that need to be deployed for AQUA:
3842
1. **All policies** - This will deploy all the policies needed for AQUA in one go.
@@ -49,7 +53,7 @@ After the stack is created and its Stack details page opens, click Plan from the
4953

5054

5155
## Setting Up Policies Manually
52-
> **Note:** If you already have policies for the Data Science service, you will still need to implement additional policies to enable AI Quick Actions.
56+
>[!NOTE] If you already have policies for the Data Science service, you will still need to implement additional policies to enable AI Quick Actions.
5357
5458
### Dynamic Groups
5559
- ``aqua-dynamic-group``
@@ -94,7 +98,7 @@ After the stack is created and its Stack details page opens, click Plan from the
9498
Allow dynamic-group aqua-dynamic-group to inspect compartments in tenancy
9599

96100
Allow dynamic-group aqua-dynamic-group to manage object-family in compartment <your-compartment-name> where any {target.bucket.name='<your-bucket-name>'}
97-
101+
98102
Allow dynamic-group <dynamic-group-name> to read repos in compartment <your-compartment-name> where any {request.operation='ReadDockerRepositoryMetadata',request.operation='ReadDockerRepositoryManifest',request.operation='PullDockerLayer'}
99103
```
100104

0 commit comments

Comments
 (0)