Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Infowarning
titleUpcoming IoT Bridge for Snowflake v2.0.0 releaseCompatibility
The We are in the process of updating this documentation for the upcoming release of the IoT Bridge for Snowflake v2.0.0 does not support v1.0.0 through v1.0. The AWS Quickstart for 3 schema. If you're currently using the IoT Bridge for Snowflake v1.0.0 through v1.0.3 can be found , you will need to continue to refer to v1 documentation here.


Prerequisites

  • Install IoT Bridge for Snowflake into your AWS account
    • Before being able to access the Virtual Machine you must have completed the installation process here.
  • Install an MQTT Server configured with a real signed TLS certificate

    Tip

    This quickstart guide uses the Chariot MQTT Server can be installed as a free trial from the AWS Marketplace.

    Review the Chariot MQTT Server Configuration for details on how to upload the necessary certificates and keys for enabling SSL/TLS


    Note

    If you choose not to use Chariot MQTT Server, any Sparkplug compliant MQTT Server will work.

    Warning
    AWS IoT Core has a message size limit of 128KB and will disconnect the client if it receives a message that exceeds this limit. If you have a large number of UDT definitions/instances and/or have very large UDTs, you will very likely hit this limit when sending your UDTs to AWS IoT Core. Review this document for ways to reduce the message size.



...

Find the IoT Bridge Setup Assistant Snowflake application in the Snowflake Marketplace and install it. This .

Image Added

Click into the offering and click the Request button to submit a request for the IoT Bridge Setup Assistant application. 

Image Added

Cirrus Link will typically approved the request within 24 hours. Once the request has been fulfilled, the IoT Bridge Setup Assistant application will be visible in Data Products → Apps. Click the 'Get' button download and install the application.

Image Added

After completing this step, the IoT Bridge Setup Assistant is installed as shown below.

Image Added


The IoT Bridge Setup Assistant application will aid in creating and configuring all required Snowflake databases, stored procedures, user defined functions, roles, warehouses, etc.  

<Screenshot Placeholder: IoT Bridge Setup Assistant Snowflake application in the Marketplace>

Once the To run the application, simply click on the installed IoT Bridge Setup Assistant is installed, launch it by navigating to the application under Data Products → Apps.<Screenshot Placeholder: IoT Bridge Setup Assistant Snowflake application running post-install>application and follow the steps shown.

Image Added

Navigate to 'Setup Step 1' to accept default configuration as it defined or customize the configuration as desired. Note the cl_bridge_reader_warehouse must already exist and the cl_bridge_snowflake_user_public_key must contain the public key created following the steps below.

...

Tip

See this document for details on how to generate this unencrypted key pair: https://docs.snowflake.com/en/user-guide/key-pair-auth. The IoT Bridge Setup Assistant will create the required IoT Ingest user and assign the public key provided to this user.

Note: The step "Configuring the Snowflake Client to User Key Pair Authentication" in the linked tutorial can be skipped.

Warning
The generated key MUST NOT be encrypted


<Screenshot Placeholder: IoT Bridge Setup Assistant Snowflake 'Setup Step 1'>Image Added

When 'Setup Step 1' configuration is finalized, click the 'Setup Environment' button and wait for the step to complete. Once complete, navigate to 'Setup Step 2'. This step will output a custom Snowflake SQL script with the configuration provided in Step 1 and this script will create all required Snowflake artifacts when executed. To run this script, follow the instructions in 'Setup Step 2'.<Screenshot Placeholder: IoT Bridge Setup Assistant Snowflake 'Setup Step 2'>.

Image Added


Once Step 2 is complete by running the script generated in this step in a worksheet, the application will display the following message indicating that setup is now complete..

Image Added

Confirm your Snowflake resources (databases, stored procedures, user defined functions, roles, warehouses, etc) have been successfully created by the script execution.

Image Added<Screenshot Placeholder: IoT Bridge Setup Assistant Snowflake 'Setup Complete'>

IoT Bridge Setup

First you will need access to the Snowflake IoT Bridge EC2 instance via SSH. See this document for information on how to do this.

...