Skip to content

scramjetorg/platform-docs

Repository files navigation

Scramjet Transform Hub - Quick Start

GitHub license GitHub stars Donate Slack Discord Slack

⭐ Star us on GitHub β€” it motivates us a lot! πŸš€

Scramjet Transform Hub Logo


Table of Contents

  1. Introduction
  2. Installation
  3. Run your first Sequence
  4. Where to go next
  5. User's dictionary

1. Introduction

1.1 What is Scramjet Transform Hub

Scramjet Transform Hub (STH) can be treated both as data processing engine and execution platform for multiple Sequences running on the same platform and performing various data processing tasks.

STH allows you to deploy and run multiple data processing apps called Sequences.

Sequences

Sequences are specific apps, not just any apps. They specialize in efficient data processing.

We named our apps "Sequences" and that term describes well its nature, as they process data through a Sequence of chained functions. Therefore, usually our Sequences are concise, easy to write and powerful at the same time.


The core part of our STH engine is called the "host".

Host

Host is responsible for maintaining and deploying Sequences, keeping them running and managing its lifecycle.

Host exposes also its own REST API to provide and receive data and manage Sequences and host itself.

What we also do on the host level is that we apply a set of algorithms to optimize and speed up data processing execution in Sequences.

We call our processing optimization algorithms "IFCA" meaning "Intelligent Function Composition Algorithms".

You can interact with host using our dedicated STH CLI that will help you with Sequences deployment, running and monitoring.


Our vanilla STH engine is based on Node.js and thus allows developers to benefit from its rich ecosystem, numerous packages and solutions provided by this vibrant community.

1.2 Solution concept diagram

Solution concept diagram

Glossary:

Inputs
  1. STH can handle any input that can be handled by Node.js application.
  2. You, as a developer, are free to process variety of inputs in your Sequence applications, such as: Text, JSON, XML, SOAP, Audio, Video and more.
  3. Inputs can be either:
    • Provided to STH via its REST API; or
    • Consumed from various local or remote sources by the app; such as: Stream, STDIN, File, API, URL
    • Generated by the app itself
Host

This is a solution for the central processing and management unit with the following major components:

  1. Sequences - these are the actual "STH" apps. It is a package containing at least two files:
    • package.json - JSON manifest file describing the app and its configuration; such as main file to run
    • main file - file such as index.js or index.ts that contains a lightweight application business logic.
  2. Instance - once a Sequence is run, the host will create a separate runtime environment for it and will execute Sequence code inside this runtime entity. This is an Instance.
  3. API & CLI - our Application Programming Interface and CLI connecting to it allows both for Data operations (sending input data and receiving output data) and Management operations (manage host itself and its entities: Sequences or Instances)
Outputs

Our engine outputs can be managed in several ways:

  • File - you can save your output to a local or a remote file
  • STDOUT - output can be directed to system STDOUT (STDERR is supported as well)
  • API - output can be consumed from our STH REST API
  • URL Request - you can write your app in a way to request URL, webhook, etc.
  • Stream - output can be streamed to a particular destination
  • you can mix multiple actions together: you can both send data to remote system/URL and save it locally.

Start your 30 days trial now! πŸ₯³

Register

2. Installation

2.1 Prepare environment

In order to install Scramjet Transform Hub, please follow these 3 steps:

  1. Get Linux machine (local UNIX/Linux OS, cloud VM etc)
  2. Install Docker on this Linux machine (official Docker instructions are here)
  3. Install npm on this machine (official instructions are here). Currently we recommend Node.js version 16.x LTS.

2.2 Install STH

Open one Linux terminal window and issue following commands:

  • Install Scramjet Transform Hub and STH CLI:
npm i -g @scramjet/sth @scramjet/cli
  • Run STH:
scramjet-transform-hub

πŸ’‘ HINT: There is also an alias for running STH:

sth

More detailed installation instructions can be found in our STH GitHub repository.

3. Run your first Sequence

3.1 Review the package

Before running your first Sequence let's have a quick look what's inside the Sequence package.

We have prepared for you a simple JavaScript sample Sequence "hello-snowman". This Sequence is available in the directory javascript/hello-snowman in the Scramjet Cloud Platform Samples repository.

In this directory you will find two files:

  • package.json - manifest file that describes this particular Sequence
  • index.js - file containing main application logic.

This particular application is written in plain JavaScript to simplify this example. However, you can also write your Sequences in TypeScript and build them before packaging and sending Sequence to STH.

In the template's readme you will find a more specific descriptions of the particular file's content.

There is no need to change anything in our hello-snowman Sequence for a first run. Let's move to the next step.

3.2 Run the Sequence

There are 4 steps to follow in order to run the example Sequence:

1. Pack your Sequence into a package

Every "Sequence" app needs to be packaged (compressed) before sending to the Transform Hub. Package is a simple TAR archive and our STH CLI has a special command to pack an app directory into a Sequence tarball.

πŸ’‘ Note: any time, you can display STH CLI help by issuing terminal command si help (for general help) or si <command> help for specific command (ie. si sequence help)

Please open new terminal window (and keep the first one open with STH running). Then issue following commands in the root directory of this repository:

Pack directory hello-snowman into archive hello-sequence.tar.gz:

si pack /javascript/hello-snowman/ -o ./dist/hello-snowman.tar.gz

There is no output shown in the terminal but you can verify with ls that tarball package is created inside dist directory. Please move to the next step.

2. Send the Sequence package

Send hello-snowman.tar.gz to the running host (default localhost API endpoint will be used by the CLI send command) by issuing following command:

si sequence send ./javascript/hello-snowman.tar.gz

πŸ’‘ Note: if you receive reply: Request ok: http://127.0.0.1:8000/api/v1/sequence status: 422 Unprocessable Entity, it means that STH Docker images are not yet pulled from DockerHub. Please wait 2-3 minutes and try to issue si sequence send command again. We are working on fixing this issue in the next STH release. Also, if you keep receiving docker errors you can start STH without docker: scramjet-transform-hub --no-docker

If you encounter any problems or issues while using our platform, please visit our Troubleshooting section, where some of the problems are already known and described. You can also log an issue/bug there.

The output will look similar to this one:

Request ok: http://127.0.0.1:8000/api/v1/sequence status: 202 Accepted
SequenceClient {
  _id: 'cf775cc1-105b-473d-b929-6885a0c2182c',
  host: HostClient {
    apiBase: 'http://127.0.0.1:8000/api/v1',
    client: ClientUtils {
      apiBase: 'http://127.0.0.1:8000/api/v1',
      log: [Object]
    }
  },
  sequenceURL: 'sequence/cf775cc1-105b-473d-b929-6885a0c2182c'
}

Now we have uploaded Sequence to the host and host assigned to it a random ID (GUID), in this case our Sequence ID is:

_id: 'cf775cc1-105b-473d-b929-6885a0c2182c'

Host also exposes REST API endpoint for each Sequence and this is also described in this response.

Exposed Sequence ID allows us to move to the next step where we will start the Sequence.

3. Run the Sequence

We can now use Sequence ID to start uploaded Sequence. The command is si seq start <sequence_id>. To make our users life easier we provided an alias for Sequence ID: si seq start -. This CLI functionality replaces - argument with the last item the user interacted with or selected.

Also, an arbitrary number of parameters can be passed to a Sequence while starting by providing them after <sequence_id> or - alias. In case of our hello-snowman no parameters are used.

Use the following command to start the Sequence:

si sequence start cf775cc1-105b-473d-b929-6885a0c2182c

or

si sequence start -

The output will look similar to this one:

Request ok: http://127.0.0.1:8000/api/v1/sequence/cf775cc1-105b-473d-b929-6885a0c2182c/start status: 200 OK
InstanceClient {
  host: HostClient {
    apiBase: 'http://127.0.0.1:8000/api/v1',
    client: ClientUtils {
      apiBase: 'http://127.0.0.1:8000/api/v1',
      log: [Object]
    }
  },
  _id: 'e70222d1-acfc-4e00-b046-4a3a9481c53b',
  instanceURL: 'instance/e70222d1-acfc-4e00-b046-4a3a9481c53b'
}

Sequence is an app template. Once it is up and running, it will become a new Instance. The Instance also receives its own ID (GUID). In this case the Instance ID is:

_id: 'e70222d1-acfc-4e00-b046-4a3a9481c53b'

Of course, Sequences can be run multiple times. Each run will create a separate Instance with a distinct Instance ID.

4. Send data to the Sequence

We want to make your life easier and for this very example, we have prepared a special Node.js app that will generate a stream of simple messages and send them to our running Instance of hello-snowman.

For fun, our stream generator will send simple text messages containing temperature readings from artificial weather station. Temperature value will be generated randomly in range of <-50,50> degrees Celsius. Our hello-snowman app will read and interpret these messages and will inform us about state of our Snowman:

  • if temperature will be 0 or below, Sequence will return message: Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
  • in the other case (temperature above 0 degrees), Sequence will return message: Snowman β›„ is melting! πŸ₯΅

To run this app, please execute the following command from the root of our directory node ./tools/stream-gen-tool/stream-gen.js <instance_id>. In our case this would look like this:

node ./tools/stream-gen-tool/stream-gen.js e70222d1-acfc-4e00-b046-4a3a9481c53b

The output will look similar to this one:

----------------------------------------
Message# 1 | Temperature measure
INPUT | -16
OUTPUT| Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️

----------------------------------------
Message# 2 | Temperature measure
INPUT | 49
OUTPUT| Snowman β›„ is melting! πŸ₯΅

----------------------------------------
Message# 3 | Temperature measure
INPUT | 16
OUTPUT| Snowman β›„ is melting! πŸ₯΅

----------------------------------------
Message# 4 | Temperature measure
INPUT | -46
OUTPUT| Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️

----------------------------------------

Our Sequence generator app does two things here:

  • Sends stream of messages; each one containing number with temperature value
  • Reads output from Host API that is generated by our hello-snowman Sequence

Separately, you can also open a new terminal window and see log of this particular Instance with command si instance log <instance_id> or by using alias si instance log -. In our case this would be:

si instance log e70222d1-acfc-4e00-b046-4a3a9481c53b

The sample output will be similar to this one:

Request ok: http://127.0.0.1:8000/api/v1/instance/e70222d1-acfc-4e00-b046-4a3a9481c53b/log status: 200 OK
{"level":"DEBUG","msg":"Streams initialized","ts":1647447631103,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
{"level":"TRACE","msg":"Handshake sent","ts":1647447631103,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
{"level":"DEBUG","msg":"Control message received","ts":1647447631113,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[4000,{"appConfig":{},"args":[]}]}
{"level":"DEBUG","msg":"Handshake received","ts":1647447631113,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
{"level":"DEBUG","msg":"Sequence","ts":1647447631115,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[[null]]}
{"level":"INFO","msg":"Sequence loaded, functions count","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[1]}
{"level":"DEBUG","msg":"Processing function on index","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[0]}
{"level":"DEBUG","msg":"Function called","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[0]}
{"level":"INFO","msg":"All sequences processed.","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
{"level":"DEBUG","msg":"Stream type is","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["object"]}
{"level":"TRACE","msg":"Piping sequence output","ts":1647447631117,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["object"]}
{"level":"DEBUG","msg":"Content-Type","ts":1647447645282,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["application/octet-stream"]}
...
5. Get the Instance output

Once hello-snowman Sequence is up and running, we have also sent some input data to the Instance to consume. To see what the program does to this data use the command below, it will show you the Instance output after data transformation. Open one more terminal and paste:

si inst output e70222d1-acfc-4e00-b046-4a3a9481c53b

or by using alias

si inst output -

This is an example output that you should get:

Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
Snowman β›„ is melting! πŸ₯΅
Snowman β›„ is freezing πŸ₯Ά Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️

πŸŽ‰ Congratulations! πŸ₯³ You have run your first Scramjet Transform Hub Sequence!

To see more Sequence or Instance CLI commands use si help accordingly:

  • si seq help

  • si inst help

4. Where to go next

Here you can find more resources related to Scramjet Transform Hub:

  • πŸ“š Check out more sequence samples - we have prepared some ready-to-use apps, which you can either use as a starting point for creating your own Sequences or simply run them just to see what they do, and how the STH works with them.
  • πŸ“‚ Start from our app templates - almost a blank file structure (package) and usage instructions, ready to be used as a starting point for building your own Sequences. This is the simplest base we can provide for you to start with.
  • πŸ§‘β€πŸ’» Contribute to STH development - please feel free to contribute to STH development by submitting pull requests or creating issues.
  • 🌐 Visit our Scramjet.org page - check out our website for more information about our Scramjet team, history and products.

5. User's dictionary

There is a lot of terminology that we use in our project that may already be known to you. We have prepared a dictionary of terms that you may find useful and which you will learn as you learn about Scramjet Platform. We try to keep the definitions short and simple.



Thank you for reading, we hope you enjoyed it. If not, here is a random cheer up joke, that may make you smile 😁


Jokes Card

About

Scramjet Transform Hub usage documentation and code samples

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published