Merge pull request #59 from rrumale/main

AWS QuickSight connector document

aws-quicksight/aws-quicksight-connector-guide.md

@@ -0,0 +1,87 @@
+**Introduction**
+
+Amazon QuickSight is a business intelligence (BI) service. With QuickSight, all users can meet varying analytic needs from the same source of truth through modern interactive dashboards, paginated reports, embedded analytics, and natural language queries.
+
+QuickSight can connect to various databases within the AWS cloud as well as other clouds services and on premise databases.  
+
+AWS QuickSight does not support wallet based connections. Hence to connect to Oracle Autonomous database from QuickSight we need to configure the database for TLS connection and white list the public IP (CIDR bloc) or public endpoint given by AWS.  The list of these public endpoints are different for each AWS region, need to select the one you are using or use one closest to OCI region you are using for Autonomous Database.  The list of CIDR block per-region are listed here [AWS Regions, websites, IP address ranges, and endpoints](https://docs.aws.amazon.com/quicksight/latest/user/regions.html)
+
+You can read further about [AWS QuickSight endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/quicksight.html).
+
+**Important:** In this document we are only referring the basic connection, based on the security policy followed in your organization you can choose to establish a private endpoint for further restrict the access to closed network.
+
+
+### **Prerequisites**
+
+- Required access and credits to provision ADW instance on Oracle Cloud.
+- Should have account with required credits on AWS QuickSight
+- If ADW is already configured you have the ADMIN user password and ADB Wallet is downloaded on app server.
+
+
+## **Configure the Connection**
+
+
+## Step 1:  Obtain the QuickSight IP block and public endpoint  
+
+Check the AWS region where you have QuickSight account and note the CIDR block published by AWS
+e list of CIDR block per-region are listed here [AWS Regions, websites, IP address ranges, and endpoints](https://docs.aws.amazon.com/quicksight/latest/user/regions.html)
+
+![Select the AWS QuickSight public IP range](./images/select-aws-regional-endpoint.jpg)
+
+Note: if you are having a existing QuickSight account, and creating a new ADB instance in OCI,  chose a OCI region close to it. i.e.,  if you have QuickSight account on AWS, Mumbai region create your ADB instance in OCI, Mumbai OR OCI, Hyderabad region.  This just to ensure less network latency and better performance.
+
+
+## Step 2: Configure TLS connection on ADB instance
+
+Follow the instructions in document  [`Connect with one-way TLS without a Wallet`](?lab=no-wallet).  You need to whitelist the region CIDR block to connect.
+
+![Create ACL list on ADB](./images/adding_cidr-block-in-acl-list.jpg)
+
+## Step 3: Get ADW connection details
+
+On the ADW console go to Connections tab, select TLS connection in the drop down menu. This would list the service names for TLS connection, click copy or show to get the details as show in the figure.
+Note the following
+ 1. host name
+ 2. Service name
+ 3. Port number
+
+![Create new dataset from new data source](./images/copy-adw-connection-string-details.jpg)
+
+## Step 4: Create new Dataset using Oracle Connection
+
+  1. Login to AWS QuickSight, go to Datasets and click on new dataset button to create new dataset Connection.
+
+  ![Create new dataset from new data source](./images/create-new-dataset.jpg)
+
+  2. From the list of available databases, select Oracle Database option
+
+  ![Select Oracle Database data source type](./images/select-oracle-database-connection-option.jpg)
+
+  3. In the new data source window fill in the details requested. You can get all the details from the Oracle.
+
+  Use the information noted in step 3
+   1. Database Server name = host name
+   2. Database name = Service name
+   3. Port number = port number
+   4. Username = database username (we used admin to connect)
+   5. Password = password for the db user
+   6. Ensure the SSL connection checkbox is checked
+
+   ![Fill in database connection details](./images/new-datasource-form-fill-connection-details.jpg)
+
+   Click on validate to check the connection.  If connection is successful It shows a green check mark on validate button.
+
+   ![Validate connection](./images/new-datasource-validate-connection.jpg)
+
+   You have successfully connected to ADW instance. Click on  Connect button to connect to ADW.
+
+   4. Click on connect to connect to ADW instance and proceed to use the connect as source or target.
+
+   ![Connect and proceed with connection](./images/connect-to-adw.jpg)
+
+
+
+## **Acknowledgements**
+* **Author(s)** - Rajeev Rumale
+* **Contributor(s)** - Satyabrata Mishra
+* **Last Updated By/Date** - October 2023

aws-quicksight/workshops/freetier/index.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="description" content="Oracle LiveLabs gives you access to Oracle's products to run a wide variety of labs and workshops; allowing you to experience our best technology, live!">
+    <title>Oracle LiveLabs</title>
+
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/jquery-1.11.0.min.js"></script>
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/jquery-ui-1.10.4.custom.js"></script>
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/main.min.js"></script>
+
+    <link rel="stylesheet" href="https://oracle-livelabs.github.io/common/redwood-hol/css/style.min.css" />
+    <link rel="shortcut icon" href="https://oracle-livelabs.github.io/common/redwood-hol/img/favicon.ico" />
+</head>
+
+<body>
+    <header class="hol-Header" role="banner">
+        <div class="hol-Header-wrap">
+            <div class="hol-Header-logo"><span>Oracle LiveLabs</span></div>
+            <a href="https://developer.oracle.com/livelabs" target="_blank" id="livelabs" title="Oracle LiveLabs"></a>
+            <div class="hol-Header-actions">
+                <button id="openNav" class="hol-Header-button hol-Header-button--menu rightNav" aria-label="Open Menu"
+                    title="Open Menu">
+                    <span class="hol-Header-toggleIcon"></span>
+                </button>
+            </div>
+        </div>
+    </header>
+
+    <div id="container">
+        <div id="leftNav">
+            <div id="toc"></div>
+        </div>
+        <div id="contentBox">
+            <main class="hol-Content" id="module-content"></main>
+        </div>
+    </div>
+
+      <footer class="hol-Footer">
+        <a class="hol-Footer-topLink" href="#top">Return to Top</a>
+        <div id="footer-banner"><div class="footer-row">
+          <div class="footer-content"><ul class="footer-links">
+              <li><a href="https://docs.oracle.com/pls/topic/lookup?ctx=en/legal&id=cpyr" target="_blank" aria-label="Open a new window to Oracle legal notices" data-lbl="copyright">© Oracle</a></li>
+              <li><a href="https://www.oracle.com/corporate/index.html" target="_blank" aria-label="Open a new window to learn more about oracle" data-lbl="about-oracle">About Oracle</a></li>
+              <li><a href="https://www.oracle.com/corporate/contact/" target="_blank" aria-label="Open a new window to contact oracle" data-lbl="contact-us">Contact Us</a></li>
+              <li class="footer-links-break"></li>
+              <li><a href="https://docs.oracle.com/en/browseall.html" target="_blank" aria-label="Open a new window to products a-z" data-lbl="products-a-z">Products A-Z</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/" target="_blank" aria-label="Open a new window to read more about Oracle terms of use and privacy" data-lbl="terms-of-use-and-privacy">Terms of Use & Privacy</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/privacy-policy.html#11" target="_blank" aria-label="Open a new window to read more about managing  Oracle cookie preferences" data-lbl="cookie-preferences">Cookie Preferences</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/marketing-cloud-data-cloud-privacy-policy.html#adchoices" target="_blank" aria-label="Open a new window to ad choices" data-lbl="ad-choices">Ad Choices</a></li>
+              <li class="footer-links-break"></li><li class="last"><a href="https://docs.oracle.com/pls/topic/lookup?ctx=en/legal&id=cpyr" target="_blank" aria-label="Open a new window to Oracle legal notices" data-lbl="copyright">© Oracle</a></li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </footer>
+</body>
+
+</html>

aws-quicksight/workshops/freetier/manifest.json

@@ -0,0 +1,26 @@
+{
+  "workshoptitle": "Connecting AWS Quick Sight to Oracle Autonomous Database",
+  "help": "[email protected]",
+  "tutorials": [
+    {
+      "title": "AWS QuickSight Connection Guide",
+      "description": "Connection Guide",
+      "filename": "../../aws-quicksight-connector-guide.md"
+    },
+    {
+      "title": "Connecting with Wallet",
+      "description": "Connecting with Wallet",
+      "filename": "../../../common/wallet/wallet.md"
+    },
+    {
+      "title": "Connecting without Wallet",
+      "description": "Connecting without Wallet",
+      "filename": "../../../common/tls-no-wallet/no-wallet.md"
+    },
+    {
+      "title": "JDBC Configuration",
+      "description": "JDBC Configuration",
+      "filename": "../../../common/jdbc/jdbc-thin-wallet.md"
+    }
+  ]
+}