Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oracle-quickstart/oci-oracle-analytics-server

Terraform module to deploy Oracle Analytics Server on Oracle Cloud Infrastructure (OCI)
https://github.com/oracle-quickstart/oci-oracle-analytics-server

cloud oas oci oracle oracle-led terraform

Last synced: 2 days ago
JSON representation

Terraform module to deploy Oracle Analytics Server on Oracle Cloud Infrastructure (OCI)

Awesome Lists containing this project

README 

        


   

  


  
Oracle Analytics Server on Oracle Cloud Infrastructure


  



Oracle Analytics Server is a complete modern analytics platform that helps you make smarter predictions and better decisions.  Embedded machine learning and artificial intelligence power intelligent enterprise reporting, ad hoc analysis, and self-service data visualization, so no matter what your role (analyst, engineer, or executive) you can easily analyze data and uncover new insights. 


This Quick Start automates the deployment of Oracle Analytics Server on Oracle Cloud Infrastructure. The Quick Start uses 

Resource Manager, a service on Oracle Cloud Infrastructure that allows you to deploy resources using Terraform.



Topology


This topology represents a simple Oracle Analytics Server deployment on Oracle Cloud Infrastructure using this Quick Start.




Prerequisites


Before you deploy Oracle Analytics Server on Oracle Cloud, you must complete various prerequisite tasks. Oracle recommends that you gather a list of the metadata that you'll need for the quick-deployment process and we provide a checklist to help you plan your deployment. See Before you Begin.


Subscribe to Oracle Analytics Server on Oracle Cloud


You must have an active Oracle Cloud account (Pay As You Go or Annual Universal Credits) to deploy Oracle Analytics Server - UCM (Universal Credits) on Oracle Cloud Infrastructure. Alternatively, you must have an Oracle Fusion Middleware on-premises license for Oracle Analytics Server and sign up for an Oracle Cloud account to deploy Oracle Analytics Server - BYOL (Bring Your Own License). See Subscribe to Oracle Analytics Server on Oracle Cloud.


Set Up Policies in Oracle Cloud Infrastructure


In Oracle Cloud Infrastructure, you use policies to control access to resources in your tenancy. Before deploying Oracle Analytics Server on a compartment in Oracle Cloud Infrastructure, your tenant administrator must set up policies that enables you (or other users) to access or create resources in specific compartments. See Set Up Policies in Oracle Cloud Infrastructure.


Create Compartments


Before you deploy Oracle Analytics Server on Oracle Cloud, Oracle recommends that you set up the compartment where you want all the resources associated with Oracle Analytics Server to belong. See Create Compartments.


Set Up Network Resources


You or your network administrator must set up a virtual cloud network (VCN) and a subnet for your Oracle Analytics Server compute instance before you start. See Set Up Network Resources.


Set Up Oracle Cloud Database


When you deploy Oracle Analytics Server on Oracle Cloud using this Quick Start, you're asked to provide the database connection string and database administrator credentials for an existing database you want to use. See Set Up an Oracle Cloud Database.


Plan Compute Shape and Boot Volume Size


You can deploy Oracle Analytics Server on a range of compute shapes to suit different scenarios. If you're not sure which sizes to use, contact your sales team to discuss sizing guidelines.  See also Plan Compute Shape and Boot Volume Size.


Generate SSH Keys


You must generate the SSH public key and corresponding private key you want to use to access the Oracle Analytics Server compute instance before you start. See Generate SSH Keys.


Complete Predeployment Checklist


Use a checklist to plan your deployment and ensure you've completed all the prerequisite tasks. See Complete Checklist.


Deploy Oracle Analytics Server using Resource Manager


Download the Quick Start Terraform scripts from GitHub and then use Resource Manager to deploy Oracle Analytics Server on Oracle Cloud Infrastructure. 


    

  1.  Complete all the prerequisites tasks and record the information you need in the checklist provided. 
    2. 

  2.  On the Oracle Analytics Server quick-start page, click the Code button, select Download ZIP, and save the ZIP file to your local file system (oci-oracle-analytics-server-master.zip). 
    3. 


  3. Extract all the files in oci-oracle-analytics-server-master.zip to a folder on your local file system.
    4. 

  4. Make sure build.sh is executable, and then run build.sh to generate two ZIP files in the build folder. One ZIP file is for the BYOL license and the other for the UCM license. If build.sh isn't executable, run chmod 755 build.sh. This enables you to execute the file.
    5. 

  5.  Sign into Oracle Cloud Infrastructure Console and navigate to Developer Services. Under Resource Manager, click Stacks. 
    6. 

  6.  Select the compartment in which you want to deploy and run the stack. For example,  MyStacks. 
    7. 

  7.  Click Create Stack. 
    8. 

  8.  Enter details about your stack and click Next.

      
      

            
    •  Keep the default My Configuration.
      • 

            
    •  For Terraform configuration source, select .Zip file and browse to the ZIP file that you created in Step 4. 

      The Stack Information section updates to show Oracle Analytics Server - UCM or Oracle Analytics Server - BYOL.
      • 

            
    •  For Working Directory, select Use Terraform configuration files in the root folder.
      • 

            
    •  Enter a name for your Oracle Analytics Server stack. For example, My-OAS-Terraform-Stack.
      • 

            
    •  Add your own description or leave the default. For example, Stack to install Oracle Analytics Server on My TEST compute instance.
      • 

    

    9. 

  9. Set values for the compute instance and network on which Oracle Analytics Server will be deployed, and configure domain information for Oracle Analytics Server.

    Compute Instance Configuration
    


      

        Property

        Description 

      

      

        Display Name

        Name for the compute instance. For example, MyTestOAS.  

      

      

        Target Compartment

        Compartment in which to deploy the Oracle Analytics Server compute instance that this stack generates. For example, MyOracle_Analytics_Server. 

      
    


        Availability Domain

        Domain in which to create the compute instance. Required only if your tenancy has more than one availability domain. 

      

      

        Shape 

        Shape for the compute instance. If you select a flexible shape, you can specify the number of OCPUs and the amount of Memory (GB) that you want for the compute instance.  

      
    


         OCPU

         Only for flexible shapes. Value between 1 and 64. The default is 1 OCPU. 

      

     

         Memory

         Only for flexible shapes. Value between 1 and 1024 GB. The default is 15 GB. 

      
    


        Boot Volume Size

        Size of the boot volume in GB. The minimum volume is 400 GB and the maximum value is 32768 GB. 

      

      

         SSH Public Key

        Public SSH key that you created to access the compute instance. 

      

     

    Network Configuration
    


      

        Property

        Description 

      

      

        VCN Compartment

        Compartment containing the Virtual Cloud Network (VCN) you want to use. For example, MyNetwork. 

      
    


        Virtual Cloud Network

        Virtual cloud network (VCN) where you want to create the compute instance. 

      

       

        Subnet Compartment

        Compartment containing the subnet you want to use. For example, MySubnet. 

      

      

        Subnet

        Subnet for the compute instance. 

      

      

        Assign a Public IP Address

        Generates a public IP address for the compute instance. 

      
    


    Domain Configuration
    


      

        Property

        Description 

      

      

        Create Oracle Analytics Server Domain

        Select to configure a domain for the Oracle Analytics Server compute instance. Domain creation takes about 30 - 40 minutes to complete after the stack job finishes.

            
    Don't select Create Oracle Analytics Server Domain, if you want to create an additional Oracle Analytics Server

    compute instance to scale out an existing Oracle Analytics Server deployment.
     

      

        Analytics Administrator Username

        Name of the user who will administer Oracle Analytics Server.

            
    Because this is a new user, you can enter any suitable username. For example, myoasadmin.
     

      

      

        Analytics Administrator Password

        Password for the Oracle Analytics Server administrator. Enter any suitable password.  

      
    


        Database Connection String

        Connection string for the database you want to use to store Oracle Analytics Server product schemas. The database must be a pluggable database (PDB) on an Oracle Cloud virtual machine DB system.

    Use the format: hostname_or_IP address:port:PDB_name.DB_domain
     

    For example: 
     oasdb.sub12345678901.oasvcn.oraclevcn.com:1512:OASDB1213_pdb1.sub12345678901.oasvcn.oraclevcn.com

     

      

      

        Database Administrator Username

        Name of an existing user with database administration privileges. For example, myoasdba. 

      
    


        Database Administrator Password

        Password of the user with database administration privileges. Enter any suitable password. 

      

      

        Database Schema Prefix

        Prefix added to the name of each database schema created for Oracle Analytics Server. 

         
    For example, MyOAS.
     

      
    


        Database Schema Password

        Password to access the database schemas used by Oracle Analytics Server. Because this is a new password, you can enter any suitable value. 

     
    


    10. 

  10. Click Next, and review the configuration.
    11. 

  11. Select Run Apply, and click Create.

      
     Monitor progress on the Job Details page. When the stack job finishes, the state changes from In Progress to Succeeded. If you opted to create and configure a domain for Oracle Analytics Server, it takes another 30-40 minutes after the stack job finishes to create the domain and deploy Oracle Analytics Server. 
    

    12. 

  12. To track the deployment process, use SSH to access the compute instance and monitor the deployment logs in the /var/log directory  (oas_cloudinit.log and oas_create_domain.log). When Oracle Analytics Server is ready to use, you see the file /u01/app/oas-scripts/oas_install.finish.
    13. 




Deploy Oracle Analytics Server Using Terraform


Download the Quick Start Terraform scripts from GitHub, modify two configuration files (provider.tf and variable.tf), and then run the terraform init, plan and apply commands to deploy Oracle Analytics Server on Oracle Cloud Infrastructure.


    

  1. Complete all the prerequisites tasks and record the information you need in the checklist provided.
    2. 

  2. Install Terraform version 0.12.x. For example, you can run the following command on Mac with Homebrew:

       
    brew install [email protected]
    

    3. 

  3. Sign into Oracle Cloud Infrastructure Console and collect your user, tenancy, and signing key details. See How to get the config file snippet for an API signing key.
    4. 

  4. Obtain the code from GitHub either by cloning the repository or by performing the following steps:

      

    1. On the Oracle Analytics Server quick-start page, click the Code button, select Download ZIP, and save the ZIP file to your local file system (oci-oracle-analytics-server-master.zip).
      2. 

    2. Extract all the files in oci-oracle-analytics-server-master.zip to a folder on your local file system.
      3. 

    

    5. 

  5. Open the file provider.tf in a text editor and enter the user and tenancy information you gathered from Oracle Cloud Infrastructure Console in this format:

      
    provider "oci" {
    

      
    region = "us-ashburn-1"
    

      
    tenancy_ocid = "ocid1.tenancy.oc1..unique_ID"
    

      
    fingerprint = "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef"
    

      
    user_ocid = "ocid1.user.oc1..unique_ID"
    

      
    private_key_path = "~/.oci/oci_api_key.pem"
    

      
    disable_auto_retries = "true"
    

    }
    

    For private_key_path, provide the location of the PEM file you uploaded to the Oracle Cloud Infrastructure Console for API signing keys. See How to Generate an API Signing Key.
    

    6. 

  6. In the same folder as provider.tf, open the file variable.tf in a text editor. Enter the information required to create the compute instance, and optionally, configure the domain for Oracle Analytics Server.

    Note: Don't edit the following variables.
    

      

    • mp_OAS_listing_id=
      • 

    • mp_OAS_listing_resource_version=
      • 

    • mp_OAS_listing_image_resource_id=
      • 

    

    7. 

  7. The default setting is for the BYOL license. To use the UCM license, copy the content of the following three UCM configuration files (file names ending with .ucm) to the corresponding BYOL configuration files. For example, copy the content of the oci_images.tf.ucm file to the oci_images.tf file.
    


      

        BYOL Configuration Files

        UCM Configuration Files 

      

      

        oci_images.tf

        oci_images.tf.ucm 

      
    


        schema.yaml

        schema.yaml.ucm 

      

      

        terraform.tfvars

        terraform.tfvars.ucm 

        
    


    8. 

  8. After saving both configuration files, run the following commands to deploy Oracle Analytics Server on Oracle Cloud Infrastructure:

     
      

        
    • terraform init
      • 

        
    • terraform plan
      • 

        
    • terraform apply
      • 

       
    

    9. 




Post-Deployment Tasks


Refer to the documentation for a list of post-deployment tasks. See Complete Post Deployment Tasks. 



Using OCI Resource Manager


Oracle Cloud Infrastructure Resource Manager (ORM) allows you to manage your Terraform configurations and state. You might need to update your policies to access the ORM service. 


allow group mygroup_name to read compartments in tenancy


allow group mygroup_name to manage instance-family in compartment mycompartment_name


allow group mygroup_name to use virtual-network-family in compartment mycompartment_name


allow group mygroup_name to manage orm-family in compartment mycompartment_name



License


These Terraform scripts are licensed under the Universal Permissive License 1.0. See LICENSE for more details.


There are two licensing options available:


Universal Credits Model (UCM)


When you deploy Oracle Analytics Server using UCM, the Oracle Analytics Server license is governed by the following Licensing terms: https://cloudmarketplace.oracle.com/marketplace/content?contentId=70514770&render=inline


Bring Your Own License (BYOL)


When you deploy Oracle Analytics Server using BYOL, the Oracle Analytics Server license is governed by the following Licensing terms: https://cloudmarketplace.oracle.com/marketplace/content?contentId=18088784&render=inline


BYOL requires an Oracle Fusion Middleware on-premise license for Oracle Analytics Server, and an active support contract.


Questions


If you have an issue or a question, review our FAQs page.