---
title: "SparkPipe | Deployment"
slug: "sparkpipe-deployment"
description: "SparkPipe is a cloud-native service that utilizes the MQTT Sparkplug specification to securely connect to any MQTT 3.1 compatible broker, capturing all the events published by any Sparkplug-enabled edge node, and routing this data to cloud-based services and applications such as Apache Kafka, etc."
updated: 2025-12-19T15:11:20Z
published: 2025-12-19T15:11:20Z
canonical: "docs.n3uron.com/sparkpipe-deployment"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.n3uron.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deployment

## Step-by-step

This section provides step-by-step instructions for deploying the SparkPipe AMI from the [AWS Marketplace](https://aws.amazon.com/marketplace).

**Step 1:** Log in to your AWS account, then open the SparkPipe product page on the AWS Marketplace by clicking the following link→ [https://aws.amazon.com/marketplace/pp/prodview-xiiaocgyyc3z2](https://aws.amazon.com/marketplace/pp/prodview-xiiaocgyyc3z2)

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(89).png)

**Step 2:** Click **Try for free** to start your 31-day trial.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(90).png)

**Step 3:**After subscribing to the product, click on **Launch your software**.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(91).png)

**Step 4:** Select **Amazon EC2** as the service, then choose the “**One-click launch from AWS Marketplace**” launch method (recommended for simplicity). Next, select your target **Region** and **Instance type**.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(92).png)

**Step 5:**Create or select an existing **VPC, Subnet, Security group** and **Key pair**. Then click **Launch** to deploy your instance.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(93).png)

**Step 6:** After launch is successful**,**Click **View instance on EC2.**

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(94).png)

**Step 7:**Connect to your EC2 instance using either an **SSH client** or the web-based **EC2 Instance Connect** service.

> [!NOTE]
> Note
> 
> When connecting to the EC2 instance, make sure to use **ec2-user** as the username.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(96).png)

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(98).png)

**Step 8:**After successfully connecting to the instance, navigate to the **/etc/sparkpipe** directory to configure the service.

> [!NOTE]
> Note
> 
> The [Configuration](https://docs.n3uron.com/v122/docs/sparkpipe-configuration) section provides detailed instructions on how to configure the **SparkPipe** service and its modules.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/image(99).png)

## AWS CLI

After subscribing to the product in the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-xiiaocgyyc3z2), you can deploy **SparkPipe**by running the following commands using the [AWS CLI](https://aws.amazon.com/cli/):

**Step 1:**Create a new security group and allow inbound SSH access:

```bash
aws ec2 create-security-group \
    --group-name sparkpipe-sg \
    --description "SparkPipe"
```

```bash
aws ec2 authorize-security-group-ingress \
    --group-name sparkpipe-sg \
    --protocol tcp \
    --port 22 \
    --cidr 0.0.0.0/0
```

**Step 2:**Retrieve the latest SparkPipe AMI available in your region:

```bash
aws ec2 describe-images \
    --owners aws-marketplace \
    --filters "Name=product-code,Values=your-product-code" \
              "Name=state,Values=available" \
    --query 'Images | sort_by(@, &CreationDate) | [-1].ImageId' \
    --output text
```

**Step 3:**Launch an instance using the latest SparkPipe AMI:

```bash
aws ec2 run-instances \
    --image-id <AMI_ID> \
    --count 1 \
    --instance-type m6g.medium \
    --key-name my-key-pair \
    --security-groups sparkpipe-sg
```

**Step 4:** SSH into the instance using [EC2 Instance Connect](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-linux-inst-eic.html):

```bash
aws ec2-instance-connect ssh --instance-id <INSTANCE_ID>
```