{"id":18802162,"url":"https://github.com/oracle-quickstart/oci-ods-orm","last_synced_at":"2025-08-30T17:09:08.997Z","repository":{"id":39850964,"uuid":"263404335","full_name":"oracle-quickstart/oci-ods-orm","owner":"oracle-quickstart","description":"Deploy Oracle Data Science using Resource Manager and Terraform","archived":false,"fork":false,"pushed_at":"2025-08-06T11:57:13.000Z","size":8890,"stargazers_count":23,"open_issues_count":2,"forks_count":16,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-08-06T13:37:45.203Z","etag":null,"topics":["oracle-led"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle-quickstart.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-12T17:24:46.000Z","updated_at":"2025-08-02T19:39:16.000Z","dependencies_parsed_at":"2023-01-17T18:31:12.912Z","dependency_job_id":null,"html_url":"https://github.com/oracle-quickstart/oci-ods-orm","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/oracle-quickstart/oci-ods-orm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-quickstart%2Foci-ods-orm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-quickstart%2Foci-ods-orm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-quickstart%2Foci-ods-orm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-quickstart%2Foci-ods-orm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle-quickstart","download_url":"https://codeload.github.com/oracle-quickstart/oci-ods-orm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-quickstart%2Foci-ods-orm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272878320,"owners_count":25008336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oracle-led"],"created_at":"2024-11-07T22:26:48.953Z","updated_at":"2025-08-30T17:09:08.980Z","avatar_url":"https://github.com/oracle-quickstart.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Provision Oracle Data Science (**_ODS_**) Using Oracle Cloud Infrastructure Resource Manager and Terraform\n\n## Introduction\n\n[![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-ods-orm/releases/download/v2.0.0.1/oci-ods-orm-v2.0.1.zip)\n\nThis solution allows you to provision [Oracle Data Science (**_ODS_**)](https://docs.cloud.oracle.com/en-us/iaas/data-science/using/data-science.htm) and all its related artifacts using [Terraform](https://www.terraform.io/docs/providers/oci/index.html) and [Oracle Cloud Infrastructure Resource Manager](https://docs.cloud.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm).\n\nBelow is a list of all artifacts that will be provisioned:\n\n| Component    | Default Name            | Optional |  Notes\n|--------------|-------------------------|----------|:-----------|\n| [Group](https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/managinggroups.htm)        | Oracle Cloud Infrastructure Users Group              | False    | All Policies are granted to this group, you can add users to this group to grant me access to ODS services.\n| [Dynamic Group](https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/managingdynamicgroups.htm) | Oracle Cloud Infrastructure Dynamic Group           | False    | Dynamic Group for Data Science Resources.\n| [Policies (compartment)](https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm)   | Oracle Cloud Infrastructure Security Policies        | False              | A policy at the compartment level to grant access to ODS\n| [Vault Master Key](https://docs.cloud.oracle.com/en-us/iaas/Content/KeyManagement/Concepts/keyoverview.htm) | Oracle Cloud Infrastructure Vault Master Key             | True     | Oracle Cloud Infrastructure Vault Master Key can be used encrypt/decrypt credentials for secured access.\n\n## Prerequisite\n\n- You need a user with an **Administrator** privileges to execute the ORM stack or Terraform scripts.\n- Make sure your tenancy has service limits availabilities for the above components in the table.\n\n## Using Oracle Resource Manager (ORM)\n\n1. clone repo `git clone git@github.com:oracle-quickstart/oci-ods-orm.git`\n1. Download [`oci-ods-orm-v2.0.1.zip`](https://github.com/oracle-quickstart/oci-ods-orm/releases/download/v2.0.0.1/oci-ods-orm-v2.0.1.zip) file\n1. From Oracle Cloud Infrastructure **Console/Resource Manager**, create a new stack.\n1. Make sure you select **My Configurations** and then upload the zip file downloaded in the previous step.\n1. Set a name for the stack and click Next.\n1. Set the required variables values and then Create.\n    ![create stack](images/create_stack.gif)\n\n1. From the stack details page, Select **Plan** under **Terraform Actions** menu button and make sure it completes successfully.\n    ![plan](images/plan.png)\n\n1. From the stack details page, Select **Apply** under **Terraform Actions** menu button and make sure it completes successfully.\n    ![Apply](images/apply.png)\n\n1. To destroy all created artifacts, from the stack details page, Select **Destroy** under **Terraform Actions** menu button and make sure it completes successfully.\n    ![Destroy](images/destroy.png)\n\n### Understanding Provisioning Options\n\n- **IAM Groups/Policies** change default names of Groups and Policies to be created.\n\n    ![IAM Configs](images/orm_iam.png)\n\n- If **Enable Vault Support** is selected, Oracle Cloud Infrastructure Vault along with all required IAM policies will be provisioned, you can change the default values if needed, otherwise Oracle Cloud Infrastructure Vault will not be provisioned.\n\n    ![Vault Configs](images/orm_vault.png)\n\n## Using Terraform\n\n1. Clone repo\n\n   ```bash\n   git clone git@github.com:oracle-quickstart/oci-ods-orm.git\n   cd oci-ods-orm/terraform\n   ```\n\n1. Create a copy of the file **oci-ods-orm/terraform/terraform.tfvars.example** in the same directory and name it **terraform.tfvars**.\n1. Open the newly created **oci-ods-orm/terraform/terraform.tfvars** file and edit the following sections:\n    - **TF Requirements** : Add your Oracle Cloud Infrastructure user and tenant details:\n\n        ```text\n           #*************************************\n           #           TF Requirements\n           #*************************************\n           \n           // Oracle Cloud Infrastructure Region, user \"Region Identifier\" as documented here https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm\n           region=\"\"\n           // The Compartment OCID to provision artificats within\n           compartment_ocid=\"\"\n           // Oracle Cloud Infrastructure User OCID, more details can be found at https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#five\n           user_ocid=\"\"\n           // Oracle Cloud Infrastructure tenant OCID, more details can be found at https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#five\n           tenancy_ocid=\"\"\n           // Path to private key used to create Oracle Cloud Infrastructure \"API Key\", more details can be found at https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/credentials.htm#two\n           private_key_path=\"\"\n           // \"API Key\" fingerprint, more details can be found at https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/credentials.htm#two\n           fingerprint=\"\"\n        ```\n\n    - **IAM Requirements**: Check default values for IAM artifacts and change them if needed\n\n        ```text\n           #*************************************\n           #          IAM Specific\n           #*************************************\n           \n           // ODS IAM Group Name (no spaces)\n           ods_group_name= \"DataScienceGroup\"\n           // ODS IAM Dynamic Group Name (no spaces)\n           ods_dynamic_group_name= \"DataScienceDynamicGroup\"\n           // ODS IAM Policy Name (no spaces)\n           ods_policy_name= \"DataSciencePolicies\"\n           // If enabled, the needed OCI policies to manage \"OCI Vault service\" will be created \n           enable_vault_policies= true\n        ```\n\n    - **Vault Specific**: check default values for OCI Vault and change them if needed\n\n        ```text\n          #*************************************\n          #          Vault Specific\n          #*************************************\n          // If enabled, an Oracle Cloud Infrastructure Vault along with the needed  policies to manage \"Vault service\" will be created\n          enable_vault= true\n          // ODS Vault Name\n          ods_vault_name= \"Data Science Vault\"\n          // ODS Vault Type, allowed values (VIRTUAL, DEFAULT)\n          ods_vault_type = \"DEFAULT\"\n          // If enabled, a Vault Master Key will be created.\n          enable_create_vault_master_key = true\n          // ODS Vault Master Key Name\n          ods_vault_master_key_name = \"DataScienceKey\"\n          // ODS Vault Master Key length, allowed values (16, 24, 32)\n          ods_vault_master_key_length = 32\n        ```\n\n1. Open file **oci-ods-orm/terraform/provider.tf** and uncomment the (user_id , fingerprint, private_key_path) in the **_two_** providers (**Default Provider** and **Home Provider**)\n\n    ```text\n        // Default Provider\n        provider \"oci\" {\n          region = var.region\n          tenancy_ocid = var.tenancy_ocid\n          ###### Uncomment the below if running locally using terraform and not as Oracle Cloud Infrastructure Resource Manager stack #####\n        //  user_ocid = var.user_ocid\n        //  fingerprint = var.fingerprint\n        //  private_key_path = var.private_key_path\n          \n        }\n        \n        \n        \n        // Home Provider\n        provider \"oci\" {\n          alias            = \"home\"\n          region           = lookup(data.oci_identity_regions.home-region.regions[0], \"name\")\n          tenancy_ocid = var.tenancy_ocid\n          ###### Uncomment the below if running locally using terraform and not as Oracle Cloud Infrastructure Resource Manager stack #####\n        //  user_ocid = var.user_ocid\n        //  fingerprint = var.fingerprint\n        //  private_key_path = var.private_key_path\n        \n        }\n    ```\n\n1. Initialize terraform provider\n\n    ```bash\n    \u003e terraform init\n    ```\n\n1. Plan terraform scripts\n\n    ```bash\n    \u003e terraform plan\n   ```\n\n1. Run terraform scripts\n\n    ```bash\n    \u003e terraform apply -auto-approve\n   ```\n\n1. To Destroy all created artifacts\n\n    ```bash\n    \u003e terraform destroy -auto-approve\n   ```\n\n## Contributing\n\n`oci-ods-orm` is an open source project. See [CONTRIBUTING](CONTRIBUTING.md) for details.\n\nOracle gratefully acknowledges the contributions to `oci-ods-orm` that have been made by the community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-quickstart%2Foci-ods-orm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle-quickstart%2Foci-ods-orm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-quickstart%2Foci-ods-orm/lists"}