Tetra Amazon S3 Connector v1 Operational Guide

[Intro. Describe how the Connector works from a high-level.]

For more information, see Tetra Amazon S3 Connector.

Install a Tetra Amazon S3 Connector

To install a Tetra Amazon S3 Connector, do the following.

Prerequisites

  • [TBD]
  • [TBD]
  • [TBD]

[Step 1]

[TBD]

[Step 2]

[TBD]

[Step 3...etc.]

[TBD]

Create a Tetra Amazon S3 Connector

To create a Tetra Amazon S3 Connector, do the following:

  1. Sign in to the TDP. Then, in the left navigation menu, choose Data Sources and select Connectors. The Connectors page appears.
  2. Choose Create Connector. The Create Connector page opens.
  3. For NAME, enter a name for the connector, such as Test S3 Connector. This field is required.
  4. (Optional) For DESCRIPTION, enter a description of the Connector.
  5. For HUB OR CLOUD, select the deployment mode (Hub or Cloud) from the drop-down list.

📘

NOTE

If you select Hub for the deployment mode, an Amazon S3 Connector container is deployed in the selected Tetra Hub v2. If you select Cloud, a standalone instance running the Amazon S3 Connector is deployed.

  1. For CONNECTOR TYPE, select [?TBD?] from the drop-down list.
  2. For CONNECTOR VERSION, select the latest version available.
  3. Choose Create. After a few seconds, the Connector instance is created and appears online.

📘

NOTE

After the Connector is created, the initial MODE status is set to IDLE by default. To activate the Connector, you must configure its settings. For instructions, see the Configure the Connector section.

Configure the Connector

On the Connectors page, select the name of the connector that you created. Then, select the Configuration tab to configure the required settings.

Configuration Parameters

The following table lists the configuration parameters that are required for the Tetra Amazon S3 Connector.

Configuration ParameterDescription
TBD[TBD]
TBD[TBD]
TBD[TBD]
TBD[TBD]
TBD[TBD]
TBD[TBD]
TBD[TBD]

Review and Edit the Connector's Information

The Information tab on the Connector Details page displays information about the Connector, the files pending, successfully uploaded, or failed. It also provides functionality to edit a Connector’s information, metadata, and tags.

To edit the Connector's information, select the Edit button on the Connector Details page's Information tab.

For more information, see Review and Edit a Pluggable Connector's Information.

Metrics

After a Connector instance is created and running, you can monitor the Connector’s health by selecting the Metrics tab on the Connector Details page. The Metrics tab displays the Connector's container metrics as well as aggregated states on total files scanned and uploaded as well as files that returned errors or are pending.

Access Data

[Describe how customers can a integrate/access their data through the integration.]

Limitations

[Describe any known or possible issues or limitations.]