Merge pull request #24 from AmedeeBulle/ga

GA Updates

Author: AmedeeBulle

README.md

@@ -1,7 +1,7 @@
 # Oracle Internet of Things Platform Samples
 
-This repository provides examples demonstrating how to use the Oracle Internet of Things
-Platform.
+This repository provides examples demonstrating how to use the
+[Oracle Internet of Things Platform](https://docs.oracle.com/en-us/iaas/Content/internet-of-things/).
 
 ## Setup
 
@@ -62,7 +62,7 @@ as well as the messages received.
 ## Documentation
 
 You can find the online documentation for the Oracle Internet of Things Platform at
-[docs.cloud.oracle.com](https://docs.cloud.oracle.com/).
+[docs.cloud.oracle.com](https://docs.oracle.com/en-us/iaas/Content/internet-of-things/).
 
 ## Contributing
 

samples/python/manage-dt/setup.py

@@ -35,7 +35,7 @@
     python_requires=">=3.12",
     install_requires=[
         "click~=8.2.0",
-        "oci~=2.158",
+        "oci~=2.0,>=2.161",
         "PyYAML~=6.0.0",
         "requests~=2.32.0",
         "rich~=13.0.0",

samples/python/query-db/README.md

@@ -3,20 +3,25 @@
 The OCI Internet of Things Platform allows you to connect directly to the
 database storing your Digital Twin definitions and telemetry.
 
-This guide shows how to connect to your IoT database using a Python script.
+The
+[Scenario: Connecting Directly to the IoT Database](https://docs.oracle.com/en-us/iaas/Content/internet-of-things/connect-database.htm)
+section of the documentation shows how to establish a database connection with
+[SQLcl](https://www.oracle.com/database/sqldeveloper/technologies/sqlcl/).
+This guide focuses on how to connect to your IoT database using a Python script.
 
 ## Concepts
 
 Each IoT Domain Group uses an Oracle Autonomous Database, which is shared by
 all IoT Domains in that group.
 
-To access the database, you must ensure that your client IP address is
+To access the database, you must ensure that your client VCN is
 included in the Allow List defined at the IoT Domain Group level –
-[Documentation](.).
+[Documentation](https://docs.oracle.com/en-us/iaas/Content/internet-of-things/connect-database.htm#top__create-vcn).
 
 When connected, to access the database schemas related to a particular IoT
 Domain, the OCI user initiating the connection must be part of one of the
-identity groups listed at the IoT Domain level – [Documentation](.).
+Identity Domain (Dynamic) Groups listed at the IoT Domain level –
+[Documentation](https://docs.oracle.com/en-us/iaas/Content/internet-of-things/connect-database.htm#top__identity-domain).
 
 Database authentication is handled using
 [OCI Identity Database Tokens](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/iam-access-database.html#GUID-CFC74EAF-E887-4B1F-9E9A-C956BCA0BEA9).
@@ -27,10 +32,6 @@ The user account running the script must be properly configured to retrieve
 oci iam db-token get --scope "urn:oracle:db::id::*"
 ```
 
-While the OCI IoT Platform also supports _Instance Principal_ authentication,
-this example uses the default API Key Authentication configured in the
-`~/.oci/config` file.
-
 The `oracledb` Python module handles token retrieval seamlessly when
 specifying `extra_auth_params=token_based_auth` at connection time.
 
@@ -63,7 +64,9 @@ Copy `config.distr.py` to `config.py` and set the following variables:
 - `db_connect_string`: The dbConnectionString property of your IoT Domain Group.
 - `db_token_scope`: The dbTokenScope property of your IoT Domain Group.
 - `iot_domain_short_name`: The hostname part of the deviceHost property of your IoT Domain.
-- `oci_profile`: OCI CLI profile to use for token retrieval.
+- `oci_auth_type`: The OCI Authentication type. Must be either "ConfigFileAuthentication"
+   for API Key authentication or "InstancePrincipal".
+- `oci_profile`: OCI CLI profile to use for token retrieval when using API Key authentication.
 - `row_count`: The number of rows retrieved by the sample queries.
 - `thick_mode`: Set to `True` to use the `oracledb` Thick mode driver.
 

samples/python/query-db/config.distr.py

@@ -16,7 +16,11 @@
 #     jq -r '.'data."device-host"' | split(".")[0]'
 iot_domain_short_name = "<Domain SHort Name>"
 
-# OCI CLI profile to use for token retrieval.
+# OCI Authentication type. Must be either "ConfigFileAuthentication" or "InstancePrincipal"
+# oci_auth_type = "ConfigFileAuthentication"
+oci_auth_type = "InstancePrincipal"
+
+# OCI CLI profile to use for token retrieval when authentication type is "ConfigFileAuthentication"
 oci_profile = os.getenv("OCI_CLI_PROFILE", "DEFAULT")
 
 # Number of rows to retrieve in the sample queries.

samples/python/query-db/query_db.py

@@ -85,10 +85,11 @@ def get_blob(blob: oracledb.LOB) -> Tuple[str, str]:
 
 # Parameters for OCI token-based authentication
 token_based_auth = {
-    "auth_type": "ConfigFileAuthentication",
-    "profile": config.oci_profile,
+    "auth_type": config.oci_auth_type,
     "scope": config.db_token_scope,
 }
+if config.oci_auth_type == "ConfigFileAuthentication":
+    token_based_auth["profile"] = config.oci_profile
 
 extra_connect_params = {}
 if config.thick_mode:

samples/python/query-db/requirements.txt

@@ -1,2 +1,2 @@
-oci
+oci~=2.0,>=2.161
 oracledb>=3.2.0